Skip to main content

ERPNext and Frappe REST/RPC MCP Server for Agentic AI!

Project description

Erpnext MCP

Status Version License

ERPNext and Frappe Framework enterprise resources planner. Built with the highest architectural standards, incorporating dynamic facades, custom API routing, and FastMCP tool decoration.

Documentation — Installation, deployment, usage across the MCP, API, and CLI interfaces, and guidance for provisioning the ERPNext / Frappe platform are maintained in the official documentation.

Table of Contents


Overview

Erpnext MCP provides a high-performance, model-optimized interface to Erpnext capabilities. It isolates the model from underlying API transport complexity, ensuring safe, idempotent, and highly traceable system interactions.


Features

  • Dynamic Facade Orchestration: Integrates multi-inheritance clients cleanly under a single facade.
  • Battle-Tested Resilience: Out-of-the-box credential authentication, connection polling, and request retry strategies.
  • FastMCP Declarative Tools: Fast, native schema registration with full inline validation.
  • Complete Test Intent Diversity: Deep, automated unit, integration, and mock tests ensuring high code coverage.

⚙️ Dynamic Tool Selection & Visibility

This MCP server supports dynamic toolset selection and visibility filtering at runtime. This allows you to restrict the set of exposed tools in order to prevent blowing up the LLM's context window.

You can configure tool filtering via multiple input channels:

  • CLI Arguments: Pass --tools or --toolsets (or their disabled counterparts --disabled-tools and --disabled-toolsets) during startup.
  • Environment Variables: Define standard environment variables:
    • MCP_ENABLED_TOOLS / MCP_DISABLED_TOOLS
    • MCP_ENABLED_TAGS / MCP_DISABLED_TAGS
  • HTTP SSE Request Headers: Pass custom headers during transport initialization:
    • x-mcp-enabled-tools / x-mcp-disabled-tools
    • x-mcp-enabled-tags / x-mcp-disabled-tags
  • HTTP SSE Request Query Parameters: Append query parameters directly to your transport connection URL:
    • ?tools=tool1,tool2
    • ?tags=tag1

When query strings or parameters are supplied, an LLM-free Knowledge Graph resolution layer (using DynamicToolOrchestrator) matches query intents against known tool tags, names, or descriptions, with safe fallback and automated 24-hour background cache refreshing.


Installation

Install in editable mode directly inside your active workspace:

pip install -e .[all]

Or via the uv tool:

uv pip install -e .

Usage

You can launch the FastMCP server in stdio mode via Python module execution:

import asyncio
from erpnext_agent.mcp_server import get_mcp_instance

async def main():
    mcp = get_mcp_instance()
    # Execute stdio loop or launch server
    print("MCP Server ready.")

if __name__ == "__main__":
    asyncio.run(main())

For direct shell launch, execute:

python -m erpnext_agent.mcp_server

Configuration

The package is fully configurable via the environment variables listed below:

Variable Description Default Required
ERPNEXT_URL ERPNext / Frappe server endpoint URL http://localhost:8000 Yes
ERPNEXT_TOKEN API authentication token (api_key:api_secret) your_api_key:your_api_secret Yes

A local template is supplied inside .env.example. Copy this file as .env and fill out your specific service endpoint parameters before starting execution.


MCP Tools

The following declarative FastMCP tools are registered and available to upstream AI agents:

Tool Name Description Parameters
get_document Get specific Frappe/ERPNext document by doctype and name doctype: str, name: str
create_document Create new Frappe/ERPNext document doctype: str, data: dict
call_method Call a whitelisted ERPNext RPC method method: str, params: dict = None

See docs/overview.md or docs/concepts.md for deeper operational examples.


Architecture

This package uses the standardized Agent-Utilities dynamic facade architecture:

graph TD
    User([User Agent]) --> Server[FastMCP Server]
    Server --> Facade[Api Dynamic Facade]
    Facade --> ClientBase[ApiClientBase]
    Facade --> Auth[Credentials Auth Handler]
    ClientBase --> Service([External Service API])

Deployment

Bare-Metal (Standard pip)

  1. Set up your Python virtual environment (>= 3.10).
  2. Install the package: pip install .[all]
  3. Export credentials:
    export ERPNEXT_URL="http://localhost:8000"
    
  4. Run: python -m erpnext_agent.mcp_server

Container (Docker Compose)

A standard compose structure is provided inside the docker/ folder. Build and deploy:

docker compose -f docker/compose.yml up --build -d

Additional Deployment Options

erpnext-agent can also run as a local container (Docker / Podman / uv) or be consumed from a remote deployment. The Deployment guide has full, copy-paste mcp_config.json for all four transports — stdio, streamable-http, local container / uv, and remote URL:

  • Local container / uv — launch the server from mcp_config.json via uvx, docker run, or podman run, or point at a local streamable-http container by url.
  • Remote URL — connect to a server deployed behind Caddy at http://erpnext-mcp.arpa/mcp using the "url" key.

Documentation

The complete documentation is published as the official documentation site and is the recommended reference for installation, deployment, and day-to-day operation.

Page Contents
Installation pip, source, extras, prebuilt Docker image
Deployment run the MCP and agent servers, Compose, Caddy + Technitium, env config
Usage the MCP tools, the Api client, the CLI
Backing Platform deploy ERPNext / Frappe with Docker
Overview the dynamic facade and FastMCP tool layer
Concepts concept registry (CONCEPT:ERPN-*)

AGENTS.md is the canonical contributor/agent guidance.


Contributing

Please audit all code changes against ecosystem guidelines in CONTRIBUTING.md if available, and run:

pre-commit run --all-files

License

This project is licensed under the MIT License. See the LICENSE file for complete details.

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_agent-0.33.0.tar.gz (18.8 kB view details)

Uploaded Source

Built Distribution

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

erpnext_agent-0.33.0-py3-none-any.whl (20.7 kB view details)

Uploaded Python 3

File details

Details for the file erpnext_agent-0.33.0.tar.gz.

File metadata

  • Download URL: erpnext_agent-0.33.0.tar.gz
  • Upload date:
  • Size: 18.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for erpnext_agent-0.33.0.tar.gz
Algorithm Hash digest
SHA256 a47be44641ca6d105959629de9eb7db64cb87ec4bd6420ab4714c02e9732e3d6
MD5 4338aace382bf31e043c2b6d2ab3a67a
BLAKE2b-256 3865dddbd9dfc1ff59bc4ef6e04783aa938c786cc69e30b66f2a1ccf79c63b2a

See more details on using hashes here.

File details

Details for the file erpnext_agent-0.33.0-py3-none-any.whl.

File metadata

  • Download URL: erpnext_agent-0.33.0-py3-none-any.whl
  • Upload date:
  • Size: 20.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for erpnext_agent-0.33.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9fad9697cd4c8cd364cffa93742b1f33858a80897a42798fc937a01baeda6291
MD5 5de816b6d4c040c004db957ec2ea512c
BLAKE2b-256 4b7c4e26b8473732f445c3147e973f3839e76cff82234db44a8e6dd6c8e9e9b1

See more details on using hashes here.

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