内容
# Zendesk 帮助中心 MCP 服务器
一个与 Zendesk 帮助中心 API 接口的模型上下文协议(MCP)服务器,允许与 Claude Desktop 和其他 MCP 兼容的客户端集成。
## 功能
- **文章搜索**:在您的 Zendesk 帮助中心搜索文章
- **文章详情**:通过 ID 检索特定文章的详细信息
## 前置条件
- Node.js(v18 或更高版本)
- 具有 API 访问权限的 Zendesk 账户
- Zendesk API 令牌
## 安装
1. 克隆此仓库:
```bash
git clone https://github.com/yourusername/zendesk-help-center-mcp-server.git
cd zendesk-help-center-mcp-server
```
2. 安装依赖项:
```bash
npm install
```
3. 在根目录中创建 `.env` 文件,并填写您的 Zendesk 凭证:
```
ZENDESK_SUBDOMAIN=your-subdomain
ZENDESK_EMAIL=your-email@example.com
ZENDESK_API_TOKEN=your-api-token
```
您可以复制 `.env.example` 文件并填写您的详细信息:
```bash
cp .env.example .env
```
## 构建和运行
1. 构建项目:
```bash
npm run build
```
2. 启动服务器:
```bash
npm start
```
服务器将在标准输入/输出上运行,使其与 Claude Desktop 和其他 MCP 客户端兼容。
## 可用工具
服务器提供以下工具:
### 1. searchArticles
在您的 Zendesk 帮助中心搜索文章。
**参数:**
- `query`(字符串,必填):搜索关键词
- `locale`(字符串,可选):区域代码(例如,'zh', 'en', 'zh-cn')
- `page`(数字,可选):页码
- `per_page`(数字,可选):每页结果数(最多 100)
### 2. getArticle
通过 ID 获取特定 Zendesk 帮助中心文章的详细信息。
**参数:**
- `id`(数字,必填):文章 ID
- `locale`(字符串,可选):区域代码(例如,'zh', 'en', 'zh-cn')
## 与 Claude Desktop 一起使用
### 添加到 Claude 的 `mcpServers` 配置
在 Claude 设置文件的 `mcpServers` 部分添加以下配置:
```json
{
"mcpServers": {
"zendeskHelpCenter": {
"command": "npx",
"args": ["-y", "github:hidechae/zendesk-help-center-mcp-server"],
"env": {
"ZENDESK_SUBDOMAIN": "your-subdomain",
"ZENDESK_EMAIL": "your-email@example.com",
"ZENDESK_API_TOKEN": "your-api-token"
}
}
}
}
```
添加此配置后,您可以在 Claude 中使用 Zendesk 帮助中心工具。
## 开发
该项目使用 TypeScript 并遵循模型上下文协议规范。
在开发模式下运行并自动重新加载:
```bash
npm run dev
```
## 许可证
MIT
## 贡献
欢迎贡献!请随时提交拉取请求。