モデルコンテキストプロトコル(MCP)サーバーで、OpenAPIエンドポイントをMCPツールとして公開し、MCPプロンプトやリソースのオプションサポートも備えています。このサーバーにより、大規模言語モデルはMCPプロトコルを通じてOpenAPI仕様で定義されたREST APIを発見し、操作できます。

📖 ドキュメント

• ユーザーガイド - このMCPサーバーをClaude Desktop、カーソル、その他のMCPクライアントと組み合わせて使いたいユーザー向け
• ライブラリの利用 - このパッケージをライブラリとして使うカスタムMCPサーバーを作成する開発者向け
• 開発者ガイド - コードベースに関わる貢献者や開発者向け
• AuthProvider ガイド - 詳細な認証パターンと例

---

ユーザーガイド

このセクションでは、エンドユーザーとしてClaude Desktop、カーソル、その他のMCP互換ツールを使ってMCPサーバーを使用する方法を扱います。

概要

このMCPサーバーは2つの方法で使用できます。

1. CLIツール:コマンドライン引数と直接連携してnpx @ivotoby/openapi-mcp-serverを使い、素早い設定をしてください
2. Library:OpenAPIServerクラスをインポートし、カスタム実装用のNode.jsアプリケーションで使用してください

サーバーは2つの伝送方法をサポートしています:

OpenAPI MCP Server

A Model Context Protocol (MCP) server that exposes OpenAPI endpoints as MCP tools, along with optional support for MCP prompts and resources. This server allows Large Language Models to discover and interact with REST APIs defined by OpenAPI specifications through the MCP protocol.

📖 Documentation

• User Guide - For users wanting to use this MCP server with Claude Desktop, Cursor, or other MCP clients
• Library Usage - For developers creating custom MCP servers using this package as a library
• Developer Guide - For contributors and developers working on the codebase
• AuthProvider Guide - Detailed authentication patterns and examples

---

User Guide

This section covers how to use the MCP server as an end user with Claude Desktop, Cursor, or other MCP-compatible tools.

Overview

This MCP server can be used in two ways:

1. CLI Tool: Use npx @ivotoby/openapi-mcp-server directly with command-line arguments for quick setup
2. Library: Import and use the OpenAPIServer class in your own Node.js applications for custom implementations

The server supports two transport methods:

1. Stdio Transport (default): For direct integration with AI systems like Claude Desktop that manage MCP connections through standard input/output.
2. Streamable HTTP Transport: For connecting to the server over HTTP, allowing web clients and other HTTP-capable systems to use the MCP protocol.

Quick Start for Users

Option 1: Using with Claude Desktop (Stdio Transport)

No need to clone this repository. Simply configure Claude Desktop to use this MCP server:

1. Locate or create your Claude Desktop configuration file:

   • On macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

2. Add the following configuration:

{
  "mcpServers": {
    "openapi": {
      "command": "npx",
      "args": ["-y", "@ivotoby/openapi-mcp-server"],
      "env": {
        "API_BASE_URL": "https://api.example.com",
        "OPENAPI_SPEC_PATH": "https://api.example.com/openapi.json",
        "API_HEADERS": "Authorization:Bearer token123,X-API-Key:your-api-key"
      }
    }
  }
}

3. Replace the environment variables with your actual API configuration:
   • API_BASE_URL: The base URL of your API
   • OPENAPI_SPEC_PATH: URL or path to your OpenAPI specification
   • API_HEADERS: Comma-separated key:value pairs for API authentication headers

Option 2: Using with HTTP Clients (HTTP Transport)

To use the server with HTTP clients:

1. No installation required! Use npx to run the package directly:

npx @ivotoby/openapi-mcp-server \
  --api-base-url https://api.example.com \
  --openapi-spec https://api.example.com/openapi.json \