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
dev.farmjs由 farmjs.dev 发布官方发布者v0.1.28更新于 Oct 26, 2026
Search and read the Farm.js docs: pages, sections, code examples and config options.
Farm.js 官方文档的远程 MCP 端点,让助手搜索、浏览并阅读文档页面、章节、代码示例和配置选项。
Web executable,通过 Streamable HTTP。 远程服务在工作区中配置后即可从网页运行时运行。
把这段提示词粘贴到 Claude Code、Codex、Cursor 等智能体,或 SourceWeft 对话中。智能体会读取该服务器的安装指南,先向你展示发布者、端点和登录方式,经你同意后再把它添加到你的客户端。密钥不会写进任何命令。
阅读 https://sourceweft.com/mcp/dev.farmjs%2Fdocs/install.md,并按其中说明把这个 MCP 服务器接入我的客户端。修改任何配置之前,先告诉我它的发布者、端点和登录方式,等我确认。不要把 API 密钥写进命令或我会提交的文件;问我密钥应从哪里获取。把它添加到你客户端的 mcpServers 配置中。
{
"mcpServers": {
"farm-js-docs": {
"type": "http",
"url": "https://mcp.farmjs.dev/mcp"
}
}
}Official documentation site for Farm.js, built with Farm.js.
From the repo root:
Or from this directory (after pnpm install from root):
Open http://localhost:3000.
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:
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:
From the repo root:
The production Vercel artifact is written to .vercel/output.
The documentation-site build opts into @farm.js/core's runtime-only package build:
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:
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.
/) – Hero, features, and CTAs/docs) – Documentation index/docs/getting-started) – Installation and first steps/docs/routing) – File-based routing/docs/layouts) – Root and nested layouts来源:docs/README.md,提交 be34e74
Get docs code examples
Return fenced code examples from the docs with parsed metadata such as title, framework, packageManager, and runnable.
pathlimitquerylocalelanguagerunnableframeworkpackageManagerGet docs config schema
Return structured docs.config.ts option metadata, optionally filtered by option path or query.
queryoptionGet 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必填localepackageversionframeworktokenBudgetGet docs navigation
Return the documentation navigation tree for the current docs site.
localeHydrate 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必填cursorlocaletokenBudgetList 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.
sincelocaleList docs by section
List documentation pages grouped by section, optionally narrowed to one section.
cursorlocalesectionList 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必填cursorlocalebyteBudgettokenBudgetList docs pages
List the known documentation pages with titles, slugs, and URLs.
cursorlocaleList 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.
tagsfacetlimitcursorlocalepackageversionaudienceframeworkList documented tasks
List pages with actionable agent contracts, optionally filtered by text or applicability.
querycursorlocalepackageversionframeworkRead a docs page
Read a documentation page by slug or URL path, optionally selecting one heading and limiting returned characters.
path必填localesectionmaxCharsRead 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必填localetokenBudgetmaxCharsPerPageRead a documented task
Read the full structured agent contract for a page by slug or URL path.
path必填localesectionmaxCharsSearch documentation
Search the docs by keyword with optional framework, version, package, and tag filters. Returns structured ambiguity and metadata warnings.
tagslimitquery必填cursorlocaleexplainpackageversionaudienceframeworkSubmit documentation feedback
Submit machine-readable documentation feedback. The payload is validated against the site's configured agent feedback schema before delivery.
contextpayload必填已满足适用检查项的 100%
该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。
pnpm installpnpm run --filter farmjs-docs devpnpm devpnpm db:waitlistnode --env-file=docs/.env.local docs/.farm/.output/server/index.mjspnpm run --filter farmjs-docs buildpnpm --filter @farm.js/core build:runtimepnpm --filter @farm.js/core build