Openapi Navigator

Name: Openapi Navigator
Author: mgaruccio

@mgaruccio

代码仓库

关于 Openapi Navigator

MCP server for handling large openapi specs

#openapi #api-navigator #mcp-server

基本信息

分类

其他

传输方式

stdio

发布者

mgaruccio

提交者

Mike Garuccio

配置

使用下面的配置,将此服务器添加到你的 MCP 客户端。

{
  "mcpServers": {
    "openapi-navigator": {
      "command": "uvx",
      "args": [
        "openapi-navigator"
      ],
      "env": {}
    }
  }
}

工具

Load an OpenAPI specification from a local file. Args: file_path: Absolute path to the OpenAPI spec file (YAML or JSON) spec_id: Optional custom identifier for the spec. If not provided, will use 'file:{file_path}' Returns: The spec ID that was assigned to the loaded specification Note: File path must be absolute for security reasons.

Load an OpenAPI specification from a URL. Args: url: URL to the OpenAPI spec (YAML or JSON) spec_id: Optional custom identifier for the spec. If not provided, will use 'url:{url}' Returns: The spec ID that was assigned to the loaded specification

Unload an OpenAPI specification from memory. Args: spec_id: ID of the loaded spec to unload Returns: Confirmation message

List all currently loaded OpenAPI specifications. Returns: List of spec IDs that are currently loaded

Get the complete operation definition for a specific endpoint. Args: spec_id: ID of the loaded spec to query path: API path (e.g., '/users/{id}') method: HTTP method (e.g., 'GET', 'POST') Returns: The raw operation object from the OpenAPI spec, or None if not found

Search endpoints using fuzzy matching across paths, summaries, and operation IDs. To get a full list of all endpoints, use an empty string "" or a very short query like "a" as the search term. The search will return all endpoints with a relevance score of 100 when the query is very short. Args: spec_id: ID of the loaded spec to query query: Search query string. Use "" or "a" to get all endpoints. Returns: List of matching endpoints with relevance scores

Get a specific schema definition from a loaded OpenAPI specification. Args: spec_id: ID of the loaded spec to query schema_name: Name of the schema to retrieve Returns: The raw schema object from the OpenAPI spec, or None if not found

Search schema names using fuzzy matching. To get a full list of all schemas, use an empty string "" or a very short query like "a" as the search term. The search will return all schemas with a relevance score of 100 when the query is very short. Args: spec_id: ID of the loaded spec to query query: Search query string. Use "" or "a" to get all schemas. Returns: List of matching schema names with relevance scores

Get comprehensive metadata about a loaded OpenAPI specification. This includes information about the spec version, title, description, base path, servers, contact info, license, and counts of endpoints and schemas. Args: spec_id: ID of the loaded spec to query Returns: Dictionary containing spec metadata including base path and help text

概览

What is Openapi Navigator?

Openapi Navigator is an MCP server that makes OpenAPI specifications easily accessible to AI agents. It loads specs from local files or URLs and allows natural language searching of endpoints and schemas.

How to use Openapi Navigator?

Install the server with uvx openapi-navigator and add the JSON configuration to your MCP client settings. Once connected, use commands like load_spec, search_endpoints, and get_endpoint to explore and query OpenAPI specifications.