关键词

Zendesk工单管理知识库客服LLM工具

Zendesk MCP Server 使用说明

项目简介

Zendesk MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端，专门为 Zendesk 平台设计。它允许大型语言模型 (LLM) 客户端通过标准化的 MCP 协议，安全、便捷地访问和操作 Zendesk 中的数据和功能。该服务器集成了 Zendesk 的工单管理、知识库访问等能力，并提供预定义的 Prompt 模板和工具，帮助 LLM 更好地理解和处理 Zendesk 的业务场景，例如工单分析、回复草拟、知识库检索等。

主要功能点

  • 资源 (Resources):
    • 提供对 Zendesk 知识库 (Help Center articles) 的访问，允许 LLM 获取最新的帮助文档和知识内容，作为上下文信息使用。
    • 通过 'zendesk://knowledge-base' URI 访问整个知识库资源。
  • 工具 (Tools):
    • get_ticket: 根据工单 ID 获取 Zendesk 工单的详细信息，包括主题、描述、状态、创建时间等。
    • get_ticket_comments: 获取指定工单的所有评论，包括作者、评论内容、公开性等信息，用于理解工单的上下文对话。
    • create_ticket_comment: 在指定的 Zendesk 工单上创建新的评论，支持公开或私有评论，允许 LLM 与 Zendesk 系统进行交互，例如回复客户或内部备注。
  • Prompt 模板 (Prompts):
    • analyze-ticket: 用于分析 Zendesk 工单，提取关键信息，例如问题概要、状态时间线、交互要点等，帮助 LLM 理解工单内容。
    • draft-ticket-response: 用于草拟 Zendesk 工单的回复，基于工单信息、评论和知识库内容，生成专业且有帮助的回复草稿，提高客服效率。

安装步骤

  1. 克隆仓库: 将 Zendesk MCP Server 仓库克隆到本地： 
    git clone https://github.com/reminia/zendesk-mcp-server
cd zendesk-mcp-server
  2. 构建项目: 使用 'uv' 工具创建虚拟环境并安装项目依赖： 
    uv venv
uv pip install -e .
    或者使用简化的命令 'uv build'。
  3. 配置 Zendesk 凭证:
    • 复制 '.env.example' 文件并重命名为 '.env'。
    • 根据 '.env.example' 中的说明，填写你的 Zendesk 子域名 (ZENDESK_SUBDOMAIN)、邮箱 (ZENDESK_EMAIL) 和 API 密钥 (ZENDESK_API_KEY)。
      • 注意: 你需要拥有 Zendesk API 的访问权限并生成 API 密钥。

服务器配置

为了让 MCP 客户端（例如 Claude）连接到 Zendesk MCP Server，需要在客户端中配置服务器信息。以下是针对 Claude Desktop 的配置示例，其他 MCP 客户端的配置方式类似：

{
  "mcpServers": {
      "zendesk": {
          "command": "uv",
          "args": [
              "--directory",
              "/path/to/zendesk-mcp-server",
              "run",
              "zendesk"
          ]
      }
  }
}

配置参数说明:

  • '"mcpServers"': 定义 MCP 服务器配置的顶级键。
  • '"zendesk"': 为该 Zendesk MCP Server 定义的服务器名称，可以自定义。
  • '"command": "uv"': 指定用于启动服务器的命令，这里使用 'uv'，确保你的系统已安装 'uv' 工具。
  • '"args"': 启动服务器命令的参数列表。
    • '"--directory"': 指定服务器代码所在的目录，需要替换 '/path/to/zendesk-mcp-server' 为你本地 Zendesk MCP Server 仓库的绝对路径。
    • '"run"': 'uv' 命令的子命令，用于运行 Python 模块或包。
    • '"zendesk"': 作为参数传递给 'uv run'，实际执行 'zendesk_mcp_server' 包中的 'main' 函数 (定义在 'src/zendesk_mcp_server/init.py' 中)，从而启动 Zendesk MCP Server。

确保将 '/path/to/zendesk-mcp-server' 替换为你实际的仓库路径。

基本使用方法

  1. 启动服务器: 配置完成后，当 MCP 客户端尝试连接名为 "zendesk" 的 MCP 服务器时，客户端会根据配置执行 'uv --directory /path/to/zendesk-mcp-server run zendesk' 命令来启动 Zendesk MCP Server。
  2. 客户端交互: 在 MCP 客户端中，你可以：
    • 使用 'zendesk://knowledge-base' URI 访问 Zendesk 知识库资源。
    • 调用 'get_ticket', 'get_ticket_comments', 'create_ticket_comment' 工具来管理 Zendesk 工单。
    • 使用 'analyze-ticket' 和 'draft-ticket-response' Prompt 模板来分析和处理 Zendesk 工单。

注意: 你需要确保 Zendesk 凭证配置正确，并且你的 Zendesk 账号拥有相应的 API 访问权限，服务器才能正常连接和操作 Zendesk 数据。

信息

分类

商业系统

访问项目