Swagger/OpenAPI

Provides an MCP interface to load, browse, and inspect Swagger/OpenAPI specifications.

typescript

14

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "gulbaki-swagger-mcp-server": {
      "command": "node",
      "args": [
        "/path/to/your/swagger-mcp-server/build/index.js"
      ]
    }
  }
}

You can load, browse, and inspect Swagger/OpenAPI specifications through this MCP server, enabling you to explore API endpoints and their details programmatically via an MCP client.

How to use

You connect an MCP client to this server to load OpenAPI/Swagger specifications, then browse endpoints and get detailed operation information. Start by loading an API specification with a unique apiId and a source URL or file path. Once loaded, you can list all loaded APIs, view the endpoints for a chosen API, fetch detailed information for a specific endpoint, and search endpoints by a pattern. The server also exposes resource-like views you can query to get overview information, a list of endpoints, or details about a single endpoint. Use these capabilities to build tools, chat assistants, or automated workflows that reason about API structures and usage.

Key actions you can perform with an MCP client include:

How to install

Prerequisites you need before installation: Node.js and npm.

# Check Node.js and npm versions
node -v
npm -v

# Create or move into your project directory
mkdir swagger-mcp-server
cd swagger-mcp-server

# Install dependencies
npm install

# Build the TypeScript code
npm run build

# Run the server locally (example runtime command)
node build/index.js

Claude Desktop configuration

To use this server with Claude Desktop, provide the following MCP server configuration in your Claude setup.

{
  "mcpServers": {
    "swagger_explorer": {
      "command": "node",
      "args": ["/path/to/your/swagger-mcp-server/build/index.js"]
    }
  }
}

Replace /path/to/your/swagger-mcp-server with the actual path to your project directory.

## Additional notes

This server exposes endpoints that let you load specifications, browse available endpoints, retrieve detailed operation information, and search for endpoints by pattern. It also provides resource views you can query for quick insights into a loaded API.

## Available tools

### load\_api

Load an OpenAPI/Swagger specification into the server using a unique apiId and a source URL or file path.

### get\_endpoint\_details

Retrieve detailed information about a specific API endpoint, including method, path, and an optional natural language summary.

### list\_apis

List all currently loaded API specifications.

### search\_endpoints

Search for endpoints matching a specific pattern within a loaded API by apiId.