Opendata MCP

🚀 Open Data MCP

Open Data MCP是一个Model Context Protocol（MCP）服务器，旨在帮助用户更便捷地探索和调用韩国公共数据门户（OpenAPI）。它提供了以下MCP工具：

• search_api：通过关键字搜索公共数据API。
• get_std_docs：从搜索结果中选择 listId 列表，合并标准文档（Markdown）。
• fetch_data：根据标准文档/元数据调用实际的OpenAPI端点。

该服务器内部的搜索/文档工具使用 mcp.ezrnd.co.kr（HTTPS）后端。

🚀 快速开始

若要使用Open Data MCP，你需要满足以下要求并完成安装和运行步骤。

✨ 主要特性

• 提供便捷的API搜索功能，支持使用关键字查找公共数据API。
• 可以将搜索结果中的标准文档进行合并。
• 基于OpenAPI元数据调用特定端点获取数据。

📦 安装指南

要求

• Node.js ≥ 18.17（推荐使用最新的LTS版本）
• npm（包管理器）

安装命令

npm install

💻 使用示例

开发环境运行

你可以使用Smithery CLI来启动MCP开发服务器。

npm run dev

⚠️ 重要提示

@smithery/cli 作为MCP主机，在测试环境中由于部分功能不支持，无法注入 ODP_SERVICE_KEY，后续计划通过环境变量等方式实现预先注入，以便能够正常启动服务器。

📚 详细文档

环境变量

• ODP_SERVICE_KEY：公共数据门户服务密钥。部分API需要通过查询参数或Authorization头注入此密钥。
  • 若参数名称包含 serviceKey，则会自动注入。
  • 若头名称包含 Authorization，则会以 {Prefix} {密钥} 的格式自动注入。

提供工具详情

search_api

• 说明：在公共数据门户中使用关键字搜索API列表。
• 输入：
  • query：字符串数组（无空格的关键字，建议最多5个）
  • page：页码（从1开始）
  • pageSize：每页显示数量
• 输出：搜索结果（JSON字符串）

get_std_docs

• 说明：接收 search_api 结果中所选条目的 listId 数组，并合并返回标准文档（Markdown）。
• 输入：
  • listId：number[]
• 输出：合并后的Markdown字符串

fetch_data

• 说明：基于OpenAPI元数据调用特定端点，默认协议为HTTPS。
• 输入：requestData
  • baseInfo.host：例如 apis.data.go.kr（禁止包含协议/斜杠）
  • baseInfo.base_path：例如 /B552015/NpsBplcInfoInqireServiceV2
  • endpointInfo.path：例如 /getBassInfoSearchV2
  • endpointInfo.method：GET 或 POST
  • endpointInfo.params：[{ name, value }] 数组，值为空则排除。
  • endpointInfo.headers：[{ name, prefix, value }] 数组，支持自动将服务密钥注入 Authorization。
  • endpointInfo.body：POST请求体（JSON）
• 输出：响应体（JSON字符串或文本）

📄 许可证

有关此仓库的许可证信息，请参考根目录下的 LICENSE 文件。