使用说明

项目简介

本项目是一个基于Model Context Protocol (MCP) 的服务器示例，旨在演示如何将CData Connect Cloud数据连接平台集成到LLM应用中。通过此MCP服务器，LLM客户端（如Claude Desktop）可以连接到CData Connect Cloud，并利用其提供的工具执行SQL查询，以及检索数据库表信息。

主要功能点

执行SQL查询 (execute_query): 允许LLM客户端通过发送SQL查询语句，在CData Connect Cloud连接的数据源上执行查询，并获取查询结果。
列出数据表 (list_tables): 允许LLM客户端获取CData Connect Cloud中可用的数据表列表，并支持按目录名、模式名和表名进行过滤。

安装步骤

下载源代码: 从GitHub仓库下载源代码到本地目录。建议使用不包含空格和非英文字符的目录路径。
安装Node.js: 确保已安装Node.js 18 或更高版本。您可以从Node.js官网下载并安装：https://nodejs.org/
安装依赖: 在项目根目录下打开终端或命令提示符，运行以下命令安装项目依赖：
```
npm install
```
配置Claude Desktop应用 (如果使用Claude Desktop):
- 找到Claude Desktop应用的配置文件 'claude_desktop_config.json'。
- 在该文件中找到 '"mcpServers"' 部分，添加一个新的服务器配置项，配置信息如下：

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

以下是在MCP客户端 (例如 Claude Desktop 应用) 中配置此MCP服务器的示例 JSON 配置。您需要将此配置添加到您的 MCP 客户端的服务器列表中。

{
  "server name": "cdata-connect-cloud",  #  自定义的服务器名称，在客户端中用于标识
  "command": "node",                     #  启动服务器的命令，这里使用 node 运行 server.js
  "args": [                             #  启动命令的参数
    "[cdata-connect-cloud-mcp-serverを配置したパス]/server.js" #  server.js 脚本的绝对路径，请替换为实际路径
  ],
  "env": {                              #  环境变量配置
    "CDATA_CONNECT_CLOUD_CATALOG_NAME": "您的CData Connect Cloud连接名称", #  CData Connect Cloud 的连接名称 (Connection Name)
    "CDATA_CONNECT_CLOUD_USER": "您的CData Connect Cloud用户名",       #  CData Connect Cloud 用户名
    "CDATA_CONNECT_CLOUD_PAT": "您的CData Connect Cloud PAT"            #  CData Connect Cloud 个人访问令牌 (PAT)
  }
}

配置参数说明:

'"server name"': 为该MCP服务器配置一个名称，例如 '"cdata-connect-cloud"'，客户端将使用此名称来引用该服务器。
'"command"': 指定启动服务器的命令。由于该服务器是 Node.js 应用，所以这里设置为 '"node"'。
'"args"': 一个字符串数组，包含传递给启动命令的参数。
- '"[cdata-connect-cloud-mcp-serverを配置したパス]/server.js"': 请务必将此占位符替换为您实际将 'server.js' 文件存放的绝对路径。 这是指定 Node.js 运行 'server.js' 文件。
'"env"': 一个键值对对象，用于设置服务器运行所需的环境变量。
- '"CDATA_CONNECT_CLOUD_CATALOG_NAME"': 替换为您的 CData Connect Cloud 连接的名称 (Connection Name)。 这个连接定义了您要访问的数据源。
- '"CDATA_CONNECT_CLOUD_USER"': 替换为您的 CData Connect Cloud 用户名。 用于身份验证。
- '"CDATA_CONNECT_CLOUD_PAT"': 替换为您的 CData Connect Cloud 个人访问令牌 (Personal Access Token)。 用于安全地访问 CData Connect Cloud。您需要在 CData Connect Cloud 控制台中创建 PAT。

注意: 请确保您已在 CData Connect Cloud 中配置了相应的连接，并拥有有效的用户名和 PAT。

基本使用方法

启动MCP服务器: 无需手动启动 'server.js'，MCP客户端 (如 Claude Desktop) 会根据您在配置文件中提供的 '"command"' 和 '"args"' 自动启动服务器。
在MCP客户端中使用工具: 在支持MCP协议的LLM客户端中，配置并连接到名为 '"cdata-connect-cloud"' (或您在 '"server name"' 中设置的名称) 的MCP服务器后，您应该可以在客户端中看到并使用 'execute_query' 和 'list_tables' 这两个工具。
通过LLM调用工具: 根据LLM客户端的界面操作，您可以指示LLM使用 'execute_query' 工具执行SQL查询，或使用 'list_tables' 工具获取数据表列表。具体的调用方式取决于您使用的LLM客户端。

示例使用场景 (Claude Desktop):

在 Claude Desktop 中，您可以这样指示 Claude 调用工具：

"请使用 'execute_query' 工具查询 'SELECT * FROM Customers'"
"使用 'list_tables' 工具列出所有表"

LLM 接收到指令后，会调用 MCP 服务器提供的工具，并将结果返回给您。

关键词