@openapi-mcp/server

Name: @openapi-mcp/server
Author: sotayamashita

@sotayamashita

@openapi-mcp/server について

Powerful bridge between OpenAPI specifications and AI assistants using the Model Context Protocol (MCP). Automatically converts any OpenAPI/Swagger API specification into MCP tools that can be used by AI assistants like Claude Desktop.

#api #cli #ai #server #tool #mcp #swagger #openapi #bridge #oas #llm #model-context-protocol #mcp-server #mcp-tools

基本情報

カテゴリ

開発者ツール

ライセンス

MIT

ランタイム

node

トランスポート

stdio

公開者

sotayamashita

設定

以下の設定を使って、このサーバーを MCP 対応クライアントに追加してください。

{
  "mcpServers": {
    "openapi-mcp-server-sotayamashita": {
      "command": "bun",
      "args": [
        "run",
        "src/index.ts",
        "./path/to/openapi.yml"
      ]
    }
  }
}

ツール

ツールは検出されませんでした

ツールは README から自動的に抽出されます。メンテナーは ## Tools という見出しの下に記載することで、このタブに反映できます。

概要

What is @openapi-mcp/server?

@openapi-mcp/server is a bridge between OpenAPI specifications and AI assistants using the Model Context Protocol (MCP). It automatically converts any OpenAPI/Swagger API specification into MCP tools that AI assistants like Claude Desktop can use to interact with your APIs. It is for developers who want to make their REST APIs accessible to AI assistants without custom integrations.

How to use @openapi-mcp/server?

Clone the repository, install dependencies with bun install, then run bun run src/index.ts with a path to a local OpenAPI file or --api with a URL. Configure the required BASE_URL environment variable and optional HEADERS environment variable. Integrate with Claude Desktop or Cursor by adding the server to their MCP configuration.

Key features of @openapi-mcp/server

Automatically converts OpenAPI/Swagger specs into MCP tools
Supports OpenAPI v3.0.0 and v3.1.0
Supports HTTP Basic, Bearer token, and header-based API key auth
Works with local files or remote API specification URLs
Configurable custom HTTP headers

Use cases of @openapi-mcp/server

AI assistants performing real-world actions through your APIs
Converting any REST API with an OpenAPI spec into AI-accessible tools
Enabling Claude Desktop to interact with custom services without custom integrations

FAQ from @openapi-mcp/server

What OpenAPI versions and authentication methods are supported?

OpenAPI v3.0.0 and v3.1.0 are supported. Authentication includes HTTP Basic, static Bearer tokens, and header-based API keys. OpenAPI v2.0 (Swagger), OAuth 2.0, OpenID Connect, query param API keys, cookie auth, and dynamic JWT are not supported.

Is an `operationId` required for every operation?

Yes, every operation in your specification must have a unique operationId. The server will fail to start or process the specification if any operation is missing this field.

What are the runtime dependencies for @openapi-mcp/server?

The server requires Bun as the JavaScript runtime. Dependencies are installed via bun install. The server runs as a CLI process via MCP’s stdio transport.

How do I configure the server for use with Claude Desktop?

Add the server to your Claude Desktop configuration, specifying the bun command and path to the server script, along with the required BASE_URL environment variable and optional HEADERS for authentication.