使用说明
Zendesk MCP服务器
模型上下文协议服务器,将AI助手连接到Zendesk,支持对支持票、帮助文章和客户反馈进行自然语言查询。
在中使用AI搜索您的Zendesk数据 光标, Claude桌面版,或任何MCP兼容工具。
特性
- 🔍 搜索支持票 -使用高级过滤器(状态、标签、日期、优先级)查询门票
- 📚 搜索知识库 -查找相关帮助文章和文档
- 📊 特征反馈分析 -获取有关特定功能的全面反馈,包括错误报告、功能请求和支持问题
- 🎫 门票详细信息 -检索完整的门票信息,包括所有评论
- 📖 文章内容 -访问完整的帮助中心文章
- 🏷️ 基于标签的搜索 -查找所有带有特定标签的门票
安装
选项1:通过npx使用(推荐)
无需安装!只需配置和使用:
{
"mcpServers": {
"zendesk": {
"command": "npx",
"args": ["-y", "zendesk-mcp-server"],
"env": {
"ZENDESK_SUBDOMAIN": "your-company",
"ZENDESK_EMAIL": "your-email@company.com",
"ZENDESK_API_TOKEN": "your-api-token-here"
}
}
}
}
选项2:全局安装
npm install -g zendesk-mcp-server
然后配置:
{
"mcpServers": {
"zendesk": {
"command": "zendesk-mcp-server",
"env": {
"ZENDESK_SUBDOMAIN": "your-company",
"ZENDESK_EMAIL": "your-email@company.com",
"ZENDESK_API_TOKEN": "your-api-token-here"
}
}
}
}
方案3:地方发展
git clone https://github.com/wlaubernds/zendesk-mcp-server.git
cd zendesk-mcp-server
npm install
npm run build
然后在配置中使用本地路径:
{
"mcpServers": {
"zendesk": {
"command": "node",
"args": ["/path/to/zendesk-mcp-server/dist/index.js"],
"env": {
"ZENDESK_SUBDOMAIN": "your-company",
"ZENDESK_EMAIL": "your-email@company.com",
"ZENDESK_API_TOKEN": "your-api-token-here"
}
}
}
}
获取您的Zendesk API证书
- 登录您的Zendesk管理中心
- 引导到 应用程序和集成 > 应用程序编程接口 > 中国API
- 点击 设置 标签
- 在...之下 令牌访问,单击 添加API令牌
- 给它一个描述(例如,“MCP服务器”)
- 复制令牌(您只会看到一次!)
- 您的子域是Zendesk URL的第一部分:
https://YOUR-SUBDOMAIN.zendesk.com
配置
将配置添加到MCP设置文件中:
- 光标:
~/.cursor/mcp.json - Claude桌面版:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - 窗户:
%APPDATA%\Claude\claude_desktop_config.json
- macOS:
看 examples/cursor-config.json 举一个完整的例子。
用法
配置后,您可以使用自然语言查询Zendesk数据:
查询示例
分析功能反馈:
"Show me all feedback about our mobile app from the last 3 months"
搜索门票:
"Find all high priority bug reports from this week"
"What are users saying about the new dashboard?"
周末总结:
"Summarize all tickets from this weekend"
具体门票详情:
"Get full details and comments for ticket #12345"
搜索帮助文章:
"Find all help articles about password reset"
可用工具
MCP服务器提供了AI助手可以使用的这些工具:
| 工具 | 说明 |
|---|---|
search_tickets |
使用高级查询语法(状态、优先级、标签、日期)搜索门票 |
get_ticket |
获取特定票证的完整详细信息,包括所有评论 |
search_articles |
搜索帮助中心文章 |
get_article |
获取特定文章的完整内容 |
search_feature_feedback |
对特定功能的反馈进行全面分析 |
get_tickets_by_tag |
获取带有特定标签的所有门票 |
Zendesk查询语法
在搜索门票时,您可以使用以下过滤器:
status:-新建、打开、待定、保留、已解决、已关闭priority:-低、正常、高、紧急tags:-车票标签subject:-在主题行中搜索created>或created<-日期过滤器(格式:YYYY-MM-DD)updated>或updated<-最后更新日期- 用于全文搜索的纯文本
查询示例:
status:open tags:bug priority:high
tags:mobile created>2024-01-01
subject:"cannot login" priority:urgent
password reset
权限
🔒 此MCP服务器为只读 -它对Zendesk没有写权限。
✅ 它能做什么:
- 搜索并阅读支持票
- 检索门票详细信息和评论
- 搜索知识库文章
- 分析功能反馈
- 按标签、状态、优先级、日期查询门票
❌ 它不能做什么:
- 创建工单
- 更新或修改工单
- 为门票添加评论
- 更改票证状态
- 修改标签、优先级或分配
- 创建或编辑帮助文章
- 删除任何内容
这种只读设计使其可以安全地与共享的API令牌一起用于分析和报告目的。
API费率限制
Zendesk强制执行API费率限制:
- 专业计划:每分钟700个请求
- 团队计划:每分钟400个请求
服务器内部没有实现速率限制,因此在进行大型查询时要注意。
故障排除
“错误:缺少必需的环境变量”
确保在MCP配置中设置了所有三个环境变量:
ZENDESK_SUBDOMAINZENDESK_EMAILZENDESK_API_TOKEN
“Zendesk API错误(401)”
- 检查您的电子邮件和API令牌是否正确
- 验证API令牌未在Zendesk中被吊销
- 确保使用正确的身份验证格式
“Zendesk API错误(404)”
- 验证您的子域是否正确
- 检查票/物品ID是否存在
服务器未出现在游标中
- 确保在添加配置后已完全重新启动Cursor
- 检查路径是否正确
mcp.json正确(如果使用本地安装) - 验证配置文件中的JSON语法是否有效
发展
建筑
npm run build
观看模式
npm run watch
本地运行
npm run dev
确保设置环境变量:
export ZENDESK_SUBDOMAIN=your-company
export ZENDESK_EMAIL=your-email@company.com
export ZENDESK_API_TOKEN=your-api-token
npm run dev
贡献
欢迎投稿!请随时提交拉取请求。
- 分叉存储库
- 创建功能分支(
git checkout -b feature/amazing-feature) - 提交您的更改(
git commit -m 'Add some amazing feature') - 推到分支(
git push origin feature/amazing-feature) - 打开拉取请求
许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
安全
⚠️ 永远不要将您的API令牌提交到版本控制!
您的MCP配置文件应保持在计算机本地,不得共享或提交给git。
致谢
与 模型上下文协议SDK 通过Anthropic。
相关项目
支持
如果您遇到任何问题或有疑问: