Skip to main content

MCP Server for ERPNext REST API

Project description

ERPNext MCP Server

MCP (Model Context Protocol) server for ERPNext REST API, built with FastMCP and Python.

Features

  • CRUD — List, get, create, update, delete documents
  • Workflow — Submit and cancel submittable documents
  • Reports — Run ERPNext query reports
  • Schema — Inspect DocType field definitions, list all DocTypes
  • Inventory — Stock balance, stock ledger, item prices
  • Trading — Document conversion (e.g. Quotation → Sales Order), party balance
  • Helpers — Link search (autocomplete), document count, generic method calls

Requirements

  • Python >= 3.11
  • uv (recommended) or pip
  • ERPNext instance with API key/secret

Setup

# Clone the repo
git clone <repo-url> && cd erpnext-mcp

# Create .env file
cat > .env << 'EOF'
ERPNEXT_URL=https://your-erpnext-instance.com
ERPNEXT_API_KEY=your_api_key
ERPNEXT_API_SECRET=your_api_secret
EOF

# Install dependencies
uv sync

Run

set -a && source .env && set +a && uv run erpnext-mcp

Available Tools

Tool Description
list_documents List documents with filters, sorting, pagination
get_document Get a single document by name
create_document Create a new document
update_document Update an existing document
delete_document Delete a document
submit_document Submit a submittable document
cancel_document Cancel a submitted document
run_report Execute an ERPNext report
get_count Get document count with optional filters
get_list_with_summary List documents with total count
run_method Call any whitelisted server-side method
search_link Link field autocomplete search
list_doctypes List all available DocType names
get_doctype_meta Get field definitions for a DocType
get_stock_balance Real-time stock balance from Bin
get_stock_ledger Stock ledger entries (inventory history)
get_item_price Item prices from price lists
make_mapped_doc Document conversion (e.g. SO → DN)
get_party_balance Outstanding balance for Customer/Supplier

MCP Client Configuration

Add to your MCP client config (e.g. Claude Desktop claude_desktop_config.json):

{
  "mcpServers": {
    "erpnext": {
      "command": "uv",
      "args": ["--directory", "/path/to/erpnext-mcp", "run", "erpnext-mcp"],
      "env": {
        "ERPNEXT_URL": "https://your-erpnext-instance.com",
        "ERPNEXT_API_KEY": "your_api_key",
        "ERPNEXT_API_SECRET": "your_api_secret"
      }
    }
  }
}

Project Structure

src/erpnext_mcp/
├── server.py   # MCP tool definitions (FastMCP)
├── client.py   # ERPNext REST API client (httpx async)
└── types.py    # Pydantic models

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

erpnext_mcp-0.3.0.tar.gz (21.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

erpnext_mcp-0.3.0-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file erpnext_mcp-0.3.0.tar.gz.

File metadata

  • Download URL: erpnext_mcp-0.3.0.tar.gz
  • Upload date:
  • Size: 21.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for erpnext_mcp-0.3.0.tar.gz
Algorithm Hash digest
SHA256 c5f8175e10f23e8291989f92449c31d98a573fed5babc316320f6fde9f95726e
MD5 99247450ec38031df5e05c38c27cfbf9
BLAKE2b-256 de8a471274a78645574ee4d427853acff394ef4b6388d49fdb1d05e383083ae4

See more details on using hashes here.

Provenance

The following attestation bundles were made for erpnext_mcp-0.3.0.tar.gz:

Publisher: publish.yml on yazelin/erpnext-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file erpnext_mcp-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: erpnext_mcp-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for erpnext_mcp-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e309c55ff0bdfa075394f212f5436718dc35c8beb70f0fa6ffed0b807b0920db
MD5 56df4cbe1dc0df607aadd20c75d194ac
BLAKE2b-256 f1e965041bcd5687b7b39daaef8a615b7a6fbf6cbf28a61b9264c020107de2fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for erpnext_mcp-0.3.0-py3-none-any.whl:

Publisher: publish.yml on yazelin/erpnext-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page