MCP Openmetadata

🚀 MCP 开放元数据

MCP 开放元数据项目提供了 MCP 服务器与 OpenMetadata API - FastMCP 的集成，可用于 OpenMetadata 服务，为用户带来便捷的元数据管理体验。

🚀 快速开始

MCP 服务器提供 OpenMetadata API - FastMCP 的集成用于 OpenMetadata 服务。

✨ 主要特性

• 实现了 OpenMetadata API 与 FastMCP 的集成。
• 提供了易用的元数据管理接口。
• 支持表元数据、样本数据和所有权信息。

📦 安装指南

从 PyPi（Cursor）

• 使用 (uv) 安装到 Cursor：

uv pip install mcp-openmetadata

uv run python -m mcp-openmetadata.hosts.cursor \
  -e OPENMETADATA_URI=<YOUR OPENMETADATA URI> \
  -e OPENMETADATA_JWT_TOKEN=<YOUR OPENMETADATA JWT TOKEN>

• 使用 (pip) 安装到 Cursor：

pip install mcp-openmetadata

python -m mcp-openmetadata.hosts.cursor \
  -e OPENMETADATA_URI=<YOUR OPENMETADATA URI> \
  -e OPENMETADATA_JWT_TOKEN=<YOUR OPENMETADATA JWT TOKEN>

从配置文件

{
    "mcpServers": {
        "OpenMetadata": {
            "command": "uv",
            "args": [
                "run",
                "--with",
                "fastmcp",
                "--with",
                "httpx",
                "--with",
                "mcp-openmetadata",
                "python",
                "-m",
                "mcp_openmetadata.server"
            ],
            "env": {
                "OPENMETADATA_URI": "http://localhost:8585",
                "OPENMETADATA_JWT_TOKEN": "awesome_jwt_token"
            }
        }
    }
}

🔧 技术细节

环境变量

授权

mcp-openmetadata 提供令牌认证和基本认证：

• 令牌认证：

OPENMETADATA_URI=http://localhost:8585
OPENMETADATA_JWT_TOKEN=<YOUR OPENMETADATA JWT TOKEN>

• 基本认证：

OPENMETADATA_URI=http://localhost:8585
OPENMETADATA_USERNAME=<YOUR OPENMETADATA USERNAME>
OPENMETADATA_PASSWORD=<YOUR OPENMETADATA PASSWORD>

工具列表

mcp-openmetadata 并未提供 OpenMetadata 所有可用的 API。请参考 支持的 API 了解可用的 API 列表。由于直接使用原始 API 包含太多不必要的数据，难以适应模型上下文限制，我们正在努力返回经过整理的结果。

• 搜索工具：
  • search_entities_with_query：使用查询文本搜索实体。支持分页和排序。适用于：
    • 列出所有表格/主题（q=*）
    • 根据字段名称搜索（例如 q=columnNames:address）
    • 根据标签搜索（例如 q=label:*）
    • 按条件筛选（例如 q=state:"running" 或 q=!state:"stopped"）
    • 搜索具有特定类型的所有实体（例如 q=:///。更多示例请参考 OpenMetadata 文档）
• 表元数据工具：
  • get_table：根据数据库和表名称获取表的详细信息。
  • get_columns：获取指定表的所有列信息。

支持的 API

目前，mcp-openmetadata 仅支持以下 OpenMetadata API：

1. 实体搜索 (search_entities_with_query)
2. 表元数据 (get_table, get_columns)

如果您需要其他功能，请参考 OpenMetadata 文档 或联系项目维护者。

💻 使用示例

基础用法

使用令牌认证安装并运行

pip install mcp-openmetadata
python -m mcp_openmetadata.hosts.cursor \
  --bind 0.0.0.0:12345 \
  --name openMetadata \
  --set mcp.openMetadata.authProvider.jwt.token=your_jwt_token \
  --set mcp.openMetadata.authProvider.type=jwt

使用基本认证安装并运行

pip install mcp-openmetadata
python -m mcp_openmetadata.hosts.cursor \
  --bind 0.0.0.0:12345 \
  --name openMetadata \
  --set mcp.openMetadata.authProvider.basic.username=your_username \
  --set mcp.openMetadata.authProvider.type=basic \
  --set mcp.openMetadata.authProvider.basic.password=your_password

高级用法

查询表元数据示例

在另一终端中：

curl -X POST "http://localhost:12345/v1/table" \
     -H "Content-Type: application/json" \
     -d '{"name": {"database": "my-database", "table": "my-table"}}'

📄 许可证

本项目根据 MIT License 分发。