使用说明

项目简介

'scaflog-zoho-mcp-server' 是一个 MCP (Model Context Protocol) 服务器,旨在桥接 Zoho Creator 应用和支持 MCP 协议的 LLM 客户端(如 Claude)。它允许 LLM 客户端以标准化的方式访问和利用 Zoho Creator 应用中的数据资源。

主要功能点

  • 资源 (Resources): 将 Zoho Creator 的表单 (Forms) 和报表 (Reports) 作为 MCP 资源暴露,允许 LLM 客户端浏览和读取这些资源中的数据。服务器预配置了白名单,仅暴露指定的表单和报表。
  • 数据访问: LLM 客户端可以通过标准的 MCP 协议读取 Zoho Creator 表单和报表的数据,用于上下文学习或其他 LLM 应用场景。
  • 配置化白名单: 服务器通过配置文件 'resource_config.py' 管理可以被 LLM 客户端访问的 Zoho Creator 资源,提高了数据安全性。

安装步骤

  1. 安装 Python 和 uv: 确保你的系统安装了 Python 和 'uv' 包管理器。如果尚未安装 'uv',可以使用 pip 安装:'pip install uv'。
  2. 克隆仓库: 从 GitHub 克隆 'mastercode-io_scaflog-zoho-mcp-server' 仓库到本地。
  3. 安装依赖: 在仓库根目录下,运行 'uv sync' 安装项目依赖。
  4. 配置环境变量:
    • 复制仓库根目录下的 '.env.example' 文件并重命名为 '.env'。
    • 根据你的 Zoho Creator 应用信息,编辑 '.env' 文件,填入 'ZOHO_CLIENT_ID', 'ZOHO_CLIENT_SECRET', 'ZOHO_REFRESH_TOKEN', 'ZOHO_ORGANIZATION_ID', 和 'ZOHO_ENVIRONMENT' 等环境变量。 你需要拥有 Zoho Creator 应用的访问权限并获取相应的 OAuth 凭据。

服务器配置 (MCP 客户端配置)

要将此 MCP 服务器添加到 MCP 客户端(例如 Claude),你需要配置服务器启动命令。以下是配置示例,以 Claude Desktop 为例:

"mcpServers": {
  "scaflog-zoho-mcp-server": {
    "command": "uv",
    "args": [
      "--directory",
      "/path/to/scaflog-zoho-mcp-server", // 替换为你的仓库本地路径
      "run",
      "src/scaflog_zoho_mcp_server"
    ]
  }
}

配置参数说明:

  • '"scaflog-zoho-mcp-server"': 服务器名称,在 MCP 客户端中用于标识此服务器。
  • '"command": "uv"': 启动服务器的命令,这里使用 'uv' 包管理器。
  • '"args"': 传递给 'uv' 命令的参数列表:
    • '"--directory"': 指定服务器代码所在的目录,需要替换为你的 'scaflog-zoho-mcp-server' 仓库的本地绝对路径。
    • '"run"': 'uv run' 子命令用于运行 Python 模块。
    • '"src/scaflog_zoho_mcp_server"': 指定要运行的 Python 模块是 'src/scaflog_zoho_mcp_server',即服务器的入口点。

基本使用方法

  1. 启动 MCP 服务器:根据上述配置,MCP 客户端(如 Claude)应该能够自动启动并连接到 'scaflog-zoho-mcp-server'。
  2. 在 LLM 中访问 Zoho Creator 数据:在 LLM 客户端中,你可以使用与 MCP 协议兼容的方式,引用和查询 Zoho Creator 中暴露的表单和报表数据。具体的访问方式取决于 LLM 客户端的功能和界面。例如,在 Claude 中,你可能可以使用特定的指令或界面操作来访问和利用 MCP 服务器提供的资源。

信息

分类

商业系统