使用说明

项目简介

RTC MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在为 AI 模型提供与阿里云实时计算 Apache Flink 服务交互的标准接口。通过该服务器,AI 模型可以方便地管理 Flink 集群、作业、部署等资源,并执行 SQL 语句,从而实现对阿里云 Flink 服务的智能化操作。

主要功能点

  • 管理阿里云实时计算 Flink 集群的创建和管理。
  • 管理 Flink SQL 作业和 Flink 应用的部署、启动、停止和删除。
  • 监控 Flink 作业的状态和性能指标。
  • 创建和管理 Flink 作业的 Savepoint,用于作业恢复和迁移。
  • 提供工作区和命名空间管理,方便资源隔离和组织。
  • 提供丰富的工具集,包括作业管理、部署管理、变量管理、工作区管理和 Catalog 操作等,以支持多样化的 Flink 资源操作需求。

安装步骤

  1. 环境准备: 确保已安装 JDK 17 或更高版本,以及 Maven 3.6 或更高版本。
  2. 代码获取: 克隆仓库代码到本地:'git clone https://github.com/gnuhpc/rtc-mcp-server.git'
  3. 项目打包: 进入项目根目录 'rtc-mcp-server',使用 Maven 打包项目:'mvn clean package'。打包成功后,将在 'target' 目录下生成 'rtc-mcp-server-1.0-SNAPSHOT.jar' 文件。

服务器配置

MCP 客户端需要配置以下 JSON 文件以连接到 RTC MCP Server。请根据实际部署路径替换 '/path/to/rtc-mcp-server',并填入您的阿里云 Access Key ID 和 Secret。

{
  "mcpServers": {
    "rtc-mcp-server": {  // 服务器名称,客户端用此名称引用
      "command": "java",  // 启动服务器的命令,这里是 Java
      "args": [          // 启动参数
        "-Dtransport.mode=stdio", // 设置传输模式为 stdio,用于命令行交互,方便开发和测试
        "-Dspring.main.web-application-type=none", // 关闭 Web 应用特性,简化服务器运行,降低资源消耗
        "-Dspring.main.banner-mode=off", // 关闭 Spring Boot 启动 Banner,使日志输出更简洁
        "-Dlogging.file.name=/path/to/rtc-mcp-server/mcpserver.log", // 指定日志文件路径,方便问题排查和日志分析
        "-jar",        // 运行 JAR 文件
        "/path/to/rtc-mcp-server/target/rtc-mcp-server-1.0-SNAPSHOT.jar" // 服务器 JAR 文件路径,**请替换为实际部署路径**
      ],
      "env": {          // 环境变量配置
        "ALIYUN_ACCESS_KEY_ID": "your-access-key-id", // 阿里云 Access Key ID,**请替换为您的阿里云 Access Key ID**
        "ALIYUN_ACCESS_KEY_SECRET": "your-access-key-secret" // 阿里云 Access Key Secret,**请替换为您的阿里云 Access Key Secret**
      },
      "disabled": false, // 设置为 false 表示启用此服务器,true 则禁用
      "autoApprove": []  // 自动批准的工具列表,配置为空表示所有工具调用都需要手动批准
    }
  }
}

基本使用方法

  1. 启动服务器: 根据您的需求选择合适的运行命令启动 RTC MCP Server。例如,在开发测试阶段可以使用 stdio 模式:
    java -Dtransport.mode=stdio -Dspring.main.web-application-type=none -jar target/rtc-mcp-server-1.0-SNAPSHOT.jar
    在生产环境或需要 Web 服务能力时,可以使用默认的 webflux 模式:
    java -jar target/rtc-mcp-server-1.0-SNAPSHOT.jar
  2. 客户端配置: 在 MCP 客户端应用中,配置上述 JSON 内容,将 RTC MCP Server 添加到可用的 MCP 服务器列表中。
  3. 调用工具: 客户端通过 MCP 协议与 RTC MCP Server 建立连接后,即可调用服务器提供的各种工具,例如 'start_job'、'create_deployment'、'execute_sql_statement' 等,实现对阿里云实时计算 Flink 资源的智能化管理和操作。具体的工具列表和使用方法请参考仓库 README 或相关文档。

信息

分类

AI与计算