Swagger Explorer

by johnneerdael

17 stars
Not rated
GitHub

About

Analyzes and interacts with Swagger/OpenAPI specifications to enable dynamic API exploration, endpoint filtering, and schema validation for developers working with unfamiliar APIs.

Details

Author
johnneerdael
Repository
johnneerdael/swagger-mcp
GitHub stars
17
Categories
Developer Tools, Design, Workplace, File Management, AI, Project Management, Knowledge Base, Frontend
Tags
#web

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Swagger Explorer
    Command (node, npx, python, etc.) npx
    Arguments
    • Argument 1 @johnneerdael/swagger-mcp
    • Argument 2 --swagger-url=$SWAGGER_URL
    Environment
    • PORT 3000
    • BASE_URL
    • AUTH_TOKEN your-token
    • SWAGGER_URL $$SWAGGER_URL

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install and run globally using npx:

npx -y @johnneerdael/swagger-mcp

Or install with environment variables:

npx -y @johnneerdael/swagger-mcp \
--env BASE_URL=/api \
--env AUTH_TOKEN=your-token \
--env PORT=3000

1. Open Claude Desktop
2. Click on Settings (gear icon)
3. Select "Tools & Integrations"
4. Click "Add MCP Server"
5. Enter the following:

   Name: Swagger Explorer
Command: npx -y @johnneerdael/swagger-mcp
Arguments: --swagger-url=$SWAGGER_URL

6. Click "Install"

Here are some example interactions with Claude:

Explore API

Fetch and analyze the Swagger documentation from a specified URL. Parameters: url (string), options (object with paths and schemas flags)

Get Schema Details

Retrieve detailed information about a specific schema. Parameters: url (string), schemaName (string)

Get Response Schemas

Fetch the response schemas for a specific API endpoint. Parameters: url (string), path (string), method (string)

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "swagger explorer": {
            "env": {
                "PORT": "3000",
                "BASE_URL": "",
                "AUTH_TOKEN": "your-token",
                "SWAGGER_URL": "$$SWAGGER_URL"
            },
            "args": [
                "@johnneerdael/swagger-mcp",
                "--swagger-url=$SWAGGER_URL"
            ],
            "command": "npx"
        }
    }
}

Linux

{
    "env": {
        "PORT": "3000",
        "BASE_URL": "",
        "AUTH_TOKEN": "your-token",
        "SWAGGER_URL": "$$SWAGGER_URL"
    },
    "args": [
        "@johnneerdael/swagger-mcp",
        "--swagger-url=$SWAGGER_URL"
    ],
    "command": "npx"
}

Macos

{
    "env": {
        "PORT": "3000",
        "BASE_URL": "",
        "AUTH_TOKEN": "your-token",
        "SWAGGER_URL": "$$SWAGGER_URL"
    },
    "args": [
        "@johnneerdael/swagger-mcp",
        "--swagger-url=$SWAGGER_URL"
    ],
    "command": "npx"
}

Windows

{
    "env": {
        "PORT": "3000",
        "BASE_URL": "",
        "AUTH_TOKEN": "your-token",
        "SWAGGER_URL": "$$SWAGGER_URL"
    },
    "args": [
        "/c",
        "npx",
        "-y",
        "@johnneerdael/swagger-mcp",
        "--swagger-url=$SWAGGER_URL"
    ],
    "command": "cmd"
}

Swagger Explorer MCP

A Management Control Plane (MCP) server for exploring and analyzing Swagger/OpenAPI specifications through Claude.

Quick Start

Install and run globally using npx:

npx -y @johnneerdael/swagger-mcp

Or install with environment variables:

npx -y @johnneerdael/swagger-mcp \
--env BASE_URL=/api \
--env AUTH_TOKEN=your-token \
--env PORT=3000

Installation for Claude Desktop

1. Open Claude Desktop
2. Click on Settings (gear icon)
3. Select "Tools & Integrations"
4. Click "Add MCP Server"
5. Enter the following:

   Name: Swagger Explorer
Command: npx -y @johnneerdael/swagger-mcp
Arguments: --swagger-url=$SWAGGER_URL

6. Click "Install"

Usage with Claude

Here are some example interactions with Claude:

Basic Swagger Exploration

```

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.