SeaTunnel MCP Server

这是一个通过像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 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：停止正在运行的作业
• 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.2.0 (2025-06-10)

v1.2.0的新功能

• SSE支持：增加了st-mcp-sse，通过Server-Sent Events（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许可证