Zendesk数据查询服务器

由CData提供的Zendesk-MCP服务器

CData为Zendesk提供的模型上下文协议（MCP）服务器

⚠️ 该项目构建了一个本地的、只读的MCP服务器。如需完全远程访问MCP，请查看首个托管MCP平台： CData Connect AI对于本地托管、具备全面读取、写入、更新、删除及操作功能，并且设置简便的方案，请查看我们的 用于Zendesk的CData MCP服务器。

目的

我们创建了这个只读的MCP服务器，以允许大型语言模型（如Claude Desktop）查询Zendesk支持的实时数据 CData JDBC驱动程序（适用于Zendesk）。

CData JDBC 驱动程序通过将 Zendesk 暴露为关系型 SQL 模型来连接到 Zendesk。

这个服务器封装了该驱动程序，并通过一个简单的MCP接口提供Zendesk数据，因此大型语言模型（LLMs）可以通过自然语言提问来检索实时信息，无需使用SQL。

设置指南

1. 克隆仓库：
   复制

   git clone https://github.com/cdatasoftware/zendesk-mcp-server-by-cdata.git
   cd zendesk-mcp-server-by-cdata
   

2. 构建服务器：
   复制

   mvn clean install
   

   这会生成一个JAR文件：CDataMCP-jar-with-dependencies.jar
3. 下载并安装适用于{源}的CData JDBC驱动程序： https://www.cdata.com/drivers/zendesk/download/jdbc 的中文翻译为：“https://www.cdata.com/驱动程序/Zendesk/下载/JDBC”
4. 许可CData JDBC驱动程序：
   • 导航至 lib 安装目录中的文件夹，通常为：
     • （Windows） C:\Program Files\CData\CData JDBC Driver for Zendesk\
     • (Mac/Linux) /Applications/CData JDBC Driver for Zendesk/
   • 运行该命令 java -jar cdata.jdbc.zendesk.jar --license
   • 请输入您的姓名、电子邮件以及“TRIAL”（或您的许可证密钥）。
5. 配置您与数据源的连接（以Salesforce为例）：

   • 运行该命令 java -jar cdata.jdbc.zendesk.jar 打开连接字符串实用程序。

   • 配置连接字符串，然后点击“测试连接”

     注： 如果数据源使用OAuth，您需要在浏览器中进行身份验证。

   • 一旦成功，复制连接字符串以便稍后使用。

6. 创建一个 .prp 为您的JDBC连接准备文件（例如。 zendesk.prp) 使用以下属性和格式：
   • 前缀 - 用于公开工具的前缀
   • 服务器名称 - 您服务器的名称
   • 服务器版本 - 适用于您服务器的版本
   • 驱动程序路径 - 您的JDBC驱动程序JAR文件的完整路径
   • 驱动程序类 - JDBC驱动程序类的名称（例如：cdata.jdbc.zendesk.ZendeskDriver）
   • JdbcUrl（Java数据库连接统一资源定位符） - 用于连接到您的数据的CData JDBC驱动程序的JDBC连接字符串（从上面复制）
   • 桌子 - 留空以访问所有数据，否则您可以明确声明您希望创建访问权限的表
     复制

     Prefix=zendesk
     ServerName=CDataZendesk
     ServerVersion=1.0
     DriverPath=PATH\TO\cdata.jdbc.zendesk.jar
     DriverClass=cdata.jdbc.zendesk.ZendeskDriver
     JdbcUrl=jdbc:zendesk:InitiateOAuth=GETANDREFRESH;
     Tables=
     

使用Claude Desktop连接服务器

1. 创建Claude Desktop的配置文件（claude_desktop_config.json）以添加新的MCP服务器，使用以下格式。如果文件已存在，请在其中添加条目 mcpServers 在配置文件中。

   Windows

   复制

   {
     "mcpServers": {
       "{classname_dash}": {
         "command": "PATH\\TO\\java.exe",
         "args": [
           "-jar",
           "PATH\\TO\\CDataMCP-jar-with-dependencies.jar",
           "PATH\\TO\\zendesk.prp"
         ]
       },
       ...
     }
   }
   

   Linux/苹果电脑（Mac）

   复制

   {
     "mcpServers": {
       "{classname_dash}": {
         "command": "/PATH/TO/java",
         "args": [
           "-jar",
           "/PATH/TO/CDataMCP-jar-with-dependencies.jar",
           "/PATH/TO/zendesk.prp"
         ]
       },
       ...
     }
   }
   

   如有需要，请将配置文件复制到相应的目录（以Claude Desktop为例）。 Windows

   复制

   cp C:\PATH\TO\claude_desktop_config.json %APPDATA%\Claude\claude_desktop_config.json
   

   Linux/麦金塔（Mac）

   复制

   cp /PATH/TO/claude_desktop_config.json /Users/{user}/Library/Application\ Support/Claude/claude_desktop_config.json'
   

2. 运行或刷新您的客户端（Claude Desktop）。

注： 您可能需要完全退出或关闭您的Claude桌面客户端，然后重新打开它，以便MCP服务器能够显示出来。

运行服务器

1. 运行以下命令以单独启动MCP服务器
   复制

   java -jar /PATH/TO/CDataMCP-jar-with-dependencies.jar /PATH/TO/Salesforce.prp
   

注： 服务器使用 stdio 因此，只能与运行在同一台机器上的客户端一起使用。

使用详情

一旦配置好MCP服务器，AI客户端将能够使用内置工具来读取、写入、更新和删除底层数据。通常情况下，你无需显式调用这些工具。只需让客户端回答有关底层数据系统的问题即可。例如：

• “我已成交的潜在客户与账户所属行业之间有何关联？”
• “我在SUPPORT项目中有多少张未解决的工单？”
• “你能告诉我我今天有哪些日历事件吗？”

以下列出了可用的工具及其描述：

工具与说明

在以下定义中， {servername} 指的是配置文件中MCP服务器的名称（例如。 {classname_dash} （见上文）。

• {servername}_get_tables - 从数据源中检索可用的表列表。使用 {servername}_get_columns 工具用于列出表中可用的列。该工具的输出将以CSV格式返回，第一行包含列标题。
• {servername}_get_columns - 获取表的列列表。使用 {servername}_get_tables 工具用于获取可用表的列表。该工具的输出将以CSV格式返回，第一行包含列标题。
• {servername}_run_query - 执行SQL SELECT查询

JSON-RPC 请求示例

如果你是通过脚本发送请求到MCP服务器，而不是使用AI客户端（例如Claude），那么在调用可用工具时，可以参考以下遵循JSON-RPC 2.0规范的JSON有效载荷示例。

获取Zendesk中的表（或“获取Zendesk的表格”）

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
        "name": "zendesk_get_tables",
        "arguments": {}
    }
}

获取Zendesk的列（或字段）

{
    "jsonrpc": "2.0",
    "id": 2,
    "method": "tools/call",
    "params": {
        "name": "zendesk_get_columns",
        "arguments": {
            "table":  "Account"
        }
    }
}

执行Zendesk查询

{
    "jsonrpc": "2.0",
    "id": 3,
    "method": "tools/call",
    "params": {
        "name": "zendesk_run_query",
        "arguments": {
            "sql":  "SELECT * FROM [Account] WHERE [IsDeleted] = true"
        }
    }
}

故障排除

1. 如果你在Claude Desktop中看不到你的CData MCP服务器，请确保你已完全退出Claude Desktop（Windows系统：使用任务管理器；Mac系统：使用活动监视器）
2. 如果Claude Desktop无法检索数据，请确保您已正确配置了连接。使用连接字符串生成器创建连接字符串（见上文），然后将连接字符串复制到属性（.prp）文件中。
3. 如果您在连接数据源时遇到问题，请联系 CData 支持团队。
4. 如果您在使用MCP服务器时遇到问题，或有任何其他反馈，请加入 CData 社区。

许可证

这个MCP服务器是根据MIT许可证授权的。这意味着您可以在遵守MIT许可证条款和条件的前提下，自由地使用、修改和分发该软件。如需了解更多详情，请参阅（相关文件或链接） 许可证 项目仓库中的文件。

所有支持的来源