Api Suggestion Server

🚀 API 提案サーバー

API Suggestion Server は、MCP プロトコルに基づいて実装されたツールです。OpenAPI 3.0 サービス仕様に基づき、Claude、GPT - 4 などの AI モデルに API 関連のコンテキスト情報を提供します。このサーバーは、YAML と JSON などの複数の形式、または URL 形式の OpenAPI 仕様を解析し、MCP プロトコルを通じて API 情報を AI モデルに伝達することができます。

✨ 主な機能

• 多プロトコル対応: YAML、JSON 形式の OpenAPI ドキュメントと URL 方式のドキュメントをサポートします。
• スマートな提案: 入力された使用シーンに基づいて、最も関連性の高い API エンドポイントの提案を提供します。
• 拡張しやすい: 新しい OpenAPI サービス仕様をシステムに簡単に追加できます。

📦 インストール

1. プロジェクトリポジトリをクローンします：

git clone [your-repository-url]
cd api-mcp-server

2. 依存関係をインストールします：

npm install

3. サーバーを起動します：

npm start

💻 使用例

新しいサービス仕様の追加

1. OpenAPI サービス仕様ファイル（YAML または JSON 形式）を schemas ディレクトリに配置します。
2. server.config.ts ファイルに対応するサービス設定を追加します。

MCP プロトコルサポート

AI モデルは、以下のツールを呼び出してサーバーとやり取りできます。

suggest_api ツール

機能: 指定された用途に関連する API エンドポイントの提案を提供します。

入力パラメータ:

• purpose: API の使用目的の説明（文字列）

出力結果:

• 関連する API エンドポイントのリスト（サービス名、パス、リクエストメソッド、説明情報を含む）

使用例:

{
  "name": "suggest_api",
  "arguments": {
    "purpose": "ユーザー情報の取得"
  }
}

返却例:

{
  "toolResult": [
    {
      "service": "サンプル API",
      "path": "/users/{userId}",
      "method": "GET",
      "description": "ID で指定されたユーザー情報を取得します"
    },
    {
      "service": "サンプル API", 
      "path": "/users",
      "method": "GET",
      "description": "すべてのユーザーのリストを取得します"  
    }
  ]
}

📚 ドキュメント

server.config.ts ファイルを編集して、新しいサービス設定を追加します。

プロジェクトのビルド

npm run build

テスト

1. すべてのテストを実行します：

npm test

2. ウォッチモードでテストを実行します（開発に便利）:

npm run test:watch

3. カバレッジレポートを生成します:

npm run test:coverage

ディレクトリ構造

api-mcp-server/
├── src/
│   ├── index.ts        # メインサーバーコード
│   ├── utils.ts        # ユーティリティ関数
│   ├── types.ts        # 型定義
│   └── tests/          # テストファイル
├── schemas/            # OpenAPI サービス仕様ファイル
├── server.config.ts    # サーバー設定
├── tsconfig.json       # TypeScript 設定
└── package.json        # プロジェクト依存関係管理

📄 ライセンス

MIT License

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

問題の提出やコードの貢献を歓迎します！