Frappe MCP Server

Enhanced Model Context Protocol server for Frappe Framework with comprehensive API instructions and helper tools

Local serverstdioGo

What is the Frappe MCP server?

Connect Frappe to Claude, Cursor or any other MCP client and it stops being a tab you switch to. Enhanced Model Context Protocol server for Frappe Framework with comprehensive API instructions and helper tools. The frappe mcp server is what makes that connection.

What the server does

A Model Context Protocol (MCP) server for Frappe Framework that exposes Frappe's functionality to AI assistants through the official REST API, with a focus on document CRUD operations, schema handling, and detailed API instructions.

This MCP server allows AI assistants to interact with Frappe applications through a standardized interface using the official Frappe REST API. It provides tools for:

Installation

frappe-mcp-server on npm is all you need. Most clients run it directly, so configuration is a few lines and a restart.

Available tools

The toolset is worth reading before you wire it up, because it tells you what the integration is really for:

  • find_doctypes — Find DocTypes in the system matching a search term
  • get_module_list — Get a list of all modules in the system
  • get_doctypes_in_module — Get a list of DocTypes in a specific module
  • check_doctype_exists — Check if a DocType exists in the system
  • check_document_exists — Check if a document exists
  • get_document_count — Get a count of documents matching filters
  • get_naming_info — Get the naming series information for a DocType
  • get_required_fields — Get a list of required fields for a DocType
  • get_api_instructions — Get detailed instructions for using the Frappe API
  • Prerequisites — The Prerequisites tool exposed by this server
  • Setup — The Setup tool exposed by this server
  • Authentication — This MCP server only supports API key/secret authentication via the Frappe REST API. Username/password authentication is not supported

Credentials and setup notes

Configuration is passed through the environment: FRAPPE_URL, FRAPPE_API_KEY, FRAPPE_API_SECRET. Treat anything key-shaped as a real credential — scope it to the minimum the server needs, and rotate it if it ever lands in a shared config.

  • Node.js 18 or higher - A running Frappe instance (version 15 or higher) - API key and secret from Frappe (required)

Worth knowing first

  • It runs with your machine's permissions. That is convenient and also the reason to think about what you point it at before you approve a tool call.
  • With 12 tools registered it takes up a noticeable share of the context window; turn it off in projects that never touch Frappe.
  • Missing credentials fail quietly in some clients — if no tools show up, check the environment block first.
  • Keep per-call confirmation enabled while you learn its behaviour; it is the cheapest safeguard you have.

Where it fits

Among the developer tooling options, the useful question is rarely "what can it do" but "what does it cost you to run" — permissions, credentials, and how much of your context its toolset consumes. Frappe's toolset — find_doctypes, get_module_list, get_doctypes_in_module and 9 more — is a fair guide to whether it matches your workflow. It is maintained by Sena-IT; worth a glance at recent repository activity before you build anything load-bearing on it.

SyncDev reviews every entry in this directory against the project's own documentation before publishing, and revisits them as servers change.

Available tools

ToolWhat it does
find_doctypesFind DocTypes in the system matching a search term
get_module_listGet a list of all modules in the system
get_doctypes_in_moduleGet a list of DocTypes in a specific module
check_doctype_existsCheck if a DocType exists in the system
check_document_existsCheck if a document exists
get_document_countGet a count of documents matching filters
get_naming_infoGet the naming series information for a DocType
get_required_fieldsGet a list of required fields for a DocType
get_api_instructionsGet detailed instructions for using the Frappe API
PrerequisitesThe Prerequisites tool exposed by this server.
SetupThe Setup tool exposed by this server.
AuthenticationThis MCP server **only supports API key/secret authentication** via the Frappe REST API. Username/password authentication is not supported.

How to install the Frappe MCP server

{
  "mcpServers": {
    "frappe": {
      "command": "npx",
      "args": ["frappe-mcp-server"], // Assumes frappe-mcp-server is in MCP server path
      "env": {
        "FRAPPE_URL": "https://your-frappe-instance.com",
        "FRAPPE_API_KEY": "your_api_key", // REQUIRED
        "FRAPPE_API_SECRET": "your_api_secret" // REQUIRED
      },
      "disabled": false,
      "alwaysAllow": []
    }
  }
}

Configuration as documented by the project. Restart the client after saving.

Configuration

  • Node.js 18 or higher - A running Frappe instance (version 15 or higher) - API key and secret from Frappe (required)
VariableDescriptionRequired
FRAPPE_URLEndpoint or connection string the server talks to.Yes
FRAPPE_API_KEYCredential the server authenticates with.Yes
FRAPPE_API_SECRETCredential the server authenticates with.Yes

Example prompts to try

  • Use Frappe to find doctypes.
  • Use Frappe to get module list.
  • Use Frappe to get doctypes in module.

Frequently asked questions

It connects Frappe to MCP-compatible AI assistants such as Claude and Cursor, exposing 12 tools (find_doctypes, get_module_list, get_doctypes_in_module, and more) that the assistant can call on your behalf. Instead of copying data back and forth by hand, the assistant works with Frappe directly.