Api MCP Server

🚀 API MCP Server

MCPプロトコルを使用してAPIツールを定義および実行するための軽量かつ拡張可能なサーバーです。動的なHTTPリクエスト、型付き引数、および複数のトランスポート（stdio、sse）をサポートします。

🚀 クイックスタート

このセクションでは、API MCP Serverのインストール方法や使用方法について説明します。

📦 インストール

サーバーのインストール方法は2通りあります。

1. go install を使用してインストール

Goがインストールされている場合は、以下のコマンドを実行します。

go install github.com/AdamShannag/api-mcp-server/cmd/api-mcp-server@v0.2.0

2. 事前ビルド済みのバイナリをダウンロード

リリースページからバイナリをダウンロードします。

📚 ドキュメント

CLIフラグ

環境変数

ツール構成のプレースホルダー

ツール構成ファイルでは、以下の構文を使用して環境変数の置換をサポートしています。

{{env VAR_NAME:default_value}}

実行時に、プレースホルダーは対応する環境変数に置き換えられます。変数が設定されていない場合は、default_value が代わりに使用されます。

例

"host": "{{env API_HOST:jsonplaceholder.typicode.com}}"

API_HOST が設定されている場合はその値を使用し、設定されていない場合はデフォルト値を使用します。

"Authorization": "Bearer {{env API_KEY:not-set}}"

API_KEY が定義されている場合はその値を使用し、定義されていない場合は "not-set" を使用します。

サーバーを実行する前に、必要な環境変数を設定します。

export API_HOST=myapi.example.com
export API_KEY=supersecret123

認証

SSEトランスポートを使用する場合、API_MCP_SSE_API_KEY 環境変数を設定することで、Bearerトークンを使用してエンドポイントをセキュアにすることができます。

例

export API_MCP_SSE_API_KEY="your-secret-key"
api-mcp-server --transport sse --config ./demo.tools.json

着信するSSE接続は、Authorization ヘッダーに一致するトークンを提供する必要があります。

ツール構成 (JSON)

サーバーは、1つ以上のツールを定義するJSON構成ファイルを受け入れます。各ツールには、メタデータ（name、description）、HTTPリクエスト情報、およびLLMから必要な入力値を定義する args のリストが含まれます。

各ツール構成には以下が含まれます。

• 一意の name
• LLMに表示される description
• HTTP呼び出しを記述する request オブジェクト
• 予期される入力を定義する args のリスト

ツール引数 (args)

引数はLLMから収集される入力です。各引数は、リクエストの1つ以上の部分で使用される可能性があります。

• パスパラメータ → endpoint 内で直接置き換えられます。
• クエリパラメータ → URLに自動的に追加されます。
• ボディ → 生のリクエストボディ文字列として挿入されます。

ホスト (host)

host はターゲットAPIのドメインです（例: gitlab.com）。

"host": "{{env GITLAB_API_HOST:gitlab.com}}"

メソッド (method)

HTTPメソッド（GET、POST、PUT など）です。

"method": "POST"

パスパラメータ (pathParams)

endpoint 内の変数を置き換えるために使用されます。例えば、

"endpoint": "/api/v4/projects/:project_id/pipeline",
"pathParams": ["project_id"]

project_id = "MyProject/test" の場合、最終的なエンドポイントは以下のようになります。

/api/v4/projects/MyProject%2Ftest/pipeline

クエリパラメータ (queryParams)

ここにリストされたキーは、クエリ文字列パラメータとしてエンドポイントに自動的に追加されます。

"endpoint": "/api/v4/projects/:project_id/pipeline",
"queryParams": ["ref"]

ref = "main" の場合、結果は以下のようになります。

/api/v4/projects/MyProject%2Ftest/pipeline?ref=main

リクエストボディ (body)

body フィールドは単一の引数名にマッピングされます。その値は生のリクエストボディ文字列として使用されます。

例

"body": "issue_payload"

以下の引数が与えられた場合、

{
  "name": "issue_payload",
  "type": "string",
  "required": true,
  "description": "A JSON object like {\"title\": \"Bug report\"}"
}

サーバーに送信されるボディは issue_payload の正確な文字列値になります。

ヘッダー (headers)

リクエストに含める静的または動的なHTTPヘッダーを定義します。例えば、トークンやコンテンツタイプなどです。

"headers": {
"PRIVATE-TOKEN": "{{env GITLAB_TOKEN:not-set}}",
"Content-Type": "application/json"
}

セキュア (secure)

secure: true の場合、リクエストは https を使用します。省略された場合または false の場合、http を使用します。

完全な例

{
  "name": "TriggerPipeline",
  "description": "Triggers a pipeline in GitLab for a specific project and branch.",
  "request": {
    "host": "{{env GITLAB_API_HOST:gitlab.com}}",
    "method": "POST",
    "secure": true,
    "endpoint": "/api/v4/projects/:project_id/pipeline",
    "headers": {
      "PRIVATE-TOKEN": "{{env GITLAB_TOKEN:not-set}}"
    },
    "queryParams": [
      "ref"
    ],
    "pathParams": [
      "project_id"
    ]
  },
  "args": [
    {
      "name": "project_id",
      "type": "string",
      "required": true,
      "description": "..."
    },
    {
      "name": "ref",
      "type": "string",
      "required": true,
      "description": "..."
    }
  ]
}

project_id = "MyProject/test" かつ ref = "main" の場合、最終的なHTTPリクエストは以下のようになります。

POST https://gitlab.com/api/v4/projects/MyProject%2Ftest/pipeline?ref=main
Headers:
  PRIVATE-TOKEN: <value from GITLAB_TOKEN>

使用例

このリポジトリには、さまざまなユースケースを示すためのいくつかのツール構成例が含まれています。これらはすぐに使用できるAPIではなく、参考として提供されています。

• GitLab Issues GitLabプロジェクト内のイシューを一覧表示および作成するためのツールです。 examples/gitlab を参照してください。

• JSONPlaceholder Todos JSONPlaceholder パブリックAPIとやり取りするツールです。 examples/jsonplaceholder を参照してください。

📄 ライセンス

MIT

🤝 コントリビューション

質問がある場合やコントリビュートしたい場合は、自由にイシューまたはPRを作成してください。