zendesk-help-center-mcp-server

🚀 Zendesk 帮助中心 MCP 服务器

这是一个与 Zendesk 帮助中心 API 接口的 Model Context Protocol (MCP) 服务器，它允许与 Claude Desktop 以及其他兼容的 MCP 客户端集成，能有效提升信息搜索与获取的效率。

✨ 主要特性

• 文章搜索：可在你的 Zendesk 帮助中心中搜索文章。
• 文章详情：能通过 ID 获取特定文章的详细信息。

📦 安装指南

先决条件

• Node.js (v18 或更高版本)
• 一个具有 API 访问权限的 Zendesk 账户
• Zendesk API 令牌

安装步骤

1. 克隆此仓库：

   git clone https://github.com/yourusername/zendesk-help-center-mcp-server.git
   cd zendesk-help-center-mcp-server
   

2. 安装依赖项：

   npm install
   

3. 在根目录中创建一个 .env 文件，填入你的 Zendesk 凭据：

   ZENDESK_SUBDOMAIN=your-subdomain
   ZENDESK_EMAIL=your-email@example.com
   ZENDESK_API_TOKEN=your-api-token
   

你也可以复制 .env.example 文件并填写你的详细信息：

cp .env.example .env

💻 使用示例

构建和运行

1. 构建项目：

   npm run build
   

2. 启动服务器：

   npm start
   

该服务器将在标准输入/输出上运行，使其与 Claude Desktop 和其他 MCP 客户端兼容。

可用工具

1. searchArticles

在你的 Zendesk 帮助中心中搜索文章。 参数：

• query (string, 必填)：搜索关键词
• locale (string, 可选)：语言代码（例如，'en'，'ja'，'en-us'）
• page (number, 可选)：页码
• per_page (number, 可选)：每页结果数（最大 100）

2. getArticle

通过 ID 获取特定的 Zendesk 帮助中心文章的详细信息。 参数：

• id (number, 必填)：文章 ID
• locale (string, 可选)：语言代码（例如，'en'，'ja'，'en-us'）

与 Claude Desktop 使用

添加到 Claude 的 mcpServers 配置中

将以下配置添加到 Claude 设置文件的 mcpServers 部分：

{
  "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 并遵循 Model Context Protocol 规范。 要以开发模式运行并自动重新加载：

npm run dev

📄 许可证

本项目采用 MIT 许可证。

🤝 贡献

欢迎大家贡献代码！请随意提交 Pull Request。