Frappe MCP Server
by appliedrelevance
The Frappe MCP Server exposes Frappe's functionality to AI assistants through the official REST API, focusing on document CRUD operations and schema handling. It provides a standardized interface for AI assistants to interact with Frappe applications.
Last updated: N/A
What is Frappe MCP Server?
A Model Context Protocol (MCP) server for Frappe Framework that allows AI assistants to interact with Frappe applications through a standardized interface using the official Frappe REST API. It provides tools for document operations, schema handling, and detailed API usage instructions.
How to use Frappe MCP Server?
Install the server via npm or run directly with npx. Configure the server using environment variables for the Frappe instance URL, API key, and API secret. Integrate with an AI assistant by configuring the assistant to connect to the server, providing the necessary environment variables.
Key features of Frappe MCP Server
Document operations (create, read, update, delete, list)
Schema and metadata handling
DocType discovery and exploration
Detailed API usage instructions and examples
Comprehensive error handling and validation
Use cases of Frappe MCP Server
Enabling AI assistants to create and manage documents in Frappe
Allowing AI assistants to retrieve information from Frappe
Automating tasks in Frappe using AI assistants
Integrating Frappe with other AI-powered applications
FAQ from Frappe MCP Server
What is the purpose of this server?
What is the purpose of this server?
To allow AI assistants to interact with Frappe applications through a standardized interface.
What are the prerequisites for installation?
What are the prerequisites for installation?
Node.js 18 or higher, a running Frappe instance (version 15 or higher), and API key and secret from Frappe (optional but recommended).
How do I configure the server?
How do I configure the server?
Using environment variables such as FRAPPE_URL, FRAPPE_API_KEY, and FRAPPE_API_SECRET.
How do I get API credentials from Frappe?
How do I get API credentials from Frappe?
Go to User > API Access > New API Key in your Frappe instance.
What are some best practices for using this server?
What are some best practices for using this server?
Check DocType schema first, use pagination when listing documents, specify fields, validate before creating, and check existence before updating or deleting.