What is the Frappe MCP Server?

The Frappe MCP Server is a server that implements the Anthropic Model Control Protocol (MCP) for accessing Frappe. It allows AI assistants to interact with Frappe applications through the official REST API, focusing on document CRUD operations, schema handling, and detailed API instructions.

What is MCP?

MCP (Model Context Protocol) is an open protocol that standardizes how applications provide context to LLMs. It acts as a bridge, allowing AI models to access and interact with external data sources and tools.

What are the prerequisites for installing the Frappe MCP Server?

To install the Frappe MCP Server, you need Node.js 18 or higher, a running Frappe instance (version 15 or higher), and API key and secret from Frappe.

How do I get the API key and secret from Frappe?

To get API credentials from your Frappe instance:

1. Go to User > API Access > New API Key
2. Select the user for whom you want to create the key
3. Click “Generate Keys”
4. Copy the API Key and API Secret

What authentication methods does the Frappe MCP Server support?

The Frappe MCP Server only supports API key/secret authentication via the Frappe REST API. Username/password authentication is not supported.

How do I start the Frappe MCP Server?

You can start the server using the following command:

bash npx frappe-mcp-server

Or with environment variables:

bash FRAPPE_URL=https://your-frappe-instance.com FRAPPE_API_KEY=your_api_key FRAPPE_API_SECRET=your_api_secret npx frappe-mcp-server

How do I integrate the Frappe MCP Server with AI assistants like Claude?

To use this MCP server with an AI assistant, you need to configure the assistant to connect to this server. The exact configuration depends on the AI assistant platform you’re using. For Claude, add the following to your MCP settings configuration file:

{ “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”: [] } } }

What document operations are available?

The following document operations are available:

• create_document: Create a new document in Frappe
• get_document: Retrieve a document from Frappe
• update_document: Update an existing document in Frappe
• delete_document: Delete a document from Frappe
• list_documents: List documents from Frappe with filters

What schema operations are available?

The following schema operations are available:

• get_doctype_schema: Get the complete schema for a DocType including field definitions, validations, and linked DocTypes
• get_field_options: Get available options for a Link or Select field
• get_frappe_usage_info: Get combined information about a DocType or workflow, including schema metadata, static hints, and app-provided usage guidance

What helper tools are available?

The following helper tools are available:

• 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