This is an automated email from the ASF dual-hosted git repository.
lidongdai pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/seatunnel.git
The following commit(s) were added to refs/heads/dev by this push:
new b487739817 [Feature][Doc] Add Seatunnel tools guide (#10525)
b487739817 is described below
commit b4877398179b00db4d22c1376fa51f1b8b83c0cc
Author: ocean-zhc <[email protected]>
AuthorDate: Mon Mar 2 12:33:14 2026 +0800
[Feature][Doc] Add Seatunnel tools guide (#10525)
---
docs/en/tools/overview.md | 19 ++++++++++++++++
docs/en/tools/seatunnel-mcp.md | 15 +++++++++++++
docs/en/tools/seatunnel-skill.md | 48 ++++++++++++++++++++++++++++++++++++++++
docs/en/tools/x2seatunnel.md | 17 ++++++++++++++
docs/sidebars.js | 10 +++++++++
docs/zh/tools/overview.md | 19 ++++++++++++++++
docs/zh/tools/seatunnel-mcp.md | 15 +++++++++++++
docs/zh/tools/seatunnel-skill.md | 48 ++++++++++++++++++++++++++++++++++++++++
docs/zh/tools/x2seatunnel.md | 17 ++++++++++++++
9 files changed, 208 insertions(+)
diff --git a/docs/en/tools/overview.md b/docs/en/tools/overview.md
new file mode 100644
index 0000000000..1db5a8ff3e
--- /dev/null
+++ b/docs/en/tools/overview.md
@@ -0,0 +1,19 @@
+---
+sidebar_position: 1
+---
+
+# SeaTunnel Tools Overview
+
+Apache SeaTunnel Tools is a collection of auxiliary tools focused on developer
and operator productivity, covering LLM integration, configuration conversion,
and AI-powered assistance.
+
+## Available Tools
+
+| Tool | Purpose | Status |
+|------|---------|--------|
+| [SeaTunnel Skill](seatunnel-skill) | Claude AI integration for SeaTunnel
operations | Available |
+| [SeaTunnel MCP Server](seatunnel-mcp) | Model Context Protocol server for
LLM integration | Available |
+| [x2seatunnel](x2seatunnel) | Configuration converter (DataX → SeaTunnel) |
Available |
+
+## Source Repository
+
+All tools are maintained in the [SeaTunnel
Tools](https://github.com/apache/seatunnel-tools) repository.
diff --git a/docs/en/tools/seatunnel-mcp.md b/docs/en/tools/seatunnel-mcp.md
new file mode 100644
index 0000000000..2d2cbe4cc1
--- /dev/null
+++ b/docs/en/tools/seatunnel-mcp.md
@@ -0,0 +1,15 @@
+---
+sidebar_position: 3
+---
+
+# SeaTunnel MCP Server
+
+SeaTunnel MCP Server implements the [Model Context
Protocol](https://modelcontextprotocol.io/) to enable LLM systems to interact
with SeaTunnel resources.
+
+## Overview
+
+The MCP server exposes SeaTunnel documentation, connector metadata, and job
management capabilities as MCP resources and tools, allowing any MCP-compatible
LLM client to assist with SeaTunnel operations.
+
+## Getting Started
+
+Refer to the [SeaTunnel Tools
repository](https://github.com/apache/seatunnel-tools/tree/main/seatunnel-mcp)
for installation and configuration instructions.
diff --git a/docs/en/tools/seatunnel-skill.md b/docs/en/tools/seatunnel-skill.md
new file mode 100644
index 0000000000..a7edf5e8c4
--- /dev/null
+++ b/docs/en/tools/seatunnel-skill.md
@@ -0,0 +1,48 @@
+---
+sidebar_position: 2
+---
+
+# SeaTunnel Skill
+
+SeaTunnel Skill is a Claude Code AI integration that provides instant
assistance for SeaTunnel operations, configuration, and troubleshooting.
+
+## Features
+
+- **AI-Powered Assistant**: Get instant help with SeaTunnel concepts and
configurations
+- **Knowledge Integration**: Query official documentation and best practices
+- **Smart Debugging**: Analyze errors and suggest fixes
+- **Code Examples**: Generate configuration examples for your use case
+
+## Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/apache/seatunnel-tools.git
+cd seatunnel-tools
+
+# Copy the skill to Claude Code skills directory
+cp -r seatunnel-skill ~/.claude/skills/
+```
+
+## Usage
+
+After installation, use the skill in Claude Code:
+
+```bash
+# Query SeaTunnel documentation
+/seatunnel-skill "How do I configure a MySQL to PostgreSQL job?"
+
+# Get connector information
+/seatunnel-skill "List all available Kafka connector options"
+
+# Debug configuration issues
+/seatunnel-skill "Why is my job failing with OutOfMemoryError?"
+
+# Generate configuration examples
+/seatunnel-skill "Create a MySQL to Elasticsearch job config"
+```
+
+## Requirements
+
+- [Claude Code](https://claude.ai/code) installed
+- Claude Code skills directory at `~/.claude/skills/`
diff --git a/docs/en/tools/x2seatunnel.md b/docs/en/tools/x2seatunnel.md
new file mode 100644
index 0000000000..a0595c946f
--- /dev/null
+++ b/docs/en/tools/x2seatunnel.md
@@ -0,0 +1,17 @@
+---
+sidebar_position: 4
+---
+
+# x2seatunnel
+
+x2seatunnel is a configuration converter that transforms DataX and other data
integration tool configurations into SeaTunnel format.
+
+## Supported Conversions
+
+| Source Format | Target Format |
+|--------------|---------------|
+| DataX JSON | SeaTunnel HOCON |
+
+## Getting Started
+
+Refer to the [x2seatunnel
repository](https://github.com/apache/seatunnel-tools/tree/main/x2seatunnel)
for installation and usage instructions.
diff --git a/docs/sidebars.js b/docs/sidebars.js
index da8432c9c2..f839fb5429 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -309,6 +309,16 @@ const sidebars = {
"engines/spark"
]
},
+ {
+ "type": "category",
+ "label": "Tools",
+ "items": [
+ "tools/overview",
+ "tools/seatunnel-skill",
+ "tools/seatunnel-mcp",
+ "tools/x2seatunnel"
+ ]
+ },
{
"type": "category",
"label": "Developer",
diff --git a/docs/zh/tools/overview.md b/docs/zh/tools/overview.md
new file mode 100644
index 0000000000..0e1152eb05
--- /dev/null
+++ b/docs/zh/tools/overview.md
@@ -0,0 +1,19 @@
+---
+sidebar_position: 1
+---
+
+# SeaTunnel 工具集概览
+
+Apache SeaTunnel 工具集是一组面向开发者和运维人员的辅助工具，涵盖 LLM 集成、配置转换和 AI 辅助等功能。
+
+## 可用工具
+
+| 工具 | 用途 | 状态 |
+|------|------|------|
+| [SeaTunnel Skill](seatunnel-skill) | Claude AI 集成，辅助 SeaTunnel 操作 | 可用 |
+| [SeaTunnel MCP 服务](seatunnel-mcp) | 面向 LLM 的模型上下文协议服务 | 可用 |
+| [x2seatunnel](x2seatunnel) | 配置转换工具（DataX → SeaTunnel） | 可用 |
+
+## 源码仓库
+
+所有工具均维护于 [SeaTunnel Tools](https://github.com/apache/seatunnel-tools) 仓库中。
diff --git a/docs/zh/tools/seatunnel-mcp.md b/docs/zh/tools/seatunnel-mcp.md
new file mode 100644
index 0000000000..82856d2370
--- /dev/null
+++ b/docs/zh/tools/seatunnel-mcp.md
@@ -0,0 +1,15 @@
+---
+sidebar_position: 3
+---
+
+# SeaTunnel MCP 服务
+
+SeaTunnel MCP 服务实现了[模型上下文协议（Model Context
Protocol）](https://modelcontextprotocol.io/)，使 LLM 系统能够与 SeaTunnel 资源进行交互。
+
+## 概述
+
+MCP 服务将 SeaTunnel 文档、连接器元数据和任务管理能力以 MCP 资源与工具的形式对外暴露，允许任意支持 MCP 协议的 LLM
客户端辅助完成 SeaTunnel 操作。
+
+## 快速开始
+
+安装与配置说明请参阅 [SeaTunnel Tools
仓库](https://github.com/apache/seatunnel-tools/tree/main/seatunnel-mcp)。
diff --git a/docs/zh/tools/seatunnel-skill.md b/docs/zh/tools/seatunnel-skill.md
new file mode 100644
index 0000000000..78e2316285
--- /dev/null
+++ b/docs/zh/tools/seatunnel-skill.md
@@ -0,0 +1,48 @@
+---
+sidebar_position: 2
+---
+
+# SeaTunnel Skill
+
+SeaTunnel Skill 是 Claude Code 的 AI 集成技能，为 SeaTunnel 的操作、配置和故障排查提供即时帮助。
+
+## 功能特性
+
+- **AI 助手**：即时获取 SeaTunnel 概念和配置相关帮助
+- **知识集成**：查询官方文档和最佳实践
+- **智能调试**：分析错误并给出修复建议
+- **代码示例**：为您的用例自动生成配置示例
+
+## 安装
+
+```bash
+# 克隆仓库
+git clone https://github.com/apache/seatunnel-tools.git
+cd seatunnel-tools
+
+# 复制技能文件到 Claude Code 技能目录
+cp -r seatunnel-skill ~/.claude/skills/
+```
+
+## 使用方法
+
+安装完成后，在 Claude Code 中使用：
+
+```bash
+# 查询 SeaTunnel 文档
+/seatunnel-skill "如何配置 MySQL 到 PostgreSQL 的数据同步？"
+
+# 获取连接器信息
+/seatunnel-skill "列出所有可用的 Kafka 连接器选项"
+
+# 调试配置问题
+/seatunnel-skill "为什么我的任务出现 OutOfMemoryError 错误？"
+
+# 生成配置示例
+/seatunnel-skill "创建一个 MySQL 到 Elasticsearch 的任务配置"
+```
+
+## 系统要求
+
+- 已安装 [Claude Code](https://claude.ai/code)
+- Claude Code 技能目录位于 `~/.claude/skills/`
diff --git a/docs/zh/tools/x2seatunnel.md b/docs/zh/tools/x2seatunnel.md
new file mode 100644
index 0000000000..bb456c9150
--- /dev/null
+++ b/docs/zh/tools/x2seatunnel.md
@@ -0,0 +1,17 @@
+---
+sidebar_position: 4
+---
+
+# x2seatunnel
+
+x2seatunnel 是一款配置转换工具，可将 DataX 等数据集成工具的配置文件转换为 SeaTunnel 格式。
+
+## 支持的转换
+
+| 源格式 | 目标格式 |
+|--------|---------|
+| DataX JSON | SeaTunnel HOCON |
+
+## 快速开始
+
+安装与使用说明请参阅 [x2seatunnel
仓库](https://github.com/apache/seatunnel-tools/tree/main/x2seatunnel)。
