API驱动MCP服务器

CData提供的API驱动MCP服务器

CData的API驱动程序模型上下文协议（MCP）服务器

⚠️ 此项目构建了一个只读的MCP服务器。如需完整的读、写、更新、删除及执行操作功能，并享受简化的设置过程，请查看我们的 CData MCP 服务器用于 API 驱动程序.

目的

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

CData JDBC驱动程序通过将它们作为关系型SQL模型暴露出来，连接到API驱动程序。

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

安装指南

1. 克隆仓库：
   复制

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

2. 构建服务器：
   复制

   mvn clean install
   

   这会生成一个JAR文件：CDataMCP-jar-with-dependencies.jar
3. 下载并安装CData JDBC驱动程序以连接到{源}： https://www.cdata.com/drivers/apidriver/download/jdbc 的中文翻译可以是：“https://www.cdata.com/驱动程序/API驱动程序/下载/JDBC”。不过，通常我们不会直接翻译网址，而是直接使用原网址或在中文语境下说明其含义。如果非要翻译，上述翻译是一种方式，但更多时候我们会直接引用网址或解释其指向的内容
4. 授权CData JDBC驱动程序：
   • 导航至 lib 安装目录中的文件夹，通常：
     • (Windows) C:\Program Files\CData\CData JDBC Driver for API Driver\
     • (Mac/Linux) /Applications/CData JDBC Driver for API Driver/
   • 运行该命令 java -jar cdata.jdbc.apidriver.jar --license
   • 请输入您的姓名、电子邮件和“TRIAL”（或您的许可证密钥）。
5. 配置您与数据源的连接（以Salesforce为例）：

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

   • 配置连接字符串并点击“测试连接”

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

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

6. 创建一个 .prp 为您的JDBC连接配置文件（例如。 api-driver.prp) 使用以下属性和格式：
   • 前缀 - 用于暴露的工具的前缀
   • 服务器名称 - 为您的服务器命名
   • 服务器版本 - 适用于您服务器的版本
   • 驱动程序路径 - 您的JDBC驱动程序JAR文件的完整路径
   • 驱动程序类 - JDBC驱动程序类的名称（例如：cdata.jdbc.apidriver.APIDriverDriver）
   • JdbcUrl（注：通常可直接译为“JDBC URL”，表示用于连接数据库的JDBC（Java Database Connectivity）字符串） - 使用CData JDBC驱动程序连接到您的数据时所需的JDBC连接字符串（从上方复制）
   • 桌子 - 留空以访问所有数据，否则您可以明确声明您希望创建访问权限的表
     复制

     Prefix=apidriver
     ServerName=CDataAPIDriver
     ServerVersion=1.0
     DriverPath=PATH\TO\cdata.jdbc.apidriver.jar
     DriverClass=cdata.jdbc.apidriver.APIDriverDriver
     JdbcUrl=jdbc:apidriver: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\\api-driver.prp"
         ]
       },
       ...
     }
   }
   

   Linux/苹果电脑（或Mac）

   复制

   {
     "mcpServers": {
       "{classname_dash}": {
         "command": "/PATH/TO/java",
         "args": [
           "-jar",
           "/PATH/TO/CDataMCP-jar-with-dependencies.jar",
           "/PATH/TO/api-driver.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 桌面版）。

注： 您可能需要完全退出或关闭您的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有效载荷示例。

获取数据源表

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

获取源列（或：获取数据源的列）

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

运行查询源

{
    "jsonrpc": "2.0",
    "id": 3,
    "method": "tools/call",
    "params": {
        "name": "source_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许可证条款和条件的前提下，自由地使用、修改和分发该软件。如需了解更多详情，请参阅（相关文档或链接） 许可证 项目存储库中的文件。

所有支持的来源