README.md
Interact with Frappe and ERPNext sites through their REST API endpoints.
frappe-api-mcp
Model Context Protocol (MCP) server that exposes a single frappe_api tool to call Frappe REST endpoints under /api.
What it provides
- Tool name:
frappe_api - Methods:
GET,POST,PUT,PATCH,DELETE - Input:
path(required),method,query,body,headers - Auth: uses
FRAPPE_AUTH_TOKENas theAuthorizationheader unless overridden
Requirements
- Node.js 18+
- A reachable Frappe/ERPNext site
Local setup
git clone https://github.com/danielsebastianc/frappe-api-mcp.git
cd frappe-api-mcp
npm install
cp .env.example .env
Set these environment variables before running:
FRAPPE_BASE_URL(example:http://localhost:8000)FRAPPE_AUTH_TOKEN(example:token api_key:api_secret)
Run
npm start
Test
npm test
OpenCode MCP config example
Do not put real secrets in committed config files. Prefer environment injection.
{
"mcp": {
"frappe_api": {
"type": "local",
"command": ["node", "/path/to/your/folder/mcp/frappe-api-server.mjs"],
"environment": {
"FRAPPE_BASE_URL": "http://localhost:8000",
"FRAPPE_AUTH_TOKEN": "token api_key:api_secret"
}
}
}
}
Tools (1)
frappe_apiCalls Frappe REST endpoints under /api to perform CRUD operations.Environment Variables
FRAPPE_BASE_URLrequiredThe base URL of your Frappe/ERPNext siteFRAPPE_AUTH_TOKENrequiredThe authorization token for API accessConfiguration
claude_desktop_config.json
{"mcpServers": {"frappe_api": {"command": "node", "args": ["/path/to/your/folder/mcp/frappe-api-server.mjs"], "env": {"FRAPPE_BASE_URL": "http://localhost:8000", "FRAPPE_AUTH_TOKEN": "token api_key:api_secret"}}}}Try it
→Fetch the list of customers from the ERPNext site using the frappe_api tool.
→Create a new task in the project module using a POST request to the frappe_api.
→Update the status of the sales order with ID SO-001 to 'Completed'.
→Delete the document with ID 123 from the custom doctype.