Zoho Creator MCP

Zoho Creator MCP服务器

此存储库包含Zoho Creator的模型上下文协议（MCP）服务器实现，允许您通过模型上下文协议以编程方式与Zoho Creator应用程序交互。

概述

Zoho Creator MCP服务器充当实现模型上下文协议（如Claude）的人工智能助手与Zoho Creatorneneneba API之间的桥梁。这允许AI助手在您的Zoho Creator应用程序上执行操作，例如获取记录、更新数据等。

先决条件

• （v18或更高版本）
• （v8或更高版本）
• 具有API访问权限的Zoho创建者帐户
• Git

入门指南

克隆存储库

git clone https://github.com/kamal157/zoho-creator-mcp.git
cd zoho-creator-mcp

再进行

npm install

配置

1. 创建一个 .env 根目录中的文件，包含以下变量：

ZOHO_CLIENT_ID=your_client_id
ZOHO_CLIENT_SECRET=your_client_secret
ZOHO_REDIRECT_URI=http://localhost:3000/oauth/callback
ZOHO_ACCOUNT_OWNER=your_zoho_account_email
MCP_PORT=8000
ZOHO_ACCOUNTS_DOMAIN=https://accounts.zoho.in
ZOHO_API_DOMAIN=https://zohoapis.in/creator

替换 your_client_id 和 your_client_secret 使用您的Zoho API证书。

重要提示：

• ZOHO_ACCOUNT_OWNER 应设置为您的Zoho帐户电子邮件地址。这对于API访问至关重要。
• ZOHO_ACCOUNTS_DOMAIN 和 ZOHO_API_DOMAIN 是区域特定的。根据您的Zoho Creator域名修改它们：

- 我们： https://accounts.zoho.com 和 https://zohoapis.com/creator - 印度： https://accounts.zoho.in 和 https://zohoapis.in/creator - 欧洲： https://accounts.zoho.eu 和 https://zohoapis.eu/creator - 澳大利亚： https://accounts.zoho.com.au 和 https://zohoapis.com.au/creator - 其他：查看您所在地区的Zoho文档

1. 或者，您可以更新 .zoho-creator-credentials.json 文件中包含您的访问令牌信息。

设置Zoho Creator API访问

1. 转到 Zoho开发者控制台
2. 创建新客户端（基于服务器的客户端）
3. 将重定向URI设置为 http://localhost:3000/oauth/callback
4. 记下客户端ID和客户端密码
5. 将这些值添加到您的 .env 文件

运行服务器

发展模式

npm run dev

出于开发目的，这将使用ts节点运行服务器。

生产模式

npm run build
npm run start

build命令将TypeScript编译为JavaScript dist 目录，并启动运行编译后的代码。

身份验证流程

首次启动MCP服务器时：

1. 服务器将检测到您没有有效的身份验证令牌
2. 它将通过打开浏览器到Zoho授权页面来启动OAuth流

       node ./dist/zc-mcp-server.js -- auth

       or 

       npm run start -- auth

1. 复制终端上显示的URL并导航，系统将提示您登录Zoho帐户并授权应用程序
2. 授权后，Zoho将重定向到您的回调URL(http://localhost:3000/oauth/callback)
3. 服务器将处理回调，提取授权码，并将其交换为访问和刷新令牌
4. 这些令牌将存储在 .zoho-creator-credentials.json 文件以备将来使用

当您授权应用程序时，您将看到这样的屏幕：

Zoho Creator Authorization Screen

该应用程序将请求访问您的Zoho Creator数据的权限，包括：

• 获取仪表板应用程序列表
• 获取部分或组件列表
• 查看报告中的记录
• 在Creator应用程序中添加/修改/删除记录
• 读取表单元数据和选项

API终点

MCP服务器实现了以下模型上下文协议端点：

• POST /mcp/list_tools：列出Zoho Creator的可用工具
• POST /mcp/call_tool：调用特定的Zoho Creator工具

此外，服务器还提供：

• Zoho Creator的OAuth身份验证流程
• 令牌刷新机制

可用工具

服务器提供与Zoho Creator交互的工具，包括：

• 获取应用程序
• 获取表格和报告
• 检索、添加、更新和删除记录
• 获取字段元数据

验证过程

服务器通过OAuth 2.0自动处理身份验证：

1. 首次访问受保护的端点时，服务器将尝试使用存储的令牌
2. 如果令牌过期或丢失，服务器将启动OAuth流
3. 成功身份验证后，令牌将被保存以备将来使用

Zoho Creator MPC Authentication Flow

故障排除

常见问题

令牌到期

如果您遇到身份验证错误，您的令牌可能已过期。服务器应自动处理令牌刷新，但您可能需要偶尔重新进行身份验证。

API限值

注意Zoho创建者API的限制。如果遇到速率限制错误，请减少请求的频率。

许可证

此项目根据MIT许可证获得许可-有关详细信息，请参阅许可证文件。

与AI助手集成

GitHub Copilot

要与GitHub Copilot集成，请将以下配置添加到GitHub settings.json 文件：

"zoho-creator-mcp":{        
    "type": "sse",
    "url": "http://localhost:8000/mcp"
},

克劳德IDE

要与Claude IDE集成，请将以下配置添加到您的Claude设置中：

"mcp": {
  "providers": {
    "zoho-creator-mcp": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "http://localhost:8000/mcp"
      ]
    }
  }
}

致谢

• 模型上下文协议 对于SDK
• 百会创造者 API