Erpnext

🚀 ERPNext MCP Server

An MCP (Model Context Protocol) server for ERPNext integration.

This is a TypeScript-based MCP server that offers integration with the ERPNext/Frappe API. It enables AI assistants to access ERPNext data and functionality through the Model Context Protocol.

✨ Features

Resources

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

Tools

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

📦 Installation

Configuration

The server requires the following environment variables:

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

Development

Install dependencies:

npm install

Build the server:

npm run build

Develop with automatic rebuild:

npm run watch

Integration with Applications

With Claude Desktop

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

Configure as follows:

{
  "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"
      }
    }
  }
}

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 and output, debugging can be challenging. We recommend using MCP Inspector, which can be run via a package script:

npm run inspector

The Inspector will provide a URL to access the debugging tool in a browser.

💻 Usage Examples

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 Document

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

Update a Document

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

Run a Report

<use_mcp_tool>
<server_name>erpnext</server_name>
<tool_name>run_report</tool_name>
<arguments>
{
  "report": "Sales Report",
  "filters": {
    "from_date": "2023-01-01",
    "to_date": "2023-12-31"
  }
}
</arguments>
</use_mcp_tool>

Get Document Type 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 Document Types

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