关键词

Zendesk工单管理客户支持LLM集成工具集成

使用说明

项目简介

Zendesk MCP Server 是一个 MCP 服务器的实现，它扩展了 LLM 的能力，使其能够与 Zendesk 集成。通过此服务器，LLM 可以调用预定义的工具来查询、创建、更新和管理 Zendesk 工单，从而实现更智能的客户支持和工作流程自动化。

主要功能点

  • 工单管理工具: 提供了一系列工具，允许 LLM 应用程序执行以下 Zendesk 工单操作：
    • 获取工单详情 (zendesk_get_ticket, zendesk_get_ticket_details)
    • 搜索工单 (zendesk_search)
    • 创建工单 (zendesk_create_ticket)
    • 更新工单 (zendesk_update_ticket)
    • 添加内部备注 (zendesk_add_private_note)
    • 添加公开评论 (zendesk_add_public_note)
  • 基于 MCP 协议: 遵循 Model Context Protocol 标准，易于与任何兼容 MCP 客户端的 LLM 应用集成。
  • 可扩展的工具集: 基于 Zendesk API 构建，未来可以方便地扩展更多 Zendesk 相关工具。
  • 使用 Stdio 传输: 通过标准输入输出 (stdio) 与 MCP 客户端通信，部署和运行简单。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/koundinya/zd-mcp-server.git
cd zd-mcp-server

  2. 安装依赖: 确保已安装 Node.js 和 npm。运行以下命令安装项目依赖：

    npm install

  3. 配置环境变量: 需要设置 Zendesk API 访问凭据的环境变量。在运行服务器的环境中配置以下变量：

    • 'ZENDESK_EMAIL': 您的 Zendesk 管理员邮箱地址
    • 'ZENDESK_TOKEN': 您的 Zendesk API Token (需要在 Zendesk Admin Center 中生成)
    • 'ZENDESK_SUBDOMAIN': 您的 Zendesk 子域名 (例如，'yourcompany')

  4. 构建项目: 运行以下命令编译 TypeScript 代码：

    npm run build

    编译后的 JavaScript 文件将位于 'dist' 目录下。

服务器配置

要将 Zendesk MCP Server 集成到 MCP 客户端（例如 Claude Desktop App），您需要配置客户端以启动并连接到此服务器。以下是一个示例 'claude_desktop_config.json' 配置，展示了如何配置一个名为 "zendesk" 的工具：

{
  "tools": {
    "zendesk": {
      "serverName": "zendesk-mcp",
      "command": "node",
      "args": [
        "/path/to/zd-mcp-server/dist/index.js"
      ],
      "env": {
        "ZENDESK_EMAIL": "<您的 Zendesk 邮箱>",
        "ZENDESK_TOKEN": "<您的 Zendesk API Token>",
        "ZENDESK_SUBDOMAIN": "<您的 Zendesk 子域名>"
      }
    }
  }
}

配置参数说明:

  • 'serverName': 服务器名称，这里设置为 "zendesk-mcp"，用于在客户端中标识该服务器。
  • 'command': 启动服务器的命令，这里使用 'node' 来运行 JavaScript 文件。
  • 'args': 传递给 'command' 的参数，指向编译后的服务器入口文件 'dist/index.js' 的绝对路径。 请务必根据您的实际文件路径修改此参数。
  • 'env': 传递给服务器进程的环境变量。 请将 '<您的 Zendesk 邮箱>'、'<您的 Zendesk API Token>' 和 '<您的 Zendesk 子域名>' 替换为您的实际 Zendesk 凭据。 这些环境变量将被服务器用来连接 Zendesk API。

注意:

  • 请确保将 '/path/to/zd-mcp-server/dist/index.js' 替换为 'dist/index.js' 文件在您系统中的实际绝对路径。
  • MCP 客户端 (如 Claude Desktop App) 会读取此配置文件，并在需要时启动并与 Zendesk MCP Server 建立连接。

基本使用方法

配置完成后，您的 MCP 客户端（如 Claude）应该能够识别并调用 'zendesk' 工具下的各种 Zendesk 功能。 用户可以通过自然语言指令，指示 LLM 使用这些工具来完成与 Zendesk 工单相关的任务。

例如，在 Claude 中，您可以指示它：

  • "查询 Zendesk 工单 ID 为 123 的信息" (对应 'zendesk_get_ticket' 或 'zendesk_get_ticket_details' 工具)
  • "创建一个新的 Zendesk 工单，主题是 '用户登录问题'，描述是 '用户无法登录账户'" (对应 'zendesk_create_ticket' 工具)
  • "更新 Zendesk 工单 ID 为 456 的状态为 '已解决'" (对应 'zendesk_update_ticket' 工具)

LLM 将根据指令，自动调用相应的 Zendesk 工具，并将结果返回给用户。

信息

分类

商业系统

访问项目