Apidog-MCP-Server-npm

Apidog MCPサーバー ApidogプロジェクトからのAPIドキュメントをAIを搭載したIDESのデータソースとして使用できます カーソル。これは、エージェントAIがAPIドキュメントに直接アクセスして作業し、開発をスピードアップし、ワークフローをより効率的にすることができることを意味します。

Apidog MCPサーバーを使用すると、開発者はAIアシスタントを活用できます。

• APIドキュメントに基づいてコードを生成または変更します。
• APIドキュメントコンテンツを検索します。
• そしてもっともっと！あなたの想像力とあなたのチームの創造性を導きましょう。 😜

Apidog MCPサーバーがセットアップされると、ローカルマシンのAPIDOGプロジェクトからすべてのAPIドキュメントデータを自動的に読み取り、キャッシュします。 AIは、このデータをシームレスに取得および利用できます。

APIドキュメントで達成したいことをAIに指示するだけです。ここにいくつかの例があります：

1. コードを生成します「MCPを使用してAPIドキュメントを取得し、「製品」スキーマと関連するスキーマのJavaレコードを生成します」。
2. DTOを更新します：「APIドキュメントに基づいて、新しいフィールドを「製品」DTOに追加します」。
3. コメントを追加します：「APIドキュメントに基づいて「製品」クラスの各フィールドにコメントを追加します」。
4. MVCコードを作成します：「APIドキュメントに従って、エンドポイント「/ユーザー」に関連するすべてのMVCコードを生成します」。

• node.js （バージョン18以降、できれば最新のLTSバージョン）。
• 次のようなMCPをサポートするIDE
  • カーソル
  • VSコード +クラインプラグイン

ステップ 1。 Apidogでアクセストークンを生成します

• apidogを開いて、右上隅のアバターの上にホバリングして、クリックします Account Settings > API Access Token。
• 新しいAPIアクセストークンを作成します（詳細については、ヘルプドキュメントを参照してください）。
• アクセストークンをコピーして交換します 以下の構成ファイル。

ステップ2。ApidogプロジェクトIDを取得します

• Apidogで目的のプロジェクトを開きます。
• プロジェクトをクリックします Settings 左側のサイドバーで、コピーします Project ID から Basic Settings ページ。
• プロジェクトIDをコピーして交換します 以下の構成ファイル。

ステップ3。IDEを構成します

• 次のJSON構成コードをコピーして、IDEのMCP構成ファイルに追加します。

{
  "mcpServers": {
    "API docuemntation": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--project-id="
      ],
      "env": {
        "APIDOG_ACCESS_TOKEN": ""
      }
    }
  }
}

あなたがいるなら Windows また、上記の構成ファイルが機能していません。代わりに以下の構成ファイルを使用してみてください。

{
  "mcpServers": {
    "API docuemntation": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apidog-mcp-server@latest",
        "--project-id="
      ],
      "env": {
        "APIDOG_ACCESS_TOKEN": ""
      }
    }
  }
}

• IDEのMCPファイルにコピーされたJSON構成コードを追加します。
  • のために カーソル：グローバルに追加します ~/.cursor/mcp.json またはプロジェクト固有 .cursor/mcp.json。**
  • のために クライン：Clineパネルを開き> MCPサーバー> MCPサーバーを構成します。

• 交換する そして 個人的なAPIDOG APIアクセストークンとプロジェクトIDを使用してください。
• MCPサーバーに似たような名前を付けます 「APIドキュメント」 または 「XXX APIドキュメント」 AIがその目的を認識できるようにするため。 AIを混乱させる可能性があるため、「Apidog」や「Apidog MCP」などの一般的な名前を避けてください。
• いくつかのプロジェクトからAPIドキュメントを使用する必要がある場合は、複数のMCPサーバー構成を構成ファイルに追加するだけです。各プロジェクトには独自のユニークなものが必要です 。明確にするには、フォーマットに従って各MCPサーバーに名前を付けます 「XXX APIドキュメント」。
• チームがMCP構成ファイルをコードリポジトリに同期する場合は、行を削除することをお勧めします "APIDOG_ACCESS_TOKEN": "" 代わりに、を構成します APIDOG_ACCESS_TOKEN トークンの漏れを防ぐために、各メンバーのマシンの環境変数として。
• オンプレミスの展開のユーザーの場合、次のパラメーターをIDEのMCP構成ファイルに追加します： “-apidog-api-base-url =“。さらに、アクセスできることを確認してください www.npm.com きちんと。
• Apidogプロジェクトに加えて、Apidog MCPサーバーには、SwaggerまたはOpenapi仕様（OAS）ファイルを直接読み取ることができます。この機能を使用するには：
  • を削除します --project-id= パラメーター。
  • 追加します--oas=などのパラメーター npx apidog-mcp-server --oas https://petstore.swagger.io/v2/swagger.json または npx apidog-mcp-server --oas ～/data/petstore/swagger.json。

Apidog MCPサーバー 現在ベータ版です。あなたのフィードバックと提案を聞きたいです！参加してください 不和 または スラック サポートと更新のコミュニティ。