AF

appliedrelevance/frappe-mcp-server

部署与 DevOps

本页由 AI 翻译,技术细节请以原文为准。 查看原文

17 stars 12 forks 质量 31 趋势 21

Python 执行 Frappe MCP 服务器,具有高级过滤,全面的API覆盖,以及绕过 MCP JSON 验证限制的自定义过滤语言

概览

用于Frappe Framework的模型上下文协议(MCP)服务器的现代化和集装箱化的Python执行,由FastMCP所建,V用于依赖管理,Docker用于部署. - : Frappe 文档的完整 CRUD 操作 - : DocType 字段定义和结构分析 - : 查询报告、财务报表和数据导出 - : 执行白色列表的 Frappe 方法 - : 安全 API 密钥/秘密认证 - Docker和Docker Compose - 访问具有API资格的Frappe网站 - 创建 文档:创建新的 Frappe 文档 - get 文档:由 DocType 获取文档并名称 - 更新 文档:更新已存在的文档 - 删除 文档:删除文档 - 列表 文档:使用过滤器查询文档 - 调用 方法:执行白列 Frappe 方法 - get doctype schema:获取完整的 DocType 结构 - get field options:获取链接/选择字段选项 - get doctype list:列表可用的 DocTypes - get frappe usage info:组合的策略和使用信息 - 说吧...

概述(AI 翻译)

用于Frappe Framework的模型上下文协议(MCP)服务器的现代化和集装箱化的Python执行,由FastMCP所建,V用于依赖管理,Docker用于部署.

□ 特性

  • 文件业务: Frappe 文档的全部 CRUD 操作
  • Schema Introduction:DocType字段定义和结构分析
  • ** 报告生成**:查询报告、财务报表和数据出口
  • ** 调用方法**:执行列入白名单的弗拉佩方法
  • ** 核证**: 安全 API 密钥/ 秘密认证

□ 快开始

· 先决条件

  • 多克和多克编曲
  • 访问具有API证书的Frappe网站

QQ 设置

□ 可用的 MCP 工具

文件操作

  • [[T0]: 创建新的 Frappe 文档
  • [[T1]: 通过 DocType 检索文档和名称
  • [[T2]: 更新现有文件
  • [[T3]: 删除文档
  • [[T4]: 使用过滤器查询文档
  • [[T5]: 执行列入白名单的Frappe方法

XQSchema 操作

  • [[T6]: 获得完整的 DocType 结构
  • [[T7]:获取链接/选择字段选项
  • [[T8]: 列出可用的 DocTypes

本页由 AI 翻译,技术细节请以原文为准。

README

Frappe MCP Server (Python + uv + Docker)

A modern, containerized Python implementation of the Model Context Protocol (MCP) server for Frappe Framework, built with FastMCP, uv for dependency management, and Docker for deployment.

Features

  • Document Operations: Full CRUD operations for Frappe documents
  • Schema Introspection: DocType field definitions and structure analysis
  • Report Generation: Query reports, financial statements, and data exports
  • Method Calling: Execute whitelisted Frappe methods
  • Authentication: Secure API key/secret authentication

Quick Start

Prerequisites

  • Docker and Docker Compose
  • Access to a Frappe site with API credentials

Setup

git clone https://github.com/appliedrelevance/frappe_mcp_server_uv.git
cd frappe_mcp_server_uv
cp .env.example .env
# Edit .env with your Frappe credentials
docker-compose up -d frappe-mcp-server

Available MCP Tools

Document Operations

  • create_document: Create new Frappe documents
  • get_document: Retrieve document by DocType and name
  • update_document: Update existing documents
  • delete_document: Delete documents
  • list_documents: Query documents with filters
  • call_method: Execute whitelisted Frappe methods

Schema Operations

  • get_doctype_schema: Get complete DocType structure
  • get_field_options: Get Link/Select field options
  • get_doctype_list: List available DocTypes
  • get_frappe_usage_info: Combined schema and usage information

Report Operations

  • run_query_report: Execute Frappe query reports
  • get_report_meta: Get report metadata and structure
  • list_reports: List available reports
  • run_doctype_report: Generate DocType-based reports
  • get_financial_statements: Access P&L, Balance Sheet, Cash Flow

Helper Operations

  • ping: Server health check
  • version: Get server version information
  • validate_auth: Check API credential status

Development

# Install with development dependencies
uv sync --dev

# Run tests
uv run pytest

# Format code
uv run black src/ && uv run isort src/

License

ISC License - see LICENSE file for details.

在 GitHub 查看完整 README

安装

This server does not publish a one-line install command.

Open the repository installation guide 新手?先看 mcpskill.org 教程 →