使用说明

项目简介

本项目 'troccomcp' 是一个基于 Model Context Protocol (MCP) 标准构建的服务器，旨在作为 LLM (大型语言模型) 应用的后端，提供与 TROCCO API 交互的能力。通过实现 MCP 协议，该服务器允许 LLM 客户端以标准化的方式调用 TROCCO API 提供的各项功能，例如管理数据连接、定义和运行 Datamart 任务等。

主要功能点

连接管理: 提供列出 TROCCO 支持的各种数据连接类型的功能，例如 BigQuery、Snowflake、MySQL 等，帮助 LLM 应用获取可用的数据源信息。
Datamart 定义: 支持创建 TROCCO Datamart 定义，允许用户通过 LLM 客户端配置数据转换和处理逻辑，并在 TROCCO 平台上进行管理。
Datamart 任务执行: 能够触发 TROCCO Datamart 任务的运行，使得 LLM 应用可以驱动数据处理流程，获取分析结果或执行数据同步等操作。
MCP 协议标准: 完全遵循 MCP 协议规范，确保与任何兼容 MCP 协议的 LLM 客户端无缝对接。
Stdio 传输: 使用 Stdio (标准输入输出) 作为默认的传输协议，简化部署和集成过程。

安装步骤

环境准备: 确保你的开发环境中已安装 Node.js 和 npm (通常 Node.js 安装包会自带 npm)。

克隆仓库: 将 'troccomcp' 仓库克隆到本地：

git clone https://github.com/gtnao/troccomcp.git
cd troccomcp

安装依赖: 在仓库根目录下运行以下命令安装项目依赖：
```
npm install
```
构建项目: 运行以下命令构建项目，将 TypeScript 代码编译为 JavaScript：
```
npm run build
```

服务器配置

MCP 客户端需要配置 MCP 服务器的启动信息才能与之建立连接。以下是 'troccomcp' 服务器的典型配置示例，请根据你的实际环境进行调整：

{
  "mcpServers": {
    "trocco_server": {
      "command": "node",
      "args": [
        "<your_path>/troccomcp/build/index.js"
      ],
      "env": {
        "TROCCO_API_KEY": "<your_trocco_api_key>"
      }
    }
  }
}

'trocco_server': 为该 MCP 服务器自定义的名称，在客户端配置中用于唯一标识和引用该服务器。
'command': 启动服务器进程的命令，这里使用 'node' 命令来执行 JavaScript 文件。
'args': 传递给 'command' 的参数数组。
- '"<your_path>/troccomcp/build/index.js"': 指向构建后的 'index.js' 文件路径。请将 '<your_path>/troccomcp' 替换为 'troccomcp' 仓库在您本地文件系统中的绝对路径。例如，如果你的仓库在 '/Users/username/documents/troccomcp'，则应替换为 '/Users/username/documents/troccomcp/build/index.js'。
'env': 设置服务器运行时的环境变量。
- 'TROCCO_API_KEY': 必须配置。用于访问 TROCCO API 的 API 密钥。请将 '<your_trocco_api_key>' 替换为你从 TROCCO 平台获取的 真实 API 密钥。

注意: 请务必将 '<your_path>' 和 '<your_trocco_api_key>' 替换为实际的值。

基本使用方法

'troccomcp' 服务器启动后，会监听标准输入，等待接收来自 MCP 客户端的 JSON-RPC 请求。客户端可以通过发送符合 MCP 协议的请求来调用服务器提供的工具，例如：

列出连接: 调用 'list_connections' 工具并指定连接类型，例如 'bigquery'。
创建 Datamart: 调用 'create_datamart_definition' 工具并提供 Datamart 定义的详细参数。
运行 Datamart 任务: 调用 'run_datamart_job' 工具并指定要运行的 Datamart 定义 ID。

具体的请求格式和参数定义请参考 MCP 协议文档以及 'troccomcp' 项目中定义的工具 schema。客户端接收到服务器的 JSON-RPC 响应后，即可解析结果并进行后续处理。

简而言之，你需要配置好服务器启动命令和 TROCCO API 密钥，然后在 MCP 客户端中配置连接到该服务器，即可通过客户端调用 TROCCO 提供的各种数据服务能力。

关键词