项目介绍
Zendesk API MCP 服务器
一个全面的模型上下文协议(MCP)服务器,用于与Zendesk API交互。此服务器提供了管理Zendesk Support、Talk、Chat和Guide产品的工具和资源。
## 功能
- 完整覆盖Zendesk API的功能
- 管理工单、用户、组织等的工具
- 访问Zendesk API文档的资源
- 使用Zendesk API令牌进行安全认证
## 快速开始
### 先决条件
- Node.js 14或更高版本
- 具有API访问权限的Zendesk账户
### 安装
1. 克隆此仓库
2. 安装依赖项:
```
npm install
```
3. 创建一个包含您的Zendesk凭证的`.env`文件:
```
ZENDESK_SUBDOMAIN=your-subdomain
ZENDESK_EMAIL=your-email@example.com
ZENDESK_API_TOKEN=your-api-token
```
### 运行服务器
启动服务器:
```
npm start
```
开发模式下自动重启:
```
npm run dev
```
### 使用MCP Inspector测试
使用MCP Inspector测试服务器:
```
npm run inspect
```
## 可用工具
### 工单
- `list_tickets`: 列出Zendesk中的工单
- `get_ticket`: 根据ID获取特定工单
- `create_ticket`: 创建新的工单
- `update_ticket`: 更新现有的工单
- `delete_ticket`: 删除工单
### 用户
- `list_users`: 列出Zendesk中的用户
- `get_user`: 根据ID获取特定用户
- `create_user`: 创建新的用户
- `update_user`: 更新现有的用户
- `delete_user`: 删除用户
### 组织
- `list_organizations`: 列出Zendesk中的组织
- `get_organization`: 根据ID获取特定组织
- `create_organization`: 创建新的组织
- `update_organization`: 更新现有的组织
- `delete_organization`: 删除组织
### 团队
- `list_groups`: 列出Zendesk中的代理团队
- `get_group`: 根据ID获取特定团队
- `create_group`: 创建新的代理团队
- `update_group`: 更新现有的团队
- `delete_group`: 删除团队
### 宏
- `list_macros`: 列出Zendesk中的宏
- `get_macro`: 根据ID获取特定宏
create_macro: 创建新的宏
- update_macro: 更新现有的宏
- delete_macro: 删除宏
### 视图
- `list_views`: 列出Zendesk中的视图
- `get_view`: 根据ID获取特定视图
- `create_view`: 创建新的视图
- `update_view`: 更新现有的视图
- `delete_view`: 删除视图
### 触发器
- `list_triggers`: 列出Zendesk中的触发器
- `get_trigger`: 根据ID获取特定触发器
- `create_trigger`: 创建新的触发器
- `update_trigger`: 更新现有的触发器
- `delete_trigger`: 删除触发器
### 自动化
- `list_automations`: 列出Zendesk中的自动化
- `get_automation`: 根据ID获取特定自动化
- `create_automation`: 创建新的自动化
- `update_automation`: 更新现有的自动化
- `delete_automation`: 删除自动化
### 搜索
- `search`: 在Zendesk数据中搜索
### 帮助中心
- `list_articles`: 列出帮助中心的文章
- `get_article`: 根据ID获取特定的帮助中心文章
- `create_article`: 创建新的帮助中心文章
- `update_article`: 更新现有的帮助中心文章
- `delete_article`: 删除帮助中心文章
### Talk
- `get_talk_stats`: 获取Zendesk Talk统计数据
### 聊天
- `list_chats`: 列出Zendesk聊天会话
## 可用资源
- `zendesk://docs/{section}`: 访问Zendesk API不同部分的文档
## 许可证
MIT