SeaTunnel MCP Server

SeaTunnel MCP 服务

一个可通过 Claude 等 LLM 接口与 SeaTunnel 交互的模型上下文协议（MCP）服务。

操作视频

为了帮助你更好地了解 SeaTunnel MCP 的功能和用法，我们提供了视频演示。请参阅下方链接，或直接查看项目文档目录中的视频文件。

https://www.youtube.com/watch?v=JaLA8EkZD7Q

提示：如果视频无法直接播放，请确保你的设备支持 MP4 格式，并尝试使用现代浏览器或视频播放器打开。

功能

• 作业管理（提交、停止、监控）
• 系统监控和信息检索
• 与 SeaTunnel 服务进行 REST API 交互
• 内置日志记录和监控工具
• 动态连接配置
• 全面的作业信息和统计数据

安装

# Clone repository
git clone <repository_url>
cd seatunnel-mcp

# Create virtual environment and install
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -e .

要求

• Python ≥ 3.12
• 正在运行的 SeaTunnel 实例
• Node.js（用于使用 MCP Inspector 进行测试）

使用方法

环境变量

SEATUNNEL_API_URL=http://localhost:8090  # Default SeaTunnel REST API URL
SEATUNNEL_API_KEY=your_api_key           # Optional: Default SeaTunnel API key

动态连接配置

此服务提供用于在运行时查看和更新连接设置的工具：

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

通过 MCP 使用的示例：

// Get current settings
{
  "name": "get-connection-settings"
}

// Update 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：按状态列出所有已完成的作业（FINISHED、CANCELED、FAILED 等）

运行服务

python -m src.seatunnel_mcp

与 Claude Desktop 搭配使用

要在 Claude Desktop 中使用此服务，请将以下内容添加到你的 claude_desktop_config.json：

{
  "mcpServers": {
    "seatunnel": {
      "command": "python",
      "args": ["-m", "src.seatunnel_mcp"],
      "cwd": "Project root directory"
    }
  }
}

使用 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.2.0（2025-06-10）

v1.2.0 中的新功能

• SSE 支持：新增 st-mcp-sse，通过服务器发送事件（SSE）与 SeaTunnel MCP 实时通信。对应的 sse 分支
• UV／Studio 模式：新增 st-mcp-uv（或 st-mcp-studio），支持使用 uv 工具运行 MCP 服务，以提升性能并支持异步操作。对应的 uv 分支

claude_desktop_config.json 示例：

{
  "mcpServers": {
    "st-mcp-sse": {
      "url": "http://your-server:18080/sse"
    },
    "st-mcp-uv": {
      "command": "uv",
      "args": ["run", "seatunnel-mcp"],
      "env": {
        "SEATUNNEL_API_URL": "http://127.0.0.1:8080"
      }
    }
  }
}

v1.1.0（2025-04-10）

• 新功能：新增 submit-jobs 和 submit-job/upload 工具，用于批量提交作业和提交文档
  • 支持通过单次 API 调用一次提交多个作业
  • 输入内容会直接作为请求正文传递给 API
  • 支持使用 JSON 格式配置作业
  • 支持根据文档提交作业

v1.0.0（首次发布）

• 首次发布，提供基础的 SeaTunnel 集成能力
• 作业管理工具（提交、停止、监控）
• 系统监控工具
• 连接配置实用工具

许可证

Apache License