Erpnext

🚀 ERPNext MCP Server

A TypeScript-based MCP server for integrating with the ERPNext/Frappe interface. It enables AI assistants to interact with ERPNext data and functions through the Model Context Protocol.

✨ Features

Resources

• Access ERPNext documents via erpnext://{doctype}/{name} URI.
• Use JSON format for structured data access.

Tools

• authenticate_erpnext - Authenticate with ERPNext using username and password.
• get_documents - Retrieve a list of documents of a specific doctype.
• create_document - Create a new document in ERPNext.
• update_document - Update an existing document.
• run_report - Run an ERPNext report.
• get_doctype_fields - Get the list of fields for a specific doctype.
• get_doctypes - Get a list of all available doctypes.

📦 Installation

Configuration

The server requires the following environment variables:

• ERPNEXT_URL - The base URL of your ERPNext instance.
• ERPNEXT_API_KEY (optional) - The API key.
• ERPNEXT_API_SECRET (optional) - The API secret.

Development

Install dependencies:

npm install

Build the server:

npm run build

Development with automatic rebuild:

npm run watch

Integration

When using with Claude Desktop, add the server configuration to:

• On MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• On Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "erpnext": {
      "command": "node",
      "args": ["/path/to/erpnext-server/build/index.js"],
      "env": {
        "ERPNEXT_URL": "http://your-erpnext-instance.com",
        "ERPNEXT_API_KEY": "your-api-key",
        "ERPNEXT_API_SECRET": "your-api-secret"
      }
    }
  }
}

When using with Claude in VSCode, add the server configuration to:

• On MacOS: ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
• On Windows: %APPDATA%/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json

Debugging

Since the MCP server communicates via standard input/output, debugging can be challenging. We recommend using the MCP Inspector, which is available as a package script:

npm run inspector

The inspector will provide a URL to the debugging tools in your browser.

💻 Usage Examples

Basic Usage

Authentication

<use_mcp_tool>
<server_name>erpnext</server_name>
<tool_name>authenticate_erpnext</tool_name>
<arguments>
{
  "username": "your-username",
  "password": "your-password"
}
</arguments>
</use_mcp_tool>

Get Customer List

<use_mcp_tool>
<server_name>erpnext</server_name>
<tool_name>get_documents</tool_name>
<arguments>
{
  "doctype": "Customer"
}
</arguments>
</use_mcp_tool>

Create a New Document

<use_mcp_tool>
<server_name>erpnext</server_name>
<tool_name>create_document</tool_name>
<arguments>
{
  "doctype": "Sales Invoice",
  "data": {
    "customer": "John Doe",
    "amount": 100
  }
}
</arguments>
</use_mcp_tool>

Update a Document

<use_mcp_tool>
<server_name>erpnext</server_name>
<tool_name>update_document</tool_name>
<arguments>
{
  "doctype": "Sales Invoice",
  "name": "INV-001",
  "data": {
    "amount": 150
  }
}
</arguments>
</use_mcp_tool>

Run a Report

<use_mcp_tool>
<server_name>erpnext</server_name>
<tool_name>run_report</tool_name>
<arguments>
{
  "report": "Sales Summary"
}
</arguments>
</use_mcp_tool>

Get Doctype Fields

<use_mcp_tool>
<server_name>erpnext</server_name>
<tool_name>get_doctype_fields</tool_name>
<arguments>
{
  "doctype": "Sales Invoice"
}
</arguments>
</use_mcp_tool>

Get All Doctypes

<use_mcp_tool>
<server_name>erpnext</server_name>
<tool_name>get_doctypes</tool_name>
</use_mcp_tool>