AI导哈

Zendesk MCP服务器

一个连接Zendesk与大型语言模型（LLMs）的模型上下文协议（MCP）服务器，支持检索和操作Zendesk帮助中心文章，并与Claude Desktop等MCP兼容客户端无缝集成。

  • by ryo-vbmyyrs
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 ryo-vbmyyrs/zendesk-mcp-server

使用说明

Zendesk MCP 服务器

一个模型上下文协议（MCP）服务器，用于将Zendesk与大型语言模型（LLMs）连接起来。该服务器能够与Claude Desktop及其他MCP兼容客户端实现无缝集成，以便检索和操作Zendesk帮助中心的文章。

特点/功能

  • MCP 兼容完全符合模型上下文协议，实现大型语言模型（LLM）工具的无缝集成
  • TypeScript 实现类型安全的实现，确保可靠运行
  • Zendesk帮助中心集成文章检索与列表功能
  • 多语言支持针对特定区域的文章检索

目前已实现的功能

1. 获取文章（get_article）

  • 描述通过ID检索特定的Zendesk帮助中心文章
  • 参数：
    • article_id (数字)：要检索的文章的ID

2. 列出文章（list_articles)

  • 描述从Zendesk帮助中心检索文章列表
  • 参数：
    • locale （字符串，可选）：目标文章的语言环境（如果未指定，则使用默认语言环境）
    • sort_by （字符串，可选）：排序字段（位置、标题、创建时间、更新时间、编辑时间）
    • sort_order （字符串，可选）：排序顺序（升序，降序）

设置

先决条件

  • Node.js 18 或更高版本
  • npm 或 yarn
  • 具有API访问权限的Zendesk账户

安装

  1. 克隆仓库

    git clone <repository-url>
cd zendesk-mcp-server

  2. 安装依赖项

    npm install

  3. 环境配置

    设置以下环境变量：

    • ZENDESK_SUBDOMAIN（Zendesk子域） （必填）：您的 Zendesk 子域（例如。， yourcompany)
    • ZENDESK_EMAIL（可译为“Zendesk电子邮件”或根据上下文简化为“Zendesk邮箱”） （必填）：用于Zendesk API访问的电子邮件地址
    • ZENDESK_API_TOKEN （必需）：Zendesk API令牌
    • ZENDESK_DEFAULT_LOCALE 翻译为中文是：“Zendesk 默认区域设置” （可选）：默认区域设置（默认： ja)

    创建一个 .env 文件或设置为系统环境变量：

    # Example .env file
ZENDESK_SUBDOMAIN=yourcompany
ZENDESK_EMAIL=your-email@example.com
ZENDESK_API_TOKEN=your-api-token
ZENDESK_DEFAULT_LOCALE=ja

  4. 构建项目

    npm run build

获取Zendesk API令牌

  1. 登录到您的Zendesk管理面板
  2. 导航至设置 → API → Zendesk API
  3. 勾选“令牌访问”以启用它
  4. 创建一个新的API令牌并复制它

使用

建成后， dist/index.js 作为入口点。从MCP客户端（如Claude桌面版）运行：

node dist/index.js

发展

开发环境设置

# TypeScript watch mode
npm run build -- --watch

# Development execution (using tsx)
npx tsx src/index.ts

项目结构

src/
├── index.ts              # Main entry point
├── zendesk-client.ts     # Zendesk API client
├── tools/                # MCP tool implementations
│   ├── allTools.ts       # Tool definition aggregator
│   ├── getArticle.ts     # Article retrieval tool
│   └── listArticles.ts   # Article listing tool
└── types/                # Type definitions
    └── zendeskApi.ts     # Zendesk API type definitions

路线图

  • 票务操作（创建、更新、搜索）
  • 用户管理功能
  • 评论功能
  • 增强的搜索和过滤功能
  • 改进了错误处理

所使用的技术

  • TypeScript用于类型安全的开发
  • **MCP SDK（MCP软件开发工具包）**模型上下文协议实现
  • AxiosZendesk API 的 HTTP 客户端
  • 佐德模式验证
  • **dotenv（通常用于描述加载环境变量文件的工具或库）**环境变量管理

贡献；助力

欢迎提交拉取请求和报告问题！如果您有任何新功能或改进的想法，请随时联系我们。

注此项目尚处于早期开发阶段。请在生产环境中使用前进行彻底测试。

相关 MCP