Api Market MCP Server

🚀 API-MCP サーバー

API-MCP サーバーは、API の管理と運用を支援するサーバーです。このサーバーを使用することで、API の統合、管理、および拡張が容易になります。

🚀 クイックスタート

API-MCP サーバーをインストールして実行するには、以下の手順に従ってください。

📦 インストール

npm を使用したインストール

npm install -g @magicapi/mcp-server

サーバーの起動

mcp-server --api-base-url https://api.magicapi.dev/api/v1/ --headers "x-magicapi-key:your-api-key"

サンプルコマンド

サンプル 1：デフォルト設定で実行

mcp-server

サンプル 2：API ベース URL とキーを指定

mcp-server --api-base-url https://api.magicapi.dev/api/v1/ --headers "x-magicapi-key:your-api-key"

📚 ドキュメント

MCP サーバーへの新しい API の追加

手順 1：OpenAPI 仕様の特定

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

手順 2：OpenAPI 仕様の修正

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：変更の提出

これらの変更をリポジトリに貢献したい場合は：

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

手順 6：MCP サーバーの公開（オプション）

変更を公開したい場合は：

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

npm publish --access public

🔧 開発ツール

ビルド

• npm run build - TypeScript ソースコードをビルドします。
• npm run clean - ビルドアーティファクトを削除します。
• npm run typecheck - TypeScript の型チェックを実行します。

開発モード

• npm run dev - ソースファイルを監視し、変更があった場合に再構築します。
• npm run inspect-watch - 自動リロード付きのインスペクターを実行します。

コード品質

• npm run lint - ESLint を実行します。
• npm run typecheck - TypeScript の型を検証します。

環境変数の設定

以下のコマンドを実行して環境を構成します。

export OPENAPI_SPEC_PATH=modified_files.txt # オプション
export API_BASE_URL=https://api.magicapi.dev/api/v1/ # オプション
export NODE_OPTIONS=--loader ts-node/esm # オプション

コントリビューションガイド

コードの提出

コードを提出する前に、以下のコマンドを実行してください。

npm run lint
npm test

その後、変更をコミットしてプルリクエストを作成します。

💻 デバッグまたはローカルでの実行

依存関係のインストール

npm install

開発サーバーの起動

npm run dev

ドキュメントの閲覧

ドキュメント を訪問して、詳細情報を確認してください。

上記の手順に従えば、API-MCP サーバーを簡単にインストール、構成、および使用し、必要に応じて拡張およびカスタマイズすることができます。