Opendata MCP

🚀 Open Data MCP

このプロジェクトは、韓国の公共データポータル(OpenAPI)をより簡単に探索・呼び出すことができるように支援するModel Context Protocol(MCP)サーバーです。

🚀 クイックスタート

このMCPサーバーは、韓国の公共データポータル(OpenAPI)の探索と呼び出しを容易にするためのツールを提供します。以下のようなMCPツールがあります:

• search_api: キーワードで公共データAPIを検索します。
• get_std_docs: 検索結果から選択した listId のリストで標準ドキュメント(markdown)を統合します。
• fetch_data: 標準ドキュメント/メタデータに基づいて、実際のOpenAPIエンドポイントを呼び出します。

内部的には、検索/ドキュメントツールは mcp.ezrnd.co.kr(HTTPS)のバックエンドを使用しています。

✨ 主な機能

• 公共データポータルの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 ファイルを参照してください。