MCP Openmetadata

🚀 MCP Open Metadata

MCP Server provides integration of OpenMetadata API - FastMCP for OpenMetadata services.

🚀 Quick Start

MCP Server offers integration of the OpenMetadata API - FastMCP for OpenMetadata services.

✨ Features

• Integration of OpenMetadata API with FastMCP.
• User - friendly metadata management interface.
• Support for table metadata, sample data, and ownership information.

📦 Installation

From PyPi (Cursor)

Install to Cursor using (uv):

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>

Install to Cursor using (pip):

pip install mcp-openmetadata

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

From Configuration File

{
    "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"
            }
        }
    }
}

🔧 Technical Details

Environment Variables

Authorization

mcp-openmetadata provides token authentication and basic authentication:

Token Authentication

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

Basic Authentication

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

Tool List

mcp-openmetadata does not provide all available OpenMetadata APIs. Please refer to Supported APIs for a list of available APIs.

Since directly using the raw APIs contains too much unnecessary data and is difficult to fit within the model's context limit, we are working on returning curated results.

Search Tools

• search_entities_with_query: Search for entities using query text. Supports pagination and sorting. Applicable to:
  • List all tables/topics (q=*).
  • Search by field name (e.g., q=columnNames:address).
  • Search by label (e.g., q=label:*).
  • Filter by condition (e.g., q=state:"running" or q=!state:"stopped").
  • Search for all entities of a specific type (e.g., q=:///. See the OpenMetadata documentation for more examples).

Table Metadata Tools

• get_table: Get detailed information about a table based on the database and table names.
• get_columns: Get information about all columns of a specified table.

Supported APIs

Currently, mcp-openmetadata only supports the following OpenMetadata APIs:

1. Entity Search (search_entities_with_query).
2. Table Metadata (get_table, get_columns).

If you need other features, please refer to the OpenMetadata documentation or contact the project maintainers.

💻 Usage Examples

Install and Run with Token Authentication

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

Install and Run with Basic Authentication

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

Example of Querying Table Metadata

In another terminal:

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

📄 License

This project is distributed under the MIT License.