Skip to main content
Glama
muthanii

Frappe Docs MCP Server

Frappe Docs MCP Server

CI frappe_docs_mcp MCP server

A Model Context Protocol server that gives an MCP client read access to the Frappe framework documentation.

It speaks MCP over stdio using the official @modelcontextprotocol/sdk, so any stdio-capable client (VS Code, Claude Desktop, Claude Code) can run it.

Tools

search_frappe_docs

Finds documentation pages by keyword. Start here when you do not already know a page's exact path.

Parameter

Type

Description

query

string

Keywords, e.g. create doctype

limit

number

Optional, 1-50, default 10

Every docs page embeds the full navigation tree, so one fetch yields a catalogue of all ~215 pages. Every query token must match somewhere in a result's title or path, so adding a word narrows the results rather than widening them.

1 page matched "create doctype":

- **Create a DocType** — `en/tutorial/create-a-doctype`

get_frappe_doc

Fetches a documentation page and returns its readable content as markdown.

Parameter

Type

Description

path

string

Path relative to the docs root, e.g. en/tutorial

Paths always resolve under https://docs.frappe.io/framework/user. A leading framework/user is stripped if you include it, .. segments are rejected rather than resolved, and each segment is percent-encoded, so a path cannot escape that prefix or smuggle in a query string.

A raw docs page is roughly 960 KB of HTML, most of it navigation. Only the article body is kept and converted to markdown, which brings a typical page down to a few KB.

Related MCP server: CHECK-MODULE MCP Server

Configuration

Both settings are optional. A malformed value is reported on stderr and the default is used, so a typo degrades rather than killing the server.

Variable

Default

Meaning

FRAPPE_DOCS_MAX_BYTES

100000

Ceiling on one response, in UTF-8 bytes. 0 disables truncation.

FRAPPE_DOCS_CACHE_TTL_MS

900000

How long fetched pages and the catalogue stay fresh (15 minutes).

Pages and the catalogue are cached in memory, so repeated lookups within a session do not re-fetch. Concurrent requests for the same page share a single fetch.

Requirements

Node.js 20 or newer. There is no node-fetch dependency; the server uses the global fetch built into Node 20.

Quick start

git clone https://github.com/muthanii/frappe_docs_mcp.git
cd frappe_docs_mcp
npm install
npm run build
npm test

Wiring it into a client

The server reads JSON-RPC from stdin and writes it to stdout, so it must be launched directly rather than through npm run start (npm prints its own banner to stdout, which corrupts the protocol stream).

VS Code — .vscode/mcp.json is already set up:

{
  "servers": {
    "frappe-docs-mcp": {
      "type": "stdio",
      "command": "node",
      "args": ["${workspaceFolder}/dist/server.js"]
    }
  }
}

Claude Desktop / Claude Code — point at the built entry point:

{
  "mcpServers": {
    "frappe-docs-mcp": {
      "command": "node",
      "args": ["/absolute/path/to/frappe_docs_mcp/dist/server.js"]
    }
  }
}

Run npm run build after any source change so dist/ stays current.

Docker

docker compose run --rm -T frappe-docs-mcp

The image publishes no port. This is a stdio server, not an HTTP service, so it must be run attached with a client owning stdin and stdout.

Development

File

Role

src/docs-url.ts

URL construction and path sanitising

src/catalog.ts

Navigation-tree parsing and keyword search

src/extract.ts

Article extraction, markdown conversion, truncation

src/cache.ts

TTL cache with request coalescing

src/server.ts

Tool registration and the stdio transport

src/*.test.ts

node:test suites (84 tests)

Logic is kept out of server.ts so it can be tested without spawning a process.

npm run build uses tsconfig.build.json, which excludes *.test.ts so tests do not ship in the image. npm test compiles everything, including the tests. package-lock.json is committed and the Docker build uses npm ci, so image builds are reproducible.

Diagnostics must go to stderr. Anything written to stdout is interpreted as a protocol frame; CI asserts that the server writes nothing to stdout before a client speaks.

frappe_docs_mcp MCP server

License

MIT

Available Tools

2 tools
get_frappe_docGet Frappe documentation pageA

Fetch a page from the Frappe framework user documentation at https://docs.frappe.io/framework/user and return its readable content as markdown. Paths are relative to that prefix and start with a language segment, e.g. "en/tutorial" or "en/basics/doctypes". Use search_frappe_docs to discover paths.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesDocumentation path relative to the docs root, e.g. "en/tutorial"

TDQS

A4.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden. It discloses that the tool fetches a page, returns readable content as markdown, and explains the URL structure. It does not specify error handling or side effects, but for a simple retrieval tool the key behavioral expectations are covered.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences with no wasted words. It front-loads the main purpose and output format, then gives essential path details and a pointer to the sibling tool. Every sentence adds value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter tool with no output schema, the description is complete: it states the return format (markdown), defines the path structure, provides examples, and names the sibling tool for discovery. No critical information is missing for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema already documents the single parameter well (100% coverage). The description adds meaningful context beyond the schema by explaining the URL prefix, language segment requirement, and giving examples, which helps the agent construct valid paths.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb 'Fetch' and clearly identifies the resource: pages from the Frappe framework user documentation at a defined URL prefix. It differentiates from the sibling search_frappe_docs by stating that this tool fetches a direct page rather than discovering paths.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly instructs to use search_frappe_docs for discovering paths, establishing a clear when-to-use vs alternative scenario. It also clarifies that paths must be relative to the prefix and start with a language segment, providing concrete usage guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

search_frappe_docsSearch Frappe documentationA

Find Frappe framework documentation pages by keyword. Returns page titles with the paths to pass to get_frappe_doc. Use this first when you do not already know the exact path of the page you want.

ParametersJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum results to return (default 10)
queryYesKeywords to search for, e.g. "create doctype"

TDQS

A4.2/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the transparency burden. It adds useful behavioral context by explaining the return shape (page titles and paths) and the integration with get_frappe_doc. However, it doesn't explicitly state read-only behavior, describe failure modes, or address edge cases like empty results, so it's adequately but not richly transparent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences, each serving a purpose: first states the core action, second explains the output and usage priority. No redundant content, perfectly front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple two-parameter search tool with sibling tool and no output schema, the description covers the essential context: what it does, what it returns, and how it fits into the workflow. It lacks only minor details like explicit read-only confirmation or error handling, which are arguably not necessary for a well-scoped search tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% (both `query` and `limit` are well-described), so the baseline is 3. The description adds no additional parameter-level semantics beyond the schema, but it does contextually relate the output to the `query` parameter. That doesn't push it above baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it 'Find Frappe framework documentation pages by keyword', specifying the verb and resource. It also differentiates itself from the sibling get_frappe_doc by noting it returns paths to pass to that tool, establishing its role as the search entry point.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly instructs 'Use this first when you do not already know the exact path of the page you want,' giving a clear when-to-use directive and implying the alternative (get_frappe_doc) when the path is known.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. 2 tool updatesv0.2.0
    • First observedget_frappe_doc
    • First observedsearch_frappe_docs

TDQS

A4.5/5.0
Disambiguation5/5

The two tools have clearly distinct purposes: one discovers documentation paths via keyword search, the other retrieves content by path. There is no overlap or ambiguity between them.

Naming Consistency5/5

Both tool names follow a consistent verb_noun pattern: search_frappe_docs and get_frappe_doc. The naming is predictable and matches the actions they perform.

Tool Count4/5

With only two tools, the set feels slightly thin but is appropriate for a documentation-focused server. The search-then-fetch workflow is minimal yet coherent, and adding more tools might be unnecessary.

Completeness5/5

For the stated purpose of accessing Frappe documentation, the pair covers the full lifecycle: discovery (search) and retrieval (get). No write operations are relevant, and there are no obvious gaps in the read-only documentation use case.

Maintenance

ActivityMaintained
ResponsivenessSyncing

Related MCP Connectors

Related MCP Servers

  • A
    license
    A
    quality
    D
    maintenance
    Provides tools for AI agents to search, browse, and retrieve the full documentation for the mcp-framework. It enables agents to access documentation sections and page content directly within MCP-compatible environments like Claude Code and Cursor.
    3
    19
    MIT
  • A
    license
    Not graded
    quality
    A
    maintenance
    MCP server that enables LLMs to interact with ERPNext/Frappe sites for document CRUD, search, reports, workflows, and analytics, respecting user permissions and logging all actions.
    295
    AGPL 3.0
  • A
    license
    Not graded
    quality
    D
    maintenance
    Provides RAG (Retrieval Augmented Generation) access to technical documentation through MCP, enabling LLMs to search and retrieve relevant documentation on-demand.
    4
    MIT

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/muthanii/frappe_docs_mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server