Mage MCP Server

🚀 Mage.ai 数据管道与模型上下文协议 (MCP) 集成

这是一个全面的模型上下文协议 (MCP) 集成方案，专为 Mage.ai 量身打造。借助该方案，AI 助手（如 Anthropic 的 Claude）能够高效地与 Mage 数据管道进行交互，极大提升数据处理与分析的效率。

✨ 主要特性

• 浏览管道：可探索所有 Mage.ai 管道及其组件，全面了解管道结构。
• 查看和编辑代码：能够阅读并修改块代码，方便对管道进行定制。
• 执行管道：支持运行整个管道或单独的块，满足不同场景需求。
• 搜索功能：可按名称、类型或内容查找块，快速定位所需信息。
• 管道创建：能从零开始新建管道和块，灵活搭建数据处理流程。

📦 安装指南

# 克隆仓库
git clone https://github.com/yourusername/mage-mcp.git
cd mage-mcp

# 安装依赖项
pip install -r requirements.txt

📚 详细文档

配置说明

服务器可通过环境变量或命令行参数进行配置：

• MAGE_API_URL：Mage.ai API 的 URL 地址（默认值：http://localhost:6789/api/）
• MAGE_API_KEY：用于身份验证的 API 密钥（如有需要）

创建一个 .env 文件以实现持久化配置：

MAGE_API_URL=http://localhost:6789/api/
MAGE_API_KEY=your_api_key_if_needed

使用方法

启动服务器

使用提供的脚本来启动 MCP 服务器：

# 使用标准输入输出传输（默认）
python run_server.py

# 使用 SSE 传输
python run_server.py --transport sse --host localhost --port 3000

# 其他选项
python run_server.py --api-url http://your-mage-instance:6789/api/ --api-key your_key --debug

与 Claude Desktop 集成安装

为了获得最佳体验，直接通过 Claude Desktop 安装此服务器：

# 使用 mcp CLI
mcp install run_server.py --name "Mage.ai 管理器"

# 带环境变量配置
mcp install run_server.py -v MAGE_API_URL=http://localhost:6789/api/ -v MAGE_API_KEY=your_key

开发模式

用于测试和开发：

mcp dev run_server.py

MCP 资源与工具

资源地址

• mage://pipelines - 列出所有管道
• mage://pipelines/{pipeline_uuid} - 获取管道详细信息
• mage://pipelines/{pipeline_uuid}/blocks - 获取管道中的块
• mage://pipelines/{pipeline_uuid}/blocks/{block_id} - 获取特定块的详细信息
• mage://pipelines/{pipeline_uuid}/execute - 执行管道
• mage://pipelines/{pipeline_uuid}/execute/{execution_id} - 获取执行状态

工具函数

• list_all_pipelines()：返回所有管道的列表。
• get_pipeline_details(pipeline_uuid)：获取指定管道的详细信息。
• execute_pipeline(pipeline_uuid, parameters)：执行管道，可传入参数。
• search_blocks(query)：按查询内容搜索块。

💻 使用示例

基础用法

# 创建新管道
pipeline = create_pipeline("数据分析管道", "数据处理和分析")

# 添加块到管道
add_block_to_pipeline(pipeline.uuid, "数据清洗", "清洗数据步骤")

# 执行管道
execution_id = execute_pipeline(pipeline.uuid, {"input_data": "raw_data.csv"})

# 获取执行状态
status = get_execution_status(pipeline.uuid, execution_id)
print(status)  # 输出执行结果

🤝 贡献指南

欢迎贡献！请参考 CONTRIBUTING.md 获取更多信息。

📄 许可证

项目遵循 MIT 许可证，具体内容详见 LICENSE 文件。