README
🚀 阿里巴巴云实时计算 MCP 服务器
本项目是一个用于管理阿里巴巴云实时计算(Realtime Compute)Apache Flink 资源的 Model Context Protocol (MCP) 服务器实现。它为 AI 模型与 Alibaba Cloud Flink 服务的交互提供了标准化接口,极大地提升了资源管理的效率和便捷性。
🚀 快速开始
先决条件
- JDK 17 或更高版本
- Maven 3.6 或更高版本
- 配备 Alibaba Cloud 访问权限的阿里云账户(需具备 RTC 实时计算服务权限)
- 阿里巴巴云访问密钥 ID 和秘密
客户端配置
要将此服务器作为 MCP 客户端使用,请在您的 MCP 设置文件中添加以下配置(例如 cline_mcp_settings.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 替换为您实际的服务器路径,并在环境变量中提供您的阿里云凭证。
构建与运行
构建项目
mvn clean package
运行服务器
java -jar target/rtc-mcp-server-1.0-SNAPSHOT.jar
✨ 主要特性
- 创建和管理 Flink 集群
- 创建和管理 Flink SQL 任务
- 部署和控制 Flink 应用
- 监控任务状态和指标
- 创建和管理快照点
- 列出并管理部署
- 工作区和命名空间管理
📦 安装指南
环境准备
确保您的系统已经安装了 JDK 17 或更高版本以及 Maven 3.6 或更高版本,并拥有具备 RTC 实时计算服务权限的阿里云账户和相应的访问密钥。
项目构建与运行
按照上述“构建与运行”部分的步骤进行操作,即可完成服务器的安装和启动。
💻 使用示例
可用工具
该服务器提供了丰富的 MCP 工具,以下是各工具的具体使用说明:
任务管理
start_job: 启动已部署的 Flink 任务stop_job: 停止正在运行的 Flink 任务list_jobs: 列出部署中的所有任务delete_job: 删除非运行状态的任务get_job_diagnosis: 获取任务诊断信息
部署管理
create_deployment: 创建新部署update_deployment: 更新现有部署delete_deployment: 删除指定部署list_deployments: 列出所有部署get_deployment_status: 获取特定部署的状态
工作区管理
create_workspace: 创建新工作区update_workspace: 更新现有工作区配置delete_workspace: 删除指定工作区list_workspaces: 列出所有工作区get_workspace_info: 获取特定工作区的信息
资源管理
allocate_resources: 申请计算资源release_resources: 释放已分配资源modify_resource_limits: 调整资源限制view_resource_usage: 查看资源使用情况
📚 详细文档
服务器模式
- 标准模式:提供完整的功能,适合生产环境使用。
- 开发模式:增强调试功能,适合开发和测试阶段。
日志记录
默认情况下,日志输出至 mcpserver.log 文件,您可通过以下配置进行调整:
logging.file.name=/path/to/log/mcpserver.log
logging.level=INFO
📄 许可证
本项目遵循 Apache License 2.0 协议,具体内容如下:
除非适用的法律要求或书面同意,否则根据上述许可,软件及其文档可在任何情况下免费使用。
💡 贡献指南
欢迎社区贡献!请参考项目文档了解如何参与开发和提交代码。
微信扫一扫