内容
# RTC MCP Server
一个用于管理阿里云实时计算(Realtime Compute)Apache Flink 资源的模型上下文协议(Model Context Protocol,MCP)服务器实现。该服务器为 AI 模型与阿里云 Flink 服务之间的交互提供了标准化接口。
## 特性
- 创建和管理 Flink 集群
- 创建和管理 Flink SQL 作业
- 部署和控制 Flink 应用程序
- 监控作业状态和指标
- 创建和管理保存点(savepoints)
- 列出和管理部署
- 工作区和命名空间管理
## 先决条件
- JDK 17 或更高版本
- Maven 3.6 或更高版本
- 拥有 RTC(Realtime Compute)访问权限的阿里云账户
- 阿里云访问密钥 ID 和密钥
## 客户端配置
要将此服务器用作 MCP 客户端,请将以下配置添加到您的 MCP 设置文件中(例如,`cline_mcp_settings.json`):
```json
{
"mcpServers": {
"rtc-mcp-server": {
"command": "java",
"args": [
"-Dtransport.mode=stdio",
"-Dspring.main.web-application-type=none",
"-Dspring.main.banner-mode=off",
"-Dlogging.file.name=/path/to/rtc-mcp-server/mcpserver.log",
"-jar",
"/path/to/rtc-mcp-server/target/rtc-mcp-server-1.0-SNAPSHOT.jar"
],
"env": {
"ALIYUN_ACCESS_KEY_ID": "your-access-key-id",
"ALIYUN_ACCESS_KEY_SECRET": "your-access-key-secret"
},
"disabled": false,
"autoApprove": []
}
}
}
```
将 `/path/to/rtc-mcp-server` 替换为您的实际服务器路径,并在环境变量中提供您的阿里云凭证。
## 可用工具
该服务器提供以下 MCP 工具:
1. **作业管理**
- `start_job`: 启动已部署的 Flink 作业
- `stop_job`: 停止正在运行的 Flink 作业
- `list_jobs`: 列出部署中的所有作业
- `delete_job`: 删除非运行中的作业
- `get_job_diagnosis`: 获取作业诊断信息
2. **部署管理**
- `create_deployment`: 创建新的 Flink 部署
- `get_deployment_metrics`: 获取部署指标
- `create_savepoint`: 为作业创建保存点
3. **变量管理**
- `create_variable`: 创建新变量
- `update_variable`: 更新现有变量
- `delete_variable`: 删除变量
- `list_variables`: 分页列出变量
4. **工作区管理**
- `create_workspace`: 创建新工作区
- `get_workspace_info`: 获取工作区信息
- `list_workspaces`: 列出所有工作区
5. **目录操作**
- `get_catalogs`: 获取目录信息
- `get_deployment_databases`: 获取数据库信息
- `get_tables`: 获取表信息
- `execute_sql_statement`: 执行 SQL 语句
## 构建和运行
1. 构建项目:
```bash
mvn clean package
```
2. 运行服务器:
```bash
java -jar target/rtc-mcp-server-1.0-SNAPSHOT.jar
```
对于使用 stdio 传输的开发模式:
```bash
java -Dtransport.mode=stdio -Dspring.main.web-application-type=none -jar target/rtc-mcp-server-1.0-SNAPSHOT.jar
```
## 服务器模式
该服务器支持多种传输模式:
- `webflux`: 默认模式,使用 Spring WebFlux
- `stdio`: 用于开发和测试的命令行模式
## 日志记录
日志在 application.yml 中配置,默认设置如下:
- 根级别:WARN
- 应用级别(com.rtc):INFO
- 日志文件每天轮换,并使用 GZIP 压缩
## 贡献
1. Fork 该仓库
2. 创建一个功能分支
3. 提交您的更改
4. 创建一个拉取请求
## 许可证
根据 Apache 许可证 2.0 版(“许可证”)授权;
除非遵守许可证,否则您不得使用此文件。
您可以在以下网址获取许可证的副本:
http://www.apache.org/licenses/LICENSE-2.0
除非适用法律要求或书面同意,否则根据许可证分发的软件按“原样”提供,
不附带任何形式的保证或条件,无论是明示还是暗示。
请参阅许可证以了解管理权限和限制的具体语言。