Farm.js Docs

dev.farmjsPublished by farmjs.devOfficial publisherv0.1.28Updated Oct 26, 2026

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

VerifiedStreamable HTTPWeb executableKnowledge & MemoryDeveloper Tools

Overview

AI-generated overview

Remote MCP endpoint for the official Farm.js documentation, letting an assistant search, browse and read pages, sections, code examples and config options.

What you can do
  • Search the docs by keyword with framework, version, package and tag filters, and list valid facets first
  • List documentation pages and sections, or the navigation tree, without fetching page bodies
  • Read one page, a single heading, or up to 20 pages in one call under a token budget
  • Pull fenced code examples and structured docs.config.ts option metadata
  • Build section-level context for a query with source URLs and accounting metadata
  • Track documentation changes by polling metadata, then hydrate added or changed sections
When to use it
Useful when an assistant needs accurate, current Farm.js documentation while writing or debugging Farm.js code, or when it should stay in sync with documentation changes and follow page-level agent task contracts.
Requirements
A remote streamable HTTP endpoint at mcp.farmjs.dev; no packages, environment variables, headers or authentication are declared. Network access to the endpoint is required.
Before you install
The feedback tool sends a machine-readable payload to the documentation site, validated against its configured schema; avoid including secrets or private details in feedback. Other tools are read-only.

Installation

In SourceWeft

  1. Open Farm.js Docs in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Web executable via Streamable HTTP. Remote servers run from the web runtime once configured in a workspace.

Use with an agent

Paste this prompt into Claude Code, Codex, Cursor or another agent — or into SourceWeft chat. The agent reads this server's install guide, shows you its publisher, endpoint and sign-in, and adds it to your client once you agree. Keys never go into a command.

Read https://sourceweft.com/mcp/dev.farmjs%2Fdocs/install.md and connect the MCP server it describes to my client. Before changing any config, show me its publisher, endpoint and sign-in method and wait for my OK. Never put an API key in a command or in a file I would commit; ask me where it should come from.

Read the install guide the agent follows

Other MCP clients

Add this to your client's mcpServers config.

{
  "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

Source: docs/README.md at commit be34e74

Tools

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.

ParameterspathlimitquerylocalelanguagerunnableframeworkpackageManager

get_config_schema

Get docs config schema

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

Parametersqueryoption

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.

ParameterstagsqueryrequiredlocalepackageversionframeworktokenBudget

get_navigation

Get docs navigation

Return the documentation navigation tree for the current docs site.

Parameterslocale

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.

ParameterssincerequiredcursorlocaletokenBudget

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.

Parameterssincelocale

list_docs

List docs by section

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

Parameterscursorlocalesection

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.

ParameterspathrequiredcursorlocalebyteBudgettokenBudget

list_pages

List docs pages

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

Parameterscursorlocale

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.

Parameterstagsfacetlimitcursorlocalepackageversionaudienceframework

list_tasks

List documented tasks

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

Parametersquerycursorlocalepackageversionframework

read_page

Read a docs page

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

ParameterspathrequiredlocalesectionmaxChars

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.

ParameterspathsrequiredlocaletokenBudgetmaxCharsPerPage

read_task

Read a documented task

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

ParameterspathrequiredlocalesectionmaxChars

search_docs

Search documentation

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

Parameterstagslimitqueryrequiredcursorlocaleexplainpackageversionaudienceframework

submit_feedback

Submit documentation feedback

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

Parameterscontextpayloadrequired

Version history

1
  1. v0.1.28LatestOct 20, 2026

Score

100% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 daysRequired25 pts
  • Auth declaredRequired10 pts
  • Tools listedRequired15 pts
  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts