Frappe MCP Server
mcp-name: io.github.muthanii/frappe_mcp
A Model Context Protocol (MCP) server for Frappe Framework. Connect Claude Desktop, VS Code Copilot, and other MCP clients to any Frappe/ERPNext site via its REST API.
Where to get it
| Distribution | Reference | Page |
|---|---|---|
| PyPI | frappe-mcp-server |
pypi.org/project/frappe-mcp-server |
| Docker Hub | muthanii/frappe-mcp |
hub.docker.com/r/muthanii/frappe-mcp |
| GitHub Container Registry | ghcr.io/muthanii/frappe-mcp |
ghcr package |
| MCP Registry | io.github.muthanii/frappe_mcp |
registry API |
| Glama | — | glama.ai/mcp/servers/muthanii/frappe_mcp |
| Source | — | github.com/muthanii/frappe_mcp |
Features
- Document CRUD — get, create, update, delete Frappe doctypes
- Search — full-text and filtered document search
- Remote method calls — invoke any server-side Python method
- Authentication — API key + secret (token-based auth)
- Docker-first — single
docker runcommand, no Python install needed
Quick start
With uvx (no install):
FRAPPE_URL=https://your-site.com \
FRAPPE_API_KEY=your-api-key \
FRAPPE_API_SECRET=your-api-secret \
uvx frappe-mcp-server
With pip:
pip install frappe-mcp-server
frappe-mcp-server
With Docker (Docker Hub):
docker run -i --rm \
-e FRAPPE_URL=https://your-site.com \
-e FRAPPE_API_KEY=your-api-key \
-e FRAPPE_API_SECRET=your-api-secret \
muthanii/frappe-mcp
With Docker (GHCR):
docker run -i --rm \
-e FRAPPE_URL=https://your-site.com \
-e FRAPPE_API_KEY=your-api-key \
-e FRAPPE_API_SECRET=your-api-secret \
ghcr.io/muthanii/frappe-mcp
Available tools
Every tool ships MCP tool annotations and a declared outputSchema, so a client can tell read tools from destructive ones before calling them.
| Tool | Description | Access | Destructive | Idempotent |
|---|---|---|---|---|
frappe_ping |
Check connectivity and credentials | read-only | no | yes |
frappe_get_doc |
Retrieve a single document by doctype + name | read-only | no | yes |
frappe_search_docs |
Search/list documents with filters | read-only | no | yes |
frappe_create_doc |
Create a new document | write | no | no |
frappe_update_doc |
Update an existing document | write | yes | yes |
frappe_delete_doc |
Delete a document — irreversible | write | yes | no |
frappe_run_method |
Call a whitelisted server-side method | write | yes | no |
frappe_run_method is marked destructive because its effect is determined entirely by the method you name.
Configuration
| Environment variable | Required | Description |
|---|---|---|
FRAPPE_URL |
Yes | Base URL of your Frappe site (e.g. https://erp.example.com) |
FRAPPE_API_KEY |
Yes | Frappe API key |
FRAPPE_API_SECRET |
Yes | Frappe API secret |
FRAPPE_VERIFY_SSL |
No | Set to false to skip TLS verification (default: true) |
FRAPPE_TIMEOUT |
No | Request timeout in seconds (default: 30) |
MCP client config
Add this to your claude_desktop_config.json or Copilot config.
Via uvx:
{
"mcpServers": {
"frappe": {
"command": "uvx",
"args": ["frappe-mcp-server"],
"env": {
"FRAPPE_URL": "https://your-site.com",
"FRAPPE_API_KEY": "your-api-key",
"FRAPPE_API_SECRET": "your-api-secret"
}
}
}
}
Via Docker:
{
"mcpServers": {
"frappe": {
"command": "docker",
"args": [
"run", "-i", "--rm",
"-e", "FRAPPE_URL",
"-e", "FRAPPE_API_KEY",
"-e", "FRAPPE_API_SECRET",
"muthanii/frappe-mcp"
],
"env": {
"FRAPPE_URL": "https://your-site.com",
"FRAPPE_API_KEY": "your-api-key",
"FRAPPE_API_SECRET": "your-api-secret"
}
}
}
}
Local development
pip install -e .
frappe-mcp
License
MIT — see LICENSE.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file frappe_mcp_server-1.2.0.tar.gz.
File metadata
- Download URL: frappe_mcp_server-1.2.0.tar.gz
- Upload date:
- Size: 19.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bbf1425559d5ae75fedad45b6ad87c71861f4105f799b15e461da7f3fd136c50
|
|
| MD5 |
61281f5da168789acf9bb01126da45a3
|
|
| BLAKE2b-256 |
1b17bf55b8e3632b780c0ce971d41f4e96090ac291cfc3317aad5c6524d4ab08
|
File details
Details for the file frappe_mcp_server-1.2.0-py3-none-any.whl.
File metadata
- Download URL: frappe_mcp_server-1.2.0-py3-none-any.whl
- Upload date:
- Size: 15.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2b7da8e7bf93d5f295c72546d9de73b1576faa1cb8f86f7d453bdf81f7888c74
|
|
| MD5 |
094582c9ae23af007471fb237f8aa4a5
|
|
| BLAKE2b-256 |
1de03dc8d9306276cd7f3f82ffe5db4481eb439e98f97f26dc542011ad1ecab7
|