关键词

FrappeAPI集成AI助手文档管理模式处理

使用说明

项目简介

Frappe MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端，旨在使 AI 助手能够通过标准化的接口与 Frappe 应用程序进行交互。它通过 Frappe 官方 REST API 将 Frappe 框架的功能暴露给 AI 助手，专注于文档的 CRUD 操作、模式处理和详细的 API 使用说明。

主要功能点

  • 文档操作：支持创建、读取、更新、删除和列出 Frappe 框架中的文档，使 AI 助手能够直接管理 Frappe 系统中的数据。
  • 模式和元数据处理：提供获取 DocType 模式、字段选项等功能，帮助 AI 助手理解 Frappe 数据结构，从而更有效地进行数据操作。
  • DocType 发现和探索：允许 AI 助手查找和探索 Frappe 系统中的 DocType 和模块，增强其对 Frappe 系统的理解和应用能力。
  • 详细 API 使用说明：提供工具以获取 Frappe API 的详细使用指南和示例，辅助 AI 助手正确调用和使用 Frappe 的各项功能。

安装步骤

  1. 环境准备：

    • 确保已安装 Node.js 18 或更高版本。
    • 确保已有一个正在运行的 Frappe 实例（版本 15 或更高）。
    • （可选但推荐） 从 Frappe 实例中获取 API 密钥 (API Key) 和 密钥 (API Secret)，用于服务器安全配置。

  2. 安装 Frappe MCP Server：

    • 打开终端，运行以下命令通过 npm 全局安装 'frappe-mcp-server'： 
      npm install -g frappe-mcp-server
    • 或者，您也可以使用 'npx' 直接运行，无需全局安装： 
      npx frappe-mcp-server

服务器配置

  • MCP 服务器是为 MCP 客户端（如 Claude 等 AI 助手）设计的。客户端需要配置服务器的启动命令和参数才能建立连接。
  • 以下是在 Claude AI 助手 MCP 设置中配置 Frappe MCP Server 的示例 JSON 格式配置信息： 
    {
  "mcpServers": {
    "frappe": {
      "command": "npx",
      "args": ["frappe-mcp-server"], // 启动 Frappe MCP 服务器的命令，假设 frappe-mcp-server 可在环境变量 PATH 中找到
      "env": {
        "FRAPPE_URL": "https://your-frappe-instance.com", // **[必填]** 您的 Frappe 实例 URL，例如：https://your-frappe-instance.com 或 http://localhost:8000
        "FRAPPE_API_KEY": "your_api_key", // **[可选，但推荐]**  Frappe API 密钥，用于身份验证
        "FRAPPE_API_SECRET": "your_api_secret" // **[可选，但推荐]** Frappe API 密钥，用于身份验证
      },
      "disabled": false,
      "alwaysAllow": []
    }
  }
}
    配置参数说明：
    • 'command': 启动 Frappe MCP Server 的命令，通常为 'npx' 或 Node.js 可执行文件的路径。
    • 'args': 传递给启动命令的参数，这里是 '["frappe-mcp-server"]'，即服务器的入口文件。
    • 'env': 环境变量配置，用于服务器运行时读取配置信息。
      • 'FRAPPE_URL': [必填] 指定 Frappe 实例的 URL。请替换为您的实际 Frappe 实例地址。
      • 'FRAPPE_API_KEY' 和 'FRAPPE_API_SECRET': [可选，但强烈建议配置] 用于 Frappe API 身份验证的密钥对。配置后，服务器可以安全地访问 Frappe 实例。如果您未配置，部分需要身份验证的操作可能无法执行。

基本使用方法

  1. 启动服务器：
    • 在配置好环境变量（特别是 'FRAPPE_URL'，以及可选的 API 密钥对）后，打开终端，运行以下命令启动 Frappe MCP Server： 
      npx frappe-mcp-server
    • 或者，您可以使用带有环境变量的命令一次性配置并启动服务器： 
      FRAPPE_URL=https://your-frappe-instance.com FRAPPE_API_KEY=your_api_key FRAPPE_API_SECRET=your_api_secret npx frappe-mcp-server
  2. 集成到 AI 助手：
    • 根据您使用的 AI 助手平台（如 Claude）的指引，配置 MCP 服务器连接。
    • 将上面提供的 JSON 配置信息添加到 AI 助手的 MCP 服务器设置中，确保配置中的 'FRAPPE_URL'、'FRAPPE_API_KEY' 和 'FRAPPE_API_SECRET' 与您的 Frappe 实例和 API 密钥信息匹配。
  3. 通过 AI 助手使用：
    • 配置完成后，AI 助手即可通过 MCP 协议与 Frappe MCP Server 通信。
    • 您可以通过 AI 助手的界面或指令，调用 Frappe MCP Server 提供的工具和资源，例如查询 DocType 模式、创建或更新文档等，从而实现 AI 助手与 Frappe 系统的集成互动。

信息

分类

商业系统

访问项目