项目简介

这是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在作为大型语言模型 (LLM) 客户端(如 Claude Desktop)与 Zendesk Help Center API 之间的桥梁。它允许 LLM 通过标准化协议访问 Zendesk 帮助中心的文章内容,从而增强 LLM 在客户支持、信息检索等场景下的能力。

主要功能点

  • 文章搜索: 允许 LLM 根据关键词搜索 Zendesk 帮助中心内的相关文章。
  • 文章详情获取: 允许 LLM 根据文章 ID 获取特定文章的详细内容,包括清理后的 HTML 正文。

安装步骤

  1. 确保您已安装 Node.js (v18 或更高版本)。
  2. 克隆此 GitHub 仓库到本地:
    git clone https://github.com/hidechae/zendesk-help-center-mcp-server.git
    cd zendesk-help-center-mcp-server
  3. 安装项目依赖:
    npm install
  4. 创建 '.env' 文件用于配置您的 Zendesk API 凭据。您可以复制 '.env.example' 文件并填写您的 Zendesk 子域名、电子邮件和 API 令牌:
    cp .env.example .env
    编辑 '.env' 文件,填入您的 Zendesk 信息:
    ZENDESK_SUBDOMAIN=您的Zendesk子域名
    ZENDESK_EMAIL=您的Zendesk注册邮箱
    ZENDESK_API_TOKEN=您的Zendesk API令牌
    DEFAULT_LOCALE=可选,默认语言区域,如 'en'

服务器配置 (用于MCP客户端)

要让支持 MCP 的 LLM 客户端使用此服务器,您需要在客户端的 MCP 服务器配置中添加以下信息。这通常是一个 JSON 格式的配置项。

  • 服务器名称: 自定义一个名称,例如 'zendeskHelpCenter'。
  • 启动命令 (command): 指定启动服务器的命令。推荐使用 'npx' 直接从 GitHub 仓库运行:'npx'
  • 命令参数 (args): 传递给启动命令的参数。对于 'npx' 从 GitHub 仓库运行,参数是仓库地址:'-y', 'github:hidechae/zendesk-help-center-mcp-server'
  • 环境变量 (env): 服务器运行所需的环境变量,特别是您的 Zendesk 凭据:'ZENDESK_SUBDOMAIN', 'ZENDESK_EMAIL', 'ZENDESK_API_TOKEN', 'DEFAULT_LOCALE' (可选)。

请参考您的 MCP 客户端文档,找到 MCP 服务器配置位置,并填入相应信息。例如,对于 Claude Desktop,您需要在其设置文件中找到 'mcpServers' 部分并添加一个条目。

基本使用方法

在 MCP 客户端中配置并成功连接此 Zendesk Help Center MCP 服务器后,LLM 就能够感知并使用服务器提供的工具。

您可以尝试向 LLM 发出如下指令(具体表达方式取决于 LLM):

  • “帮我搜索 Zendesk 帮助中心里关于‘重置密码’的文章。” (这会触发 'searchArticles' 工具)
  • “请获取 Zendesk 帮助中心 ID 为 12345 的文章详情。” (这会触发 'getArticle' 工具)

LLM 会通过 MCP 协议调用服务器上的相应工具,并将从 Zendesk 返回的结果呈现给您。

信息

分类

商业系统