Openapi To MCP Server

🚀 OpenAPI to MCP Configuration Tool

This tool converts OpenAPI specifications into MCP configurations, offering a range of features to streamline the process.

🚀 Quick Start

Installation

# Installation command is not provided in the original document, so this section is skipped.

Usage

openapi-to-mcp --input api-spec.json --output mcp-server.yaml --server-name my-server --template template.yaml

✨ Features

• Path Conversion: Convert OpenAPI paths to MCP configurations.
• File Format Support: Support OpenAPI specifications in JSON and YAML formats.
• Configuration Generation: Generate MCP configurations containing server and tool definitions.
• Parameter Description Preservation: Retain parameter descriptions and type information.
• Automatic Position Setting: Automatically set the position field based on OpenAPI parameter positions.
• Multiple Parameter Types: Support path, query, header, cookie, and body parameters.
• Response Template Generation: Generate response templates with field descriptions and improved formats for better LLM understanding.
• Optional Specification Validation: Provide OpenAPI specification validation (disabled by default).
• Template Patching Support: Support custom modifications to generated configurations based on templates.

📦 Installation

No specific installation steps are provided in the original document, so this section is skipped.

💻 Usage Examples

Basic Usage

openapi-to-mcp --input api-spec.json --output mcp-server.yaml --server-name my-server

Advanced Usage

# Use the template patch feature to customize the generated configuration
openapi-to-mcp --input api-spec.json --output mcp-server.yaml --server-name my-server --template template.yaml

📚 Documentation

Template Patch Feature

You can specify a YAML file using the --template flag to patch the generated configuration. This is useful for adding common headers, authentication information, or other custom configurations.

Example template file:

server:
  config:
    apiKey: ""

tools:
  requestTemplate:
    headers:
      - key: Authorization
        value: "APPCODE {{.config.apiKey}}"
      - key: X-Ca-Nonce
        value: "{{uuidv4}}"

After applying the template, the following operations will be performed:

1. Add the apiKey field to the server configuration.
2. Add the specified headers to the configuration of all tools.

Placeholders in the template, such as {{.config.apiKey}} or "{{uuidv4}}", are not processed by this tool and are directly retained in the output file for use by the MCP server at runtime.