Openapi Inspector

by Nonetss

369 downloads

Not rated

GitHub

About

Stop pasting API docs. Let your LLM dynamically navigate OpenAPI/Swagger specs and extract precise JSON schemas on-demand.

Details

Author: Nonetss
Downloads: 369
Categories: Developer Tools, API

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:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name Openapi Inspector

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

From the repository

Run the server directly with npx @nonetss/none.api (or install globally with npm install -g @nonetss/none.api). Configure it in your MCP client (e.g., claude_desktop_config.json) with the command npx -y @nonetss/none.api and set the OPENAPI_URL environment variable to point to your OpenAPI spec.

`list_endpoints`

STEP 1 (EXPLORATION): List all available endpoints. ALWAYS use this first to understand the API capabilities and available routes before developing any feature.

`get_endpoint_info`

STEP 2 (ANALYSIS): Get full technical details of a specific endpoint, including required parameters, headers, and response structure. Use this before writing any code.

`get_typescript_types`

FRONTEND (TYPING): Generate TypeScript interfaces for request bodies and response data. Essential for maintaining type safety in frontend development.

`get_zod_schema`

FRONTEND (VALIDATION): Generate Zod validation schemas for request or response bodies. Perfect for implementing form validation that matches backend rules.

`get_framework_snippet`

FRONTEND (IMPLEMENTATION): Generate complete code snippets for modern frameworks like Axios or TanStack Query, including error handling and types.

`validate_response`

BACKEND (TESTING): Validate a JSON object against the OpenAPI response schema. ALWAYS use this after writing backend code to verify your implementation matches the contract.

`get_mock_data`

FRONTEND (PROTOTYPING): Generate high-fidelity mock data that satisfies the OpenAPI schema. Use this to test UI components before the backend is fully ready.

`find_endpoint`

SEARCH: Find endpoints by intent or keyword (e.g., 'delete user', 'upload file'). Useful when you know what you want to do but not the exact route.

`map_dependencies`

ARCHITECTURE: Analyze ID relationships between endpoints. Use this to understand the data flow and which endpoint provides the ID required by another.

`search_by_tag`

Search for endpoints by tag.

`get_request_schema`

Get the JSON request body schema for an endpoint.

`get_response_schema`

Get the JSON response body schema for an endpoint.

`list_tags`

List all tags available in the OpenAPI specification.

`get_fetch_snippet`

Generate a fetch code snippet for an endpoint.

`get_security_info`

Get security requirements for the API or a specific endpoint.

`set_security_context`

Set authentication headers to be used for subsequent 'call_endpoint' requests.

`call_endpoint`

DEBUG: Execute a real HTTP request to the configured API to verify live behavior and connectivity.

Claude Desktop / Cursor

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

{
    "mcpServers": {
        "openapi inspector": {
            "none.api": {
                "command": "npx",
                "args": [
                    "-y",
                    "@nonetss/none.api"
                ],
                "env": {
                    "OPENAPI_URL": "http://localhost:3000/doc"
                }
            }
        }
    }
}

McpServers

{
    "none.api": {
        "command": "npx",
        "args": [
            "-y",
            "@nonetss/none.api"
        ],
        "env": {
            "OPENAPI_URL": "http://localhost:3000/doc"
        }
    }
}

none.api - OpenAPI Explorer MCP Server

--- <a name="english"></a>

English

Professional OpenAPI explorer for the Model Context Protocol (MCP).

What is this?

This MCP server allows Large Language Models (LLMs) like Claude or Cursor to dynamically explore, understand, and interact with any API that has an OpenAPI/Swagger specification. Unlike other servers that map every endpoint to a tool (which can overwhelm the model's context), none.api acts as an intelligent inspector. It allows the model to: - List available endpoints and methods. - Search operations by functional tags. - Retrieve detailed information and documentation for specific routes. - Extract precise JSON Schemas for requests and responses. - Understand the API structure without manual documentation pasting. Optimized for backends following the hono-template structure.

Installation

Using npx (Recommended)

Run the server directly without installation: ``

bash
npx @nonetss/none.api



Global Installation

bash
npm install -g @nonetss/none.api



MCP Configuration


Add this to your

claude_desktop_config.json

 or equivalent (like Cursor):

json
{
  "mcpServers": {
    "none.api": {
      "command": "npx",
      "args": ["-y", "@nonetss/none.api"],
      "env": {
        "OPENAPI_URL": "http://localhost:3000/doc"
      }
    }
  }
}



Features

- Endpoint Listing: Overview of all available routes.
- Tag Discovery: List functional sections of the API.
- Granular Schemas: Fetch specific JSON Schemas for precise code generation.
- Dynamic URLs: Ability to point to different OpenAPI specs on the fly.

---

<a name="español"></a>
Español


Explorador profesional de OpenAPI para el protocolo Model Context Protocol (MCP).

¿Qué es esto?


Este servidor MCP permite a los modelos de lenguaje (como Claude o Cursor) explorar, entender e interactuar dinámicamente con cualquier API que tenga una especificación OpenAPI/Swagger.

A diferencia de otros servidores que mapean cada endpoint a una herramienta (lo que puede saturar el contexto del modelo),

none.api

 actúa como un inspector inteligente. Permite al modelo:
- Listar endpoints y métodos disponibles.
- Buscar operaciones por etiquetas funcionales.
- Obtener información detallada y documentación de rutas específicas.
- Extraer esquemas JSON precisos para peticiones y respuestas.
- Entender la estructura de la API sin necesidad de pegar la documentación manualmente.

Optimizado para backends que siguen la estructura de hono-template.

Instalación


Usando npx (Recomendado)

Ejecuta el servidor directamente sin instalación previa:

bash
npx @nonetss/none.api



Instalación Global

bash
npm install -g @nonetss/none.api



Configuración de MCP


Añade esto a tu archivo

claude_desktop_config.json

 o equivalente (como Cursor):

json
{
  "mcpServers": {
    "none.api": {
      "command": "npx",
      "args": ["-y", "@nonetss/none.api"],
      "env": {
        "OPENAPI_URL": "http://localhost:3000/doc"
      }
    }
  }
}



Características

- Listado de Endpoints: Vista general de todas las rutas.
- Descubrimiento de Etiquetas: Listado de secciones funcionales de la API.
- Esquemas Granulares: Obtención de esquemas JSON específicos para generación de código precisa.
- URLs Dinámicas: Capacidad para apuntar a diferentes especificaciones OpenAPI en tiempo real.

---

Development / Desarrollo


1. Clone the repo / Clona el repositorio.
2.

npm install

3.

npm run build


4. Configure

OPENAPI_URL for testing / Configura OPENAPI_URL` para pruebas.

No reviews yet — be the first

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

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

list_endpoints

get_endpoint_info

get_typescript_types

get_zod_schema

get_framework_snippet

validate_response

get_mock_data

find_endpoint

map_dependencies

search_by_tag

get_request_schema

get_response_schema

list_tags

get_fetch_snippet

get_security_info

set_security_context

call_endpoint

Claude Desktop / Cursor

McpServers

none.api - OpenAPI Explorer MCP Server

English

What is this?

Installation

Using npx (Recommended)

Global Installation

MCP Configuration

Features

Español

¿Qué es esto?

Instalación

Usando npx (Recomendado)

Instalación Global

Configuración de MCP

Características

Development / Desarrollo

Install

More like this

Sentry

Github

Git

GitLab

Context 7

Playwright

`list_endpoints`

`get_endpoint_info`

`get_typescript_types`

`get_zod_schema`

`get_framework_snippet`

`validate_response`

`get_mock_data`

`find_endpoint`

`map_dependencies`

`search_by_tag`

`get_request_schema`

`get_response_schema`

`list_tags`

`get_fetch_snippet`

`get_security_info`

`set_security_context`

`call_endpoint`