SeaTunnel MCP 服务器

一个模型上下文协议 (MCP) 服务器，用于通过 LLM 接口（如 Claude）与 SeaTunnel 交互。

操作视频

为了帮助您更好地理解 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.9
• 运行中的 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: 提交具有作业配置的新作业
• 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 格式配置的新作业
• stop-job: 停止具有可选保存点的正在运行的作业
• get-job-info: 获取有关特定作业的详细信息
• get-running-jobs: 列出所有当前正在运行的作业
• get-running-job: 获取有关特定正在运行的作业的详细信息
• get-finished-jobs: 按状态列出所有已完成的作业

系统监控

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

贡献

1. Fork 仓库
2. 创建特性分支
3. 提交更改
4. 创建 Pull Request

许可证

Apache License