opamcp

You can give an OpenAPI spec URL to this MCP server and your AI will navigate the API structure on its own, answering questions about endpoints, schemas, and usage without loading the entire spec every time.

How to use

Use a compatible MCP client to connect to the server. Start with a remote OpenAPI URL to let your AI explore the API layout, endpoints, and data types.

How to use

Start quickly with a single command that initializes the MCP client to read an OpenAPI spec.

How to use

npx -y opamcp https://petstore3.swagger.io/api/v3/openapi.json

Claude Desktop / Cursor Setup

{
  "mcpServers": {
    "my-api": {
      "command": "npx",
      "args": ["-y", "opamcp", "https://your-api.com/openapi.json"]
    }
  }
}

What can it do

You can inspect and search the API with a set of purpose-built tools.

What can it do

The tools include getting a high-level API description, listing groups (tags), browsing endpoints, filtering by tag, deep-diving into a specific endpoint, listing data types, viewing a schema, searching by keywords, and refreshing the spec when it changes.

Examples

나: "이 API 뭐야?"
AI: (get_api_info 호출) "아, 펫샵 API네요. 반려동물 관리하는..."

나: "주문 관련 API 있어?"
AI: (search_endpoints 'order' 호출) "네, 주문 생성, 조회, 삭제 API가 있네요"

나: "주문 생성 어떻게 해?"
AI: (get_endpoint_detail '/store/order' 'post' 호출) "이렇게 하시면 됩니다..."

Development

To run and develop locally, install dependencies, start a local dev server, and build the project.

Development

bun install          # 의존성 설치
bun run dev <url>    # 로컬 실행
bun run build        # 빌드

License

MIT - 자유롭게 사용 가능합니다.

English

This section mirrors the same usage and setup steps in English for convenience.

Development

bun install          # Install deps
bun run dev <url>    # Run locally
bun run build        # Build

Available tools

get_api_info

Fetches a high-level description of what the API does so you can understand its purpose quickly.

list_tags

Lists the API groups or tags to show how the API is organized.

list_endpoints

Browses all endpoints to get an overview of available operations.

get_endpoints_by_tag

Filters endpoints by a specific tag to focus on a subset.

get_endpoint_detail

Provides an in-depth view of a single endpoint, including parameters and responses.

list_schemas

Displays available data types and schemas used by the API.

get_schema

Retrieves a full schema definition for a specified model.

search_endpoints

Searches endpoints by keywords to find relevant operations.

refresh_spec

Reloads the OpenAPI spec if it has changed to reflect updates.