Lets an AI client search and read Farm.js documentation, including pages, sections, code examples and configuration options.
Also known as farming-labs/farm.js, docs
- Stars
- 660
- Tools
- —
- Downloads, 30 days
- —
- Latest version
- 0.1.28
- Last commit
- Nov 15, 2026
- License
- MIT
What is Farm.js Docs MCP?
Farm.js Docs lets an AI client search and read Farm.js documentation, including pages, sections, code examples and configuration options.
Summary generated from the project's README
About Farm.js Docs MCP server
Accessing Farm.js documentation directly through an AI client allows developers to retrieve technical details without leaving their development environment. This server provides a way to search and read through specific pages, sections, code examples, and configuration options related to the Farm.js framework. It is designed for users who need immediate access to technical specifications while coding.
Setting up the server involves running commands like pnpm install and pnpm dev from the repository root to host the documentation locally. The system supports various documentation routes including Getting Started, Routing, and Layouts. Developers can interact with the documentation content to understand file-based routing or how to implement root and nested layouts. Because the documentation site is built with Farm.js itself, it serves as a live reference for the framework's capabilities.
Written from the project's README. Every use case is checked against a quote from it.
How to install Farm.js Docs MCP
Formats verified 10 Nov 2026Add to CursorAdd to GooseInstall Farm.js Docs MCP in Claude Code
$ claude mcp add --transport http docs https://mcp.farmjs.dev/mcpInstall Farm.js Docs MCP in Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"docs": {
"url": "https://mcp.farmjs.dev/mcp"
}
}
}Install Farm.js Docs MCP in VS Code
.vscode/mcp.json
{
"servers": {
"docs": {
"type": "http",
"url": "https://mcp.farmjs.dev/mcp"
}
}
}Install Farm.js Docs MCP in VS Code CLI
$ code --add-mcp '{"name":"docs","type":"http","url":"https://mcp.farmjs.dev/mcp"}'Install Farm.js Docs MCP in Codex
$ codex mcp add docs --url https://mcp.farmjs.dev/mcpInstall Farm.js Docs MCP in Codex config.toml
~/.codex/config.toml
[mcp_servers.docs] url = "https://mcp.farmjs.dev/mcp"
Install Farm.js Docs MCP in Gemini CLI
$ gemini mcp add -s user --transport http docs https://mcp.farmjs.dev/mcpInstall Farm.js Docs MCP in Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"docs": {
"url": "https://mcp.farmjs.dev/mcp",
"type": "http"
}
}
}Automated checks
Ran Nov 12, 2026Full report →Passed our automated checks. That is not a security audit: read the code and give the server the narrowest access it needs. How checks work
- Source repository linked and reachablePass
- Open source license (OSI)Pass
- Commit or release in the last yearPass
- Package name not close to a popular packageNot checked
- Remote endpoint uses HTTPSPass
- Destructive tools are labelledNot checked
- No hidden instructions to the modelPass
- No critical advisory in the package or its dependenciesNot checked
README
View on GitHubFarm.js Docs (farmjs-docs)
Official documentation site for Farm.js, built with Farm.js.
Run locally
From the repo root:
pnpm install
pnpm run --filter farmjs-docs dev
Or from this directory (after pnpm install from root):
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:
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:
node --env-file=docs/.env.local docs/.farm/.output/server/index.mjs
Build
From the repo root:
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:
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:
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
Farm.js Docs MCP questions
How do I add Farm.js Docs MCP to Claude Code?
Run claude mcp add --transport http docs https://mcp.farmjs.dev/mcp in your terminal. Add --scope user to make it available in every project.
How do I add Farm.js Docs MCP to Cursor?
Open ~/.cursor/mcp.json and add the server under mcpServers, using the Cursor config shown in the install section above.
How do I run the Farm.js docs site locally?
Run pnpm install from the repo root, then start the dev server with pnpm dev from the docs directory and open localhost:3000.
What documentation sections are available?
The site includes landing, docs index, getting started, routing and layouts sections.
Does the docs site have its own database configuration?
Yes, the agent waitlist form stores entries in Postgres using a server-only WAITLIST_DATABASE_URL variable.
How is the production docs build output generated?
Building the farmjs-docs package writes the production Vercel artifact to .vercel/output.