Api.market

🚀 API-MCP サーバー開発ガイド

API-MCP サーバーの開発に関する手順や使用方法、注意事項を説明します。このガイドを通じて、API-MCP サーバーの開発をスムーズに進めることができます。

🚀 クイックスタート

このセクションでは、API-MCP サーバーのインストールと初期設定について説明します。

📦 インストール

依存関係のインストール

1. リポジトリをクローンし、必要なパッケージをインストールします。

git clone https://github.com/Noveum/api-market-mcp-server.git
cd api-market-mcp-server
npm install

2. インストールが完了したら、開発環境を起動します。

npm run dev

⚙️ 設定説明

必須設定項目

• apiBaseUrl: API サービスのルート URL で、デフォルト値は https://api.magicapi.dev/api/v1/ です。
• openapiSpec: OpenAPI 仕様ファイルが含まれるパスで、デフォルト値は ./json_files です。

オプション設定項目

• headers: リクエストヘッダー情報で、key:value の形式で指定します。例えば、x-magicapi-key:your_api_key のように指定します。
• name: MCP サービスの名前で、デフォルト値は default-mcp-server です。
• version: MCP サービスのバージョン番号で、デフォルト値は 1.0.0 です。

💻 使用例

このセクションでは、API-MCP サーバーの使用例をいくつか紹介します。

基本的な使用法

例 1: 任意の 2 点間のルートを検索

例 2: 任意のトピックのニュースを検索し、関連記事を詳細に調査

例 3: 利用可能なドメインを検索

📚 ドキュメント

MCP サーバーに新しい API を追加する方法

utils フォルダには、API 設定の管理、OpenAPI 仕様の解析、新しい API の登録を行うためのヘルパースクリプトが含まれています。

1. OpenAPI 仕様を取得する

統合する API の OpenAPI JSON ファイルを見つけます。プロジェクトのルートディレクトリに json_files という名前のフォルダを作成し、取得した OpenAPI JSON ファイルをその中に配置します。

2. OpenAPI 仕様を修正する

modify_api.py スクリプトを使用して、仕様内のパスを更新し、ファイル名を含めるようにします。

python utils/modify_api.py

3. API 概要を更新する

パスを修正した後、API 概要を更新します。以下の 2 つの方法のいずれかを選択できます。

• 自動概要短縮（LLM を使用）:

python utils/LLM_summary_shortener.py 

• 手動で概要を更新する:

python utils/manual_summary_shortener.py 

4. ビルドとテスト

変更を適用するために、プロジェクトを再構築します。

npm run build

その後、以下のコマンドを使用して新しい API の統合をテストします。

npm run inspect

5. コード変更をコミットする

新しい API をリポジトリに貢献したい場合は、以下の手順を実行します。

• リポジトリをフォークします。
• 機能ブランチを作成します。
• 変更をコミットし、プルリクエスト（PR）を作成します。

6. MCP サーバーを公開する（オプション）

変更を公開する場合は、以下の手順を実行します。

• package.json ファイルを更新します（例: バージョン番号、名前などを更新）。
• パッケージを公開します。

npm publish --access public

コマンドライン引数

起動コマンド

npm run start

設定ファイルのパス

package.json に以下の設定を追加して、MCP サーバーを起動します。

"scripts": {
  "start": "mcp-server --apiBaseUrl https://your_api_base_url --openapiSpec ./specs"
}

デバッグ情報

ログの表示

コンソールでリアルタイムのログを確認できます。

npm run start

貢献ガイド

• 問題の報告: Issues ページ に issue を投稿してください。
• コードの貢献: GitHub リポジトリ にプルリクエストを投稿してください。

注意事項

すべてのコード例とコマンドラインの文は UTF-8 エンコーディングです。UTF-8 をサポートする環境で実行するようにしてください。