SeaTunnel MCP 服务器

一个用于通过Claude等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地址
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：停止正在运行的作业
• get-job-info：获取特定作业的详细信息
• get-running-jobs：列出所有当前正在运行的作业
• get-finished-jobs：按状态（已完成、已取消、失败等）列出所有已完成作业

启动服务器

python -m src.seatunnel_mcp

与Claude Desktop配合使用

要在Claude Desktop中使用此功能，请在claude_desktop_config.json中添加以下内容：

{
  "mcpServers": {
    "seatunnel": {
      "command": "python",
      "args": ["-m", "src.seatunnel_mcp"],
      "cwd": "项目根目录"
    }
  }
}

使用MCP Inspector测试

npx @modelcontextprotocol/inspector python -m src.seatunnel_mcp

可用工具

连接管理

• get-connection-settings：查看当前SeaTunnel连接URL和API密钥状态
• update-connection-settings：更新URL和/或API密钥以连接到不同实例

作业管理

• submit-job：使用HOCON格式的配置提交新作业
• submit-job/upload：提交作业源上传配置文件
• submit-jobs：批量提交多个作业，直接将用户输入作为请求体传递
• stop-job：停止正在运行的作业（可选择保存点）
• get-job-info：获取特定作业的详细信息
• get-running-jobs：列出所有当前正在运行的作业
• get-running-job：获取特定运行中作业的详细信息
• get-finished-jobs：按状态列出所有已完成作业

系统监控

• get-overview：获取SeaTunnel集群概览
• get-system-monitoring-information：获取详细的系统监控信息

更新日志

v1.1.0 (2025-04-10)

• 新增功能：添加了submit-jobs和submit-job/upload工具，用于批量作业提交和文档提交操作
  • 允许通过单个API调用一次性提交多个作业
  • 输入直接作为请求体传递给API
  • 支持JSON格式的作业配置
  • 支持基于文档的作业提交

v1.0.0 (初始发布)

• 初始版本，具备基本的SeaTunnel集成能力
• 作业管理工具（提交、停止、监控）
• 系统监控工具
• 连接配置工具

许可证

Apache许可证