Rock Metadata MCP 服务端

使用说明（Markdown 格式）

• 项目简介

  • Rock Metadata MCP 服务器是一个基于 MCP 协议的后端应用，核心职责是在统一接口下向 LLM 客户端暴露元数据资源、可调用的工具、以及可渲染的 Prompt 模板，帮助 LLM 得到结构化的上下文信息和功能入口。

• 主要功能点

  • MCP 服务端暴露：通过 SSE 的 MCP 服务端点对外提供工具集合，包含数据源、爬取、元数据查询、数据质量、数据集、关系分析等分组工具（共约90个工具分组）。
  • 资源与工具管理：支持数据源注册、爬网任务、表/列/模式的查询、数据字典、标签、质量规则等的管理与调用。
  • Prompts 与充血交互：提供可渲染的 Prompt 模板和 Prompt 渲染能力，用于与 LLM 进行上下文对话。
  • 安全与扩展性：内置 API Key 认证（可选，基于 MCP_KEY 配置），多传输协议支持，异步任务处理等，便于扩展到企业级应用。
  • REST/API 组合：除了 MCP/SSE 外，项目还提供 REST 风格的 API，便于自定义前后端集成。

• 安装步骤

  • 本地运行
    • 需要 Java 21、Maven 等环境，按项目 README 的快速启动方式构建与运行：
      • 通过 Docker Compose 快速搭建并运行 PostgreSQL 数据库和应用，默认服务端口为 http://localhost:9990。
      • 也可以本地执行 mvn clean compile 和 mvn spring-boot:run 启动应用，默认监听 9990 端口。
  • 注意
    • 服务器默认的 MCP API Key 配置项为 metadata.mcp.api-key，若未配置则认证被禁用；如要启用，请设置环境变量 MCP_API_KEY 或在 application.yml 中配置 metadata.mcp.api-key。

• 服务器配置（给 MCP 客户端的连接信息示例（JSON 形式），注释说明见下文）

  • 仅用于描述服务器连接，MCP 客户端实际无需包含在此仓库中代码。以下为示例配置字段，帮助理解连接参数：
  • serverName: rock-metadata
  • transport: sse
  • url: http://localhost:9990/sse?api_key=YOUR_API_KEY 说明
  • serverName：服务器在客户端侧的名称标识，与 MCP 服务端的注册信息对应。
  • transport：传输协议，这里使用 SSE（Server-Sent Events）作为 MCP 的消息通道。
  • url：连接地址，后缀包含可选的 API Key 参数。
  • 安全性：若你启用了 API Key 认证，请在请求时提供 X-API-Key 头或 api_key 查询参数，与服务器端配置保持一致。

• 基本使用方法

  • 启动后，MCP 客户端可以通过指定的服务器名称、传输协议和 URL 进行连接，即可调用分组工具、查询元数据、执行数据集/管道等行为。
  • 使用你熟悉的 MCP 客户端流程，结合上述连接配置即可与 Rock Metadata MCP 服务器进行交互。

• 重要注意事项

  • 该仓库实现了 MCP 服务端并提供了完整的工具实现、服务器配置、以及多种数据管理能力，符合 MCP 服务器的核心能力要求。