文档操作服务器

一个现代化的、容器化的Python实现的Frappe框架模型上下文协议(MCP)服务器,支持文档操作、模式内省、报告生成和方法调用。

  • by appliedrelevance
  • Python
  • 本地部署
  • 17 星标
  • 更新于
在 GitHub 查看 appliedrelevance/frappe-mcp-server

使用说明

Frappe MCP服务器(Python+uv+Docker)

Frappe Framework的模型上下文协议(MCP)服务器的现代容器化Python实现,使用FastMCP、用于依赖管理的uv和用于部署的Docker构建。

特性

  • 文档操作:Frappe文件的完整CRUD操作
  • 图式反思:DocType字段定义和结构分析
  • 报告生成:查询报告、财务报表和数据导出
  • 方法调用:执行列入白名单的Frappe方法
  • 认证:安全的API密钥/秘密身份验证

快速开始

先决条件

  • Docker和Docker Compose
  • 使用API证书访问Frappe网站

设置

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

可用的MCP工具

文档操作

  • create_document:创建新的Frappe文档
  • get_document:按DocType和名称检索文档
  • update_document:更新现有文件
  • delete_document:删除文档
  • list_documents:使用筛选器查询文档
  • call_method:执行列入白名单的Frappe方法

架构操作

  • get_doctype_schema:获取完整的DocType结构
  • get_field_options:获取链接/选择字段选项
  • get_doctype_list:列出可用的DocType
  • get_frappe_usage_info:组合模式和使用信息

报告操作

  • run_query_report:执行Frappe查询报告
  • get_report_meta:获取报告元数据和结构
  • list_reports:列出可用报告
  • run_doctype_report:生成基于DocType的报告
  • get_financial_statements:访问损益表、资产负债表、现金流

助手操作

  • ping:服务器健康检查
  • version:获取服务器版本信息
  • validate_auth:检查API凭证状态

发展

# Install with development dependencies
uv sync --dev

# Run tests
uv run pytest

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

许可证

ISC许可证-有关详细信息,请参阅许可证文件。