frappe-dev-mcp-server: Instructions file for Claude Code

Frappe Development MCP Server

This is an MCP (Model Context Protocol) server providing 139 tools for comprehensive Frappe framework development — covering DocTypes, documents, hooks, permissions, workflows, scripts, customization, communication, web/portal, print, dashboard, background jobs, data management, testing, v16 workspace sidebar, desktop icons, and frappe-ui SPA frontend development.

Setup for Claude Code

Prerequisites

1. Node.js >= 18
2. A Frappe bench directory with at least one site

Quick Setup

# 1. Clone and build
cd frappe-dev-mcp-server
npm install
npm run build

# 2. Set environment variables pointing to your Frappe bench
export FRAPPE_PATH=/path/to/your/frappe-bench
export FRAPPE_DEFAULT_SITE=your-site.localhost

# 3. Add to Claude Code (stdio mode - recommended)
claude mcp add --transport stdio --scope user \
  --env FRAPPE_PATH=/path/to/your/frappe-bench \
  --env FRAPPE_DEFAULT_SITE=your-site.localhost \
  frappe-dev -- node /absolute/path/to/frappe-dev-mcp-server/dist/index.js --stdio

Alternative: SSE Mode

If you prefer running the server as a persistent process:

# Start the SSE server
FRAPPE_PATH=/path/to/bench FRAPPE_DEFAULT_SITE=site.localhost npm start

# Add to Claude Code
claude mcp add --transport sse frappe-dev http://localhost:3000/sse

Project-Level Configuration

The .mcp.json in this repo configures the server for anyone opening this project with Claude Code. Set the environment variables and it auto-connects:

export FRAPPE_PATH=/path/to/your/frappe-bench
export FRAPPE_DEFAULT_SITE=your-site.localhost

Using in Another Frappe Project

Copy or adapt the .mcp.json to your Frappe app repo:

{
  "mcpServers": {
    "frappe-dev": {
      "type": "stdio",
      "command": "node",
      "args": ["/absolute/path/to/frappe-dev-mcp-server/dist/index.js", "--stdio"],
      "env": {
        "FRAPPE_PATH": "${FRAPPE_PATH}",
        "FRAPPE_DEFAULT_SITE": "${FRAPPE_DEFAULT_SITE}"
      }
    }
  }
}