使用说明
Zendesk MCP 服务器
一个全面的MCP服务器,用于通过多种工具和操作管理Zendesk工单。
🚀 快速入门
1. 安装依赖项
pip install -r requirements.txt
2. 配置环境
创建一个 .env 附上您的 Zendesk 凭据文件:
ZENDESK_SUBDOMAIN=your-company-name
ZENDESK_EMAIL=your-email@company.com
ZENDESK_API_TOKEN=your-api-token
3. 获取您的Zendesk API令牌
- 前往你的 Zendesk 管理中心
- 导航至 应用程序和集成 → Zendesk API(Zendesk应用程序编程接口)
- 启用 令牌访问 并生成一个新的API令牌
- 将令牌复制到您的
.env文件
4. 启动服务器
python main.py
🧪 测试
使用MCP检查器测试您的工具:
npx @modelcontextprotocol/inspector
🛠️ 可用工具
创建工单
创建一个新的支持工单。
参数:
subject(必填):票据标题description(必填):详细描述priority(可选):low,normal,high,urgent(默认:normal)
示例:
{
"subject": "Printer not working",
"description": "The office printer is showing error code E001",
"priority": "high"
}
更新票据/票务信息
更新现有工单。
参数:
ticket_id(必填):要更新的票据的IDstatus(可选):new,open,pending,hold,solved,closedpriority(可选):low,normal,high,urgentcomment(可选):在工单中添加评论
示例:
{
"ticket_id": 12345,
"status": "solved",
"comment": "Issue resolved by restarting the printer"
}
删除票据
删除特定工单。
获取单张门票
检索特定票据的详细信息。
获取所有票据
列出所有票据,并支持分页。
搜索票据
根据各种标准搜索票据。
列出用户
获取Zendesk用户的列表。
添加评论
在现有工单中添加评论。
📁 文件结构
zendesk-mcp-server/
├── main.py # MCP server entry point
├── config.py # Configuration management
├── utils/
│ ├── __init__.py
│ └── client.py # Zendesk API client
├── tools/
│ ├── __init__.py
│ ├── create_ticket.py # Create ticket tool
│ ├── update_ticket.py # Update ticket tool
│ ├── delete_ticket.py # Delete ticket tool
│ ├── get_single_ticket.py # Get single ticket tool
│ ├── get_all_tickets.py # Get all tickets tool
│ ├── search_tickets.py # Search tickets tool
│ ├── list_users.py # List users tool
│ └── add_comment.py # Add comment tool
├── requirements.txt # Dependencies
├── .env # Environment variables (create this)
└── README.md # This file
📋 要求
- Python 3.8或更高版本
- 有效的Zendesk账户,需具备API访问权限
- Zendesk API令牌