MCP Server Connection Guide

OpenMetadata provides a Model Context Protocol (MCP) server that allows AI assistants and other clients to interact with your metadata catalog. The MCP server exposes tools for searching metadata, managing glossaries, and working with lineage data. Please check out our guides for Claude and Goose if you are using them as AI assistants.

Server Information

Server Name: openmetadata-mcp-stateless
Version: 1.1.0
Endpoint: {OMURL}/mcp
Protocol: Streamable HTTP (MCP spec 2025-03-26)
Authentication: OAuth 2.0 (interactive clients) or JWT Bearer Token (unattended agents)

Connection Setup

1. Server URL

Your MCP server is available at:

{OMURL}/mcp

Replace {OMURL} with your OpenMetadata instance URL (e.g., https://your-openmetadata.com/mcp)

2. Authentication

The MCP server supports two authentication methods:

OAuth 2.0 (interactive clients): Sign in with your existing OpenMetadata login. Requires a browser and a signed-in user, so it isn’t suitable for headless or unattended agents. See OAuth 2.0 Authentication for setup instructions.
Bot JWT token: For unattended agents and environments where browser-based login isn’t available. Generate a token from a Bot as described in Bot Token, then include it in the Authorization header:

Authorization: Bearer <your-token>

3. Required HTTP Headers

All Streamable HTTP POST requests must include:

Content-Type: application/json
Accept: application/json, text/event-stream

API Endpoints

Initialize Connection

Endpoint: POST {OMURL}/mcp Sample Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "initialize",
  "params": {
    "protocolVersion": "2025-03-26",
    "capabilities": {},
    "clientInfo": {
      "name": "your-client",
      "version": "1.0.0"
    }
  }
}

Sample Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "protocolVersion": "2025-03-26",
    "capabilities": {
      "tools": true,
      "prompts": true
    },
    "serverInfo": {
      "name": "openmetadata-mcp-stateless",
      "version": "1.1.0"
    }
  }
}

Complete Initialization

After receiving the initialize response, send this notification before making normal requests:

{
  "jsonrpc": "2.0",
  "method": "notifications/initialized"
}

List Available Tools

Endpoint: POST {OMURL}/mcp Sample Request:

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/list"
}

Sample Response (truncated — the server exposes 24 tools; see the MCP Tools Reference for the complete list):

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "tools": [
      {
        "name": "search_metadata",
        "description": "Find your data and business terms in OpenMetadata.",
        "inputSchema": {
          "type": "object",
          "properties": {
            "query": {
              "type": "string",
              "description": "Keywords to use for searching."
            },
            "entityType": {
              "type": "string",
              "description": "Optional entity type to filter results."
            },
            "size": {
              "type": "integer",
              "description": "Maximum number of results to return. Default is 10."
            }
          }
        }
      },
      {
        "name": "get_entity_details",
        "description": "Retrieve full details for a specific entity by FQN.",
        "inputSchema": {
          "type": "object",
          "properties": {
            "entityType": {
              "type": "string",
              "description": "Type of entity"
            },
            "fqn": {
              "type": "string",
              "description": "Fully qualified name of the entity"
            }
          },
          "required": ["entityType", "fqn"]
        }
      }
    ]
  }
}

List Available Prompts

Endpoint: POST {OMURL}/mcp Sample Request:

{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "prompts/list"
}

Sample Response:

{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {
    "prompts": [
      {
        "name": "search_metadata",
        "description": "Creates a prompt for Searching metadata in OpenMetadata.",
        "arguments": [
          {
            "name": "query",
            "description": "Keywords to use for searching.",
            "required": true
          },
          {
            "name": "entity_type",
            "description": "Entity Type to Filter Report."
          },
          {
            "name": "limit",
            "description": "Maximum number of results to return. Default is 10."
          }
        ]
      }
    ]
  }
}

​MCP Server Connection Guide

​Server Information

​Connection Setup

​1. Server URL

​2. Authentication

​3. Required HTTP Headers

​API Endpoints

​Initialize Connection

​Complete Initialization

​List Available Tools

​List Available Prompts

MCP Server Connection Guide

Server Information

Connection Setup

1. Server URL

2. Authentication

3. Required HTTP Headers

API Endpoints

Initialize Connection

Complete Initialization

List Available Tools

List Available Prompts