article
README
🚀 SeaTunnel MCP 服务器
SeaTunnel MCP 服务器是一个借助大语言模型(LLM)接口与 SeaTunnel 进行交互的模型上下文协议(MCP)服务器,可实现作业管理、系统信息查询等功能。


🚀 快速开始
为了更好地了解 Seatunnel MCP 的功能和使用方法,我们提供了一个演示视频。请参考以下链接或直接查看项目文档目录中的视频文件。
https://www.youtube.com/watch?v=JaLA8EkZD7Q
⚠️ 重要提示
如果视频无法直接播放,请确保您的设备支持 MP4 格式,并尝试使用现代浏览器或视频播放器打开。
✨ 主要特性
- 作业管理(提交、停止、监控)
- 系统信息查询与检索
- 与 SeaTunnel 服务的 REST API 交互
- 内置日志和监控工具
- 动态连接配置
- 全面的作业信息和统计
📦 安装指南
# 克隆仓库
git clone <repository_url>
cd seatunnel-mcp
# 创建虚拟环境并安装
python -m venv .venv
source .venv/bin/activate # Windows系统请使用:.venv\Scripts\activate
pip install -e .
配置要求
- Python ≥ 3.12
- 运行中的 SeaTunnel 实例
- Node.js(用于与 MCP Inspector 测试)
💻 使用示例
环境变量
SEATUNNEL_API_URL=http://localhost:8090 # 默认的SeaTunnel REST API URL
SEATUNNEL_API_KEY=your_api_key # 可选:默认的SeaTunnel API密钥
动态连接配置
服务器提供了查看和更新连接设置的工具:
get-connection-settings:查看当前连接 URL 和 API 密钥状态update-connection-settings:更新 URL 和/或 API 密钥以连接到不同的 SeaTunnel 实例
通过 MCP 示例使用:
// 获取当前设置
{
"name": "get-connection-settings"
}
// 更新连接设置
{
"name": "update-connection-settings",
"arguments": {
"url": "http://new-host:8090",
"api_key": "new-api-key"
}
}
作业管理
服务器提供了提交和管理 SeaTunnel 作业的工具:
submit-job:提交一个新的作业,带有作业配置submit-jobs:一次性提交多个作业stop-job:停止指定的作业monitor-jobs:监控作业状态
运行服务器
# 在终端中运行以下命令启动服务器:
python -m seatunnel_mcp_server
与 Claude Desktop 集成
要在 Claude Desktop 中使用 Seatunnel MCP Server,请按照以下步骤配置:
- 打开 Claude Desktop 的设置。
- 添加新的 API 端点,URL 为
http://localhost:8090。 - 在项目中选择该端点以进行交互。
测试
运行以下命令测试与 MCP 服务器的连接:
curl http://localhost:8090/health
📚 详细文档
变更日志
v1.1.0(最新版本)
- 修复了动态连接配置工具中的一个错误,导致无法正确更新 API 密钥。
- 改进了作业监控功能,现在支持实时更新状态。
v1.0.1
- 增加了对 JSON 格式作业配置的支持。
- 优化了与 Claude Desktop 的集成体验。
v1.0.0(初始版本)
- 首次发布,具备基础 SeaTunnel 整合能力
- 提供基本的作业管理工具(提交、停止、监控)
- 系统信息查询工具
- 连接配置实用程序
📄 许可证
Apache License
微信扫一扫