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 分發。