MCP OpenMetadata

By pfldy2850 GitHub

MCP server providing OpenMetadata APIs

mcp-openmetadata metadata-management

Overview

what is MCP OpenMetadata?

MCP OpenMetadata is a server that provides OpenMetadata APIs, facilitating integration with FastMCP for efficient metadata management.

how to use MCP OpenMetadata?

To use MCP OpenMetadata, install it via PyPi and configure it with your OpenMetadata URI and JWT token. You can run it using the provided command line instructions.

key features of MCP OpenMetadata?

Integration with OpenMetadata APIs and FastMCP
User-friendly interface for managing metadata
Support for various metadata types including table metadata and ownership information

use cases of MCP OpenMetadata?

Managing and retrieving metadata for data tables.
Integrating metadata services with FastMCP for enhanced data processing.
Facilitating metadata search and organization for data governance.

FAQ from MCP OpenMetadata?

What is the license for MCP OpenMetadata?

MCP OpenMetadata is licensed under the MIT License.

How can I install MCP OpenMetadata?

You can install it using pip or through configuration as detailed in the documentation.

What programming language is MCP OpenMetadata written in?

MCP OpenMetadata is written in Python.

Content

MCP OpenMetadata

MCP server providing OpenMetadata APIs - A FastMCP integration for OpenMetadata services.

Features

OpenMetadata API integration with FastMCP
Easy-to-use interface for metadata management
Support for table metadata, sample data, and ownership information

Installation

from PyPi (Cursor)

Install it to Cursor with (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 it to Cursor with (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

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

Environment Variables

Authorization

mcp-openmetadata provides token auth and basic auth:

Token Auth

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

Basic Auth

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

Tool list

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

Since using the original API directly contains too much unnecessary data that is difficult to fit into the model context, we are working on returning somewhat organized results.

Search Tools

search_entities_with_query: Search entities using query text. Supports pagination and sorting. Useful for:
- Listing all tables/topics (q=*)
- Searching by field names (e.g., q=columnNames:address)
- Searching by tags (e.g., q=tags.tagFQN:user.email)
- Complex queries with AND/OR operators
- Filtering by service type, constraints, owners, etc.

Table Tools

get_list_of_tables: Get a paginated list of tables with basic information
get_table_by_fqn: Get detailed table information by fully qualified name
get_table_columns_by_fqn: Get table columns information by fully qualified name
get_table_owners_by_fqn: Get table ownership information by fully qualified name
get_sample_data: Get sample data from a specified table

Each tool returns optimized responses with relevant fields to ensure compatibility with model context limits while providing essential metadata information.

License

This project is open source software licensed as MIT.

No tools information available.

No content found.