Farm.js Docs

dev.farmjs由 farmjs.dev 發布官方發布者v0.1.28更新於 Oct 26, 2026

Search and read the Farm.js docs: pages, sections, code examples and config options.

已驗證Streamable HTTP可網頁執行知識與記憶開發者工具

概覽

AI 產生的概覽

Farm.js 官方文件的遠端 MCP 端點,讓助理搜尋、瀏覽並閱讀文件頁面、章節、程式碼範例與設定選項。

可以做什麼
  • 依關鍵字搜尋文件,可依框架、版本、套件與標籤篩選,並可先列出可用篩選面
  • 列出文件頁面與章節,或取得導覽樹,無須抓取頁面本文
  • 讀取單一頁面、指定標題,或一次讀取最多 20 個頁面並受 token 預算限制
  • 取得圍欄程式碼範例與結構化的 docs.config.ts 選項中繼資料
  • 為查詢建立章節層級脈絡,附上來源網址與統計中繼資料
  • 透過輪詢中繼資料追蹤文件變更,再補取新增或修改的章節
適用情境
適合在撰寫或除錯 Farm.js 程式碼時,讓助理取得正確且最新的 Farm.js 文件,或需要跟上文件變更並遵循頁面層級代理任務契約的情境。
執行需求
需要連線到 mcp.farmjs.dev 的遠端 streamable HTTP 端點;未宣告任何套件、環境變數、標頭或身分驗證。需要能連上該端點的網路。
安裝前請注意
回饋工具會把機器可讀的內容送到文件網站,並依網站設定的結構描述驗證;請勿在回饋中放入密鑰或私密資訊。其餘工具皆為唯讀。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Farm.js Docs,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Web executable,透過 Streamable HTTP。 遠端服務在工作區中設定後即可從網頁執行環境執行。

交給代理程式安裝

把這段提示詞貼上到 Claude Code、Codex、Cursor 等代理程式,或 SourceWeft 對話中。代理程式會讀取該伺服器的安裝指南,先向你展示發布者、端點和登入方式,經你同意後再把它新增到你的客戶端。金鑰不會寫進任何命令。

閱讀 https://sourceweft.com/mcp/dev.farmjs%2Fdocs/install.md,並按其中說明把這個 MCP 伺服器接入我的客戶端。修改任何設定之前,先告訴我它的發布者、端點和登入方式,等我確認。不要把 API 金鑰寫進命令或我會提交的檔案;問我金鑰應從哪裡取得。

檢視代理程式所依據的安裝指南

其他 MCP 客戶端

把它新增到你客戶端的 mcpServers 設定中。

{
  "mcpServers": {
    "farm-js-docs": {
      "type": "http",
      "url": "https://mcp.farmjs.dev/mcp"
    }
  }
}

README

Farm.js Docs (farmjs-docs)

Official documentation site for Farm.js, built with Farm.js.

Run locally

From the repo root:

bash
pnpm installpnpm run --filter farmjs-docs dev

Or from this directory (after pnpm install from root):

bash
pnpm dev

Open http://localhost:3000.

Agent waitlist database

The /agents form posts to /api/waitlist. WaitlistEntry in prisma/schema.prisma stores the normalized email (unique), signup description, and creation/update timestamps. Repeat submissions update that record instead of creating duplicates.

Set a server-only WAITLIST_DATABASE_URL in docs/.env.local for a dedicated Postgres database. Never prefix it with VITE_ or commit the credential. When omitted, the route continues to use DATABASE_URL; telemetry always keeps using DATABASE_URL.

From docs, prepare a new dedicated database once:

bash
pnpm db:waitlist

This requires WAITLIST_DATABASE_URL explicitly and only creates the WaitlistEntry table when it is absent. It never resets a database or modifies telemetry tables. Keep prisma/waitlist.sql aligned with the Prisma model for future schema changes; the bootstrap does not upgrade an existing table.

For production, set WAITLIST_DATABASE_URL on the Vercel project serving farmjs.dev, scoped to Production, then deploy the updated app. Do not replace the existing telemetry DATABASE_URL or give PR previews access to the production waitlist. Apply the bootstrap against that same database before the deployment accepts signups; schema changes are not run automatically during builds.

Farm development loads .env.local. To run a locally built Node output from the repo root:

bash
node --env-file=docs/.env.local docs/.farm/.output/server/index.mjs

Build

From the repo root:

bash
pnpm run --filter farmjs-docs build

The production Vercel artifact is written to .vercel/output.

Runtime-only core build

The documentation-site build opts into @farm.js/core's runtime-only package build:

bash
pnpm --filter @farm.js/core build:runtime

This builds the same ESM, CJS, and source-map artifacts as the default core build, but skips TypeScript declaration generation because the deployed website does not consume .d.ts files. The optimization applies to the complete farmjs.dev application, including the landing page and documentation routes.

The regular package and release build remains the default and continues to generate declarations:

bash
pnpm --filter @farm.js/core build

Use build:runtime only for application deployments that need executable runtime artifacts. Do not use it for package publishing, release validation, or any workflow that consumes generated types.

Structure

  • Landing (/) – Hero, features, and CTAs
  • Docs (/docs) – Documentation index
  • Getting Started (/docs/getting-started) – Installation and first steps
  • Routing (/docs/routing) – File-based routing
  • Layouts (/docs/layouts) – Root and nested layouts

來源:docs/README.md,提交 be34e74

工具

16

get_code_examples

Get docs code examples

Return fenced code examples from the docs with parsed metadata such as title, framework, packageManager, and runnable.

輸入參數pathlimitquerylocalelanguagerunnableframeworkpackageManager

get_config_schema

Get docs config schema

Return structured docs.config.ts option metadata, optionally filtered by option path or query.

輸入參數queryoption

get_context

Get budgeted docs context

Build deterministic, section-level documentation context for a query within a conservative UTF-8 byte ceiling derived from the requested token budget, with source URLs and accounting metadata.

輸入參數tagsquery必填localepackageversionframeworktokenBudget

get_navigation

Get docs navigation

Return the documentation navigation tree for the current docs site.

輸入參數locale

hydrate_content_changes

Hydrate docs content changes

Fetch only added and changed agent-facing sections after list_content_changes. Returns deletion tombstones and digest-bound continuation cursors under a conservative token budget.

輸入參數since必填cursorlocaletokenBudget

list_content_changes

List docs content changes

Synchronize body-free document metadata. Save indexGeneration and pass it as since on the next poll. A reset response means the named snapshot is no longer available.

輸入參數sincelocale

list_docs

List docs by section

List documentation pages grouped by section, optionally narrowed to one section.

輸入參數cursorlocalesection

list_page_sections

List sections in a docs page

Discover a page's canonical headings, anchors, hierarchy, line ranges, size estimates, and budget-aware fetch URLs without returning the page body.

輸入參數path必填cursorlocalebyteBudgettokenBudget

list_pages

List docs pages

List the known documentation pages with titles, slugs, and URLs.

輸入參數cursorlocale

list_search_facets

List documentation search facets

List valid framework, version, package, and tag filters with matching page counts before calling search_docs. Use facet, limit, and cursor to continue a large facet without document bodies.

輸入參數tagsfacetlimitcursorlocalepackageversionaudienceframework

list_tasks

List documented tasks

List pages with actionable agent contracts, optionally filtered by text or applicability.

輸入參數querycursorlocalepackageversionframework

read_page

Read a docs page

Read a documentation page by slug or URL path, optionally selecting one heading and limiting returned characters.

輸入參數path必填localesectionmaxChars

read_pages

Read several docs pages

Read up to 20 documentation pages in one round trip. Results preserve request order and share a conservative UTF-8 token budget.

輸入參數paths必填localetokenBudgetmaxCharsPerPage

read_task

Read a documented task

Read the full structured agent contract for a page by slug or URL path.

輸入參數path必填localesectionmaxChars

search_docs

Search documentation

Search the docs by keyword with optional framework, version, package, and tag filters. Returns structured ambiguity and metadata warnings.

輸入參數tagslimitquery必填cursorlocaleexplainpackageversionaudienceframework

submit_feedback

Submit documentation feedback

Submit machine-readable documentation feedback. The payload is validated against the site's configured agent feedback schema before delivery.

輸入參數contextpayload必填

版本歷史

1
  1. v0.1.28最新Oct 20, 2026

評分

已滿足適用檢查項的 100%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通必需25 分
  • 已宣告認證方式必需10 分
  • 已列出工具必需15 分
  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分