MCP Server for OpenMetadata

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

mcp-服务器-开放元数据

OpenMetadata 的模型上下文协议 (MCP) 服务器实现,可与 MCP 客户端无缝集成。该项目提供了一种通过模型上下文协议与 OpenMetadata 交互的标准化方式。

关于

该项目实现了一个模型上下文协议服务器,它包装了 OpenMetadata 的 REST API,允许 MCP 客户端以标准化的方式与 OpenMetadata 交互。

功能实现状态

特征API 路径地位
数据资产
列出数据库/api/v1/databases
获取数据库/api/v1/databases/{id}
通过名称获取数据库/api/v1/databases/name/{fqn}
导出数据库/api/v1/databases/name/{name}/export
导入数据库/api/v1/databases/name/{name}/import
列出表格/api/v1/tables
获取表/api/v1/tables/{id}
通过名称获取表/api/v1/tables/name/{fqn}
创建表/api/v1/tables
更新表/api/v1/tables/{id}
删除表/api/v1/tables/{id}
导出表/api/v1/tables/name/{name}/export
导入表/api/v1/tables/name/{name}/import
列出指标/api/v1/metrics
获取指标/api/v1/metrics/{id}
列出仪表板/api/v1/dashboards
获取仪表板/api/v1/dashboards/{id}
通过名称获取仪表板/api/v1/dashboards/name/{fqn}
列表报告/api/v1/reports
获取报告/api/v1/reports/{id}
列出管道/api/v1/pipelines
获取管道/api/v1/pipelines/{id}
通过名称获取管道/api/v1/pipelines/name/{fqn}
列出主题/api/v1/topics
获取主题/api/v1/topics/{id}
服务
列出数据库服务/api/v1/services/databaseServices
获取数据库服务/api/v1/services/databaseServices/{id}
通过名称获取数据库服务/api/v1/services/databaseServices/name/{fqn}
导出数据库服务/api/v1/services/databaseServices/name/{name}/export
导入数据库服务/api/v1/services/databaseServices/name/{name}/import
列出仪表板服务/api/v1/services/dashboardServices
获取仪表板服务/api/v1/services/dashboardServices/{id}
通过名称获取仪表板服务/api/v1/services/dashboardServices/name/{fqn}
团队和用户
列出团队/api/v1/teams
获取团队/api/v1/teams/{id}
通过名称获取团队/api/v1/teams/name/{fqn}
出口团队/api/v1/teams/name/{name}/export
进口团队/api/v1/teams/name/{name}/import
列出用户/api/v1/users
获取用户/api/v1/users/{id}
通过名称获取用户/api/v1/users/name/{name}
用户登录/api/v1/users/login
用户注销/api/v1/users/logout
用户注册/api/v1/users/signup
更改密码/api/v1/users/changePassword
搜索
搜索查询/api/v1/search/query
搜索建议/api/v1/search/suggest
搜索聚合/api/v1/search/aggregate
字段查询/api/v1/search/fieldQuery
获取文档/api/v1/search/get/{index}/doc/{id}
标签和分类
列出标签/api/v1/tags
获取标签/api/v1/tags/{id}
通过名称获取标签/api/v1/tags/name/{fqn}
血统
获取血统/api/v1/lineage/getLineage
导出谱系/api/v1/lineage/export
通过名称获取实体谱系/api/v1/lineage/{entity}/name/{fqn}
通过 ID 获取实体谱系/api/v1/lineage/{entity}/{id}
获取 Lineage Edge/api/v1/lineage/getLineageEdge/{fromId}/{toId}
添加/更新谱系/api/v1/lineage
通过 FQN 添加/更新谱系/api/v1/lineage/{fromEntity}/name/{fromFQN}/{toEntity}/name/{toFQN}
通过 ID 添加/更新谱系/api/v1/lineage/{fromEntity}/{fromId}/{toEntity}/{toId}
词汇表
列出词汇表/api/v1/glossaries
获取词汇表/api/v1/glossaries/{id}
按名称获取词汇表/api/v1/glossaries/name/{fqn}
导出词汇表/api/v1/glossaries/name/{name}/export
导入词汇表/api/v1/glossaries/name/{name}/import
列出词汇表术语/api/v1/glossaryTerms
获取术语表/api/v1/glossaryTerms/{id}
按名称获取词汇表术语/api/v1/glossaryTerms/name/{fqn}
将资产添加到术语/api/v1/glossaryTerms/{id}/assets/add
从术语中删除资产/api/v1/glossaryTerms/{id}/assets/remove
验证术语标签/api/v1/glossaryTerms/{id}/tags/validate
用法
通过名称获取实体使用情况/api/v1/usage/{entity}/name/{fqn}
通过 ID 获取实体使用情况/api/v1/usage/{entity}/{id}

设置

环境变量

设置以下身份验证方法之一:

令牌认证(推荐)

OPENMETADATA_HOST=<your-openmetadata-host> OPENMETADATA_JWT_TOKEN=<your-jwt-token>

基本身份验证

OPENMETADATA_HOST=<your-openmetadata-host> OPENMETADATA_USERNAME=<your-username> OPENMETADATA_PASSWORD=<your-password>

与 Claude Desktop 一起使用

使用以下身份验证方法之一添加到您的claude_desktop_config.json中:

令牌认证(推荐)

{ "mcpServers": { "mcp-server-openmetadata": { "command": "uvx", "args": ["mcp-server-openmetadata"], "env": { "OPENMETADATA_HOST": "https://your-openmetadata-host", "OPENMETADATA_JWT_TOKEN": "your-jwt-token" } } } }

基本身份验证

{ "mcpServers": { "mcp-server-openmetadata": { "command": "uvx", "args": ["mcp-server-openmetadata"], "env": { "OPENMETADATA_HOST": "https://your-openmetadata-host", "OPENMETADATA_USERNAME": "your-username", "OPENMETADATA_PASSWORD": "your-password" } } } }

使用uv替代配置:

令牌认证(推荐)

{ "mcpServers": { "mcp-server-openmetadata": { "command": "uv", "args": [ "--directory", "/path/to/mcp-server-openmetadata", "run", "mcp-server-openmetadata" ], "env": { "OPENMETADATA_HOST": "https://your-openmetadata-host", "OPENMETADATA_JWT_TOKEN": "your-jwt-token" } } } }

基本身份验证

{ "mcpServers": { "mcp-server-openmetadata": { "command": "uv", "args": [ "--directory", "/path/to/mcp-server-openmetadata", "run", "mcp-server-openmetadata" ], "env": { "OPENMETADATA_HOST": "https://your-openmetadata-host", "OPENMETADATA_USERNAME": "your-username", "OPENMETADATA_PASSWORD": "your-password" } } } }

/path/to/mcp-server-openmetadata替换为您克隆存储库的实际路径。

手动执行

您也可以手动运行服务器:

python src/server.py

选项:

  • --port :监听 SSE 的端口(默认值:8000)
  • --transport :传输类型(stdio/sse,默认值:stdio)

贡献

欢迎贡献代码!欢迎提交 Pull 请求。

执照

MIT 许可证

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

通过包装其 REST API 实现与 OpenMetadata 的集成,以便通过模型上下文协议实现标准化交互。

  1. About
    1. Feature Implementation Status
      1. Setup
        1. Environment Variables
        2. Usage with Claude Desktop
        3. Manual Execution
      2. Contributing
        1. License
          ID: lvgl5cmxa6