zd-mcp-server

🚀 Zendesk MCP 集成设置指南

本指南详细介绍了如何进行 Zendesk MCP 集成的设置，帮助你快速搭建并使用相关功能。

📦 安装指南

仓库设置

1. 克隆仓库到本地：

   git clone https://your-repo-url/mcp-experiments.git
   cd mcp-experiments/zd-mcp-server
   

2. 安装项目所需的依赖项：

   npm install
   

3. 在开发环境中配置必要的环境变量：

   export ZENDESK_EMAIL="your-email@example.com"
   export ZENDESK_TOKEN="your-zendesk-api-token"
   export ZENDESK_SUBDOMAIN="your-zendesk-subdomain"
   

项目构建

1. 使用 TypeScript 构建项目，将 TypeScript 文件编译为 JavaScript 并输出到 dist 目录：

   npm run build
   

2. 开发过程中，可使用以下命令：

   npm run dev
   

在 Claude 桌面应用程序中安装

1. 更新 Claude 桌面配置文件 (claude_desktop_config.json)：

   {
     "tools": {
       "zendesk": {
         "command": "node",
         "env": {
           "ZENDESK_EMAIL": "internal@z3nmail.com",
           "ZENDESK_TOKEN": "your-zendesk-api-token",
           "ZENDESK_SUBDOMAIN": "your-zendesk-subdomain"
         },
         "args": [
           "/path/to/mcp-experiments/zd-mcp-server/dist/index.js"
         ]
       }
     }
   }
   

2. 用实际的 Zendesk 凭据替换配置文件中的环境变量。
3. 更新路径，使其匹配构建好的 index.js 文件的位置。
4. 重新启动 Claude 桌面应用程序，使更改生效。

💻 使用示例

可用的 Zendesk 工具

MCP Zendesk 集成提供了丰富的功能，以下是各工具的简要说明：

1. zendesk_get_ticket - 根据 ID 获取票务。
2. zendesk_get_ticket_details - 获取票务详细信息，包括评论。
3. zendesk_search - 使用 Zendesk 查询语法搜索票务。
4. zendesk_create_ticket - 创建新票务。
5. zendesk_update_ticket - 更新票务属性。
6. zendesk_add_private_note - 在票务中添加内部备注。
7. zendesk_add_public_note - 在票务中添加公共评论。

🔧 技术细节

认证设置

1. 在 Zendesk 管理中心生成 API 令牌：
   • 转到管理中心 > 应用和集成 > 应用程序 > Zendesk API。
   • 添加 API 令牌并复制它。
2. 在 MCP 配置中使用电子邮件地址和 API 令牌进行认证。

故障排除

• 若遇到授权错误，请验证 API 令牌是否有效。
• 确保 Zendesk 子域名正确。
• 检查环境变量是否设置正确。
• 修改配置后，重新启动 MCP 服务器。