MCP Openapi Schema Explorer

🚀 Explore OpenAPI Specifications with MCP Resource Templates

This project enables users to explore and understand OpenAPI specifications through MCP resource templates. It provides a set of templates to access various parts of an OpenAPI document, making it easier to analyze and interact with API specifications.

🚀 Quick Start

📦 Installation

First, install the required dependencies:

pip install -r requirements.txt

🚀 Starting the Service

After the installation is complete, start the service:

python server.py

✨ Features

MCP offers multiple resource templates for exploring and understanding OpenAPI specifications. Here's a detailed breakdown of each template:

openapi://{field}

• Description: This template is used to access top - level fields in an OpenAPI document (such as info, servers, tags), or list the contents of paths and components. The available fields depend on the loaded specification.
• Example:
  • Request: openapi://info
  • Response: Returns the content of the info field in JSON/YAML/minified JSON format.
  • Autocomplete: Provides dynamic suggestions for {field} based on the top - level keys in the actual document.
• Parameters: None

openapi://paths/{path}

• Description: Lists all HTTP methods (operations) supported by a specific API path.
• Parameters:
  • {path}: The API path string. Must be URL - encoded (e.g., /users/{id} should be encoded as users%2F%7Bid%7D).
• Example:
  • Request: openapi://paths/users%2F%7Bid%7D
  • Response: Lists all HTTP methods supported by this path in text format.
  • Autocomplete: Provides dynamic suggestions for {path} based on all paths in the document (after URL encoding).

openapi://paths/{path}/{method*}

• Description: Retrieves detailed specifications for one or more HTTP methods on a specific API path.
• Parameters:
  • {path}: The API path string. Must be URL - encoded.
  • {method*}: One or more HTTP methods (e.g., get, post), supporting comma - separated values (e.g., get,post). Case - insensitive.
• Example:
  • Single method: openapi://paths/users%2F%7Bid%7D/get
  • Multiple methods: openapi://paths/users%2F%7Bid%7D/get,post
• Output Format: Returns detailed specifications in JSON/YAML/minified JSON format.
• Autocomplete: Provides dynamic suggestions for {path} and static suggestions for {method*} (common HTTP verbs like GET, POST, PUT, DELETE, etc.).

openapi://components/{type}

• Description: Lists all defined components of a specific type (e.g., schemas, responses, parameters) along with a short description. The available types depend on the loaded specification.
• Example:
  • Request: openapi://components/schemas
  • Response: Lists all schemas components and their descriptions in text format.
  • Autocomplete: Provides dynamic suggestions for {type} based on the component types in the document.

openapi://components/{type}/{name}

• Description: Retrieves detailed information about a specific component type, such as the specific definition of a schema, response, or parameter.
• Parameters:
  • {type}: The type of the component (e.g., schemas).
  • {name}: The specific name or identifier of the component.
• Example:
  • Request: openapi://components/schemas/User
  • Response: Returns the detailed definition of the User component in JSON/YAML format.

🤝 Contribution Guidelines

📥 Submitting Code

First, clone the repository:

git clone https://github.com/yourusername/mcp.git
cd mcp

🔨 Development Process

# Install dependencies
pip install -r requirements.txt

# Start the development server
python server.py

🚀 Release Process

📦 Packaging

python setup.py sdist bdist_wheel

🚀 Publishing to PyPI

twine upload dist/*

🚧 Future Plans

• Support more OpenAPI versions.
• Increase the ability to parse other API formats.
• Provide an interactive interface to enhance the user experience.

In summary, this README details how to use MCP resource templates to explore and understand OpenAPI specifications. These templates allow you to easily access various API information and conduct in - depth analysis.