Skip to main content

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
  • Supplier/Customer — Get complete details with address, phone, contacts; supports alias search
  • Files — Upload, list, download files
  • 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 (exact item_code)
get_stock_ledger Stock ledger entries (exact item_code)
get_item_price Item prices from price lists (exact item_code)
find_items Fuzzy-search Item across name / item_name / item_code
get_item_details Item master + stock + price in one call (supports keyword)
make_mapped_doc Document conversion (e.g. SO → DN)
get_party_balance Outstanding balance for Customer/Supplier
get_supplier_details Get supplier with address, phone, contacts (supports alias search)
get_customer_details Get customer with address, phone, contacts (supports alias search)
upload_file Upload a local file to ERPNext (by file path)
upload_file_from_url Upload a file from URL
list_files List files attached to a document
download_file Download a file by URL
get_file_url Get download URL for a file

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

Metadata

Release files for erpnext-mcp 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for erpnext-mcp 0.5.0
File Size Uploaded
erpnext_mcp-0.5.0.tar.gz 24.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for erpnext-mcp 0.5.0
File Interpreter ABI Platform
erpnext_mcp-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 40.3 kB

Release files / erpnext_mcp-0.5.0.tar.gz

Download URL erpnext_mcp-0.5.0.tar.gz
Size 24.7 kB
Tags Source
SHA-256 checksum
How to use checksums
8340bf9196f6079bf5cdaa0910180481000a0067a6a4e6a52d3c36cac50bc960
BLAKE2b-256 checksum
How to use checksums
81b54ea11a47031fc8e91707c0c4f7477b5b4e8f0b5d204c86209ddfd5baf179
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 25, 2026.

Transparency log

Release files / erpnext_mcp-0.5.0-py3-none-any.whl

Download URL erpnext_mcp-0.5.0-py3-none-any.whl
Size 15.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5f7f238d6930a0be4c321e8fbe61756f4b496cfe7026910d096b372533418593
BLAKE2b-256 checksum
How to use checksums
eb4e76dc53aa0d180ba80f1bf35fbb170b7e41e8e0b77029f9a7b4ea92a0e4f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 25, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.5.0 This release

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page