higress-group/openapi-to-mcpserver

A tool to convert OpenAPI specifications to MCP (Model Context Protocol) server configurations.
## Installation
bash
go install github.com/higress-group/openapi-to-mcpserver/cmd/openapi-to-mcp@latest
## Usage
bash
openapi-to-mcp --input path/to/openapi.json --output path/to/mcp-server.yaml
### Options
--input: Path to the OpenAPI specification file (JSON or YAML) (required)
--output: Path to the output MCP configuration file (YAML) (required)
--server-name: Name of the MCP server (default: "openapi-server")
--tool-prefix: Prefix for tool names (default: "")
--format: Output format (yaml or json) (default: "yaml")
--validate: Validate the OpenAPI specification (default: false)
--template: Path to a template file to patch the output (default: "")
## Example
bash
openapi-to-mcp --input petstore.json --output petstore-mcp.yaml --server-name petstore
### Converting OpenAPI to Higress REST-to-MCP Configuration
This tool can be used to convert an OpenAPI specification to a Higress REST-to-MCP configuration. Here's a complete example:
1. Start with an OpenAPI specification (petstore.json):
json
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "Swagger Petstore",
"description": "A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification"
},
"servers": [
"url": "http://petstore.swagger.io/v1"
],
"paths": {
"/pets": {
"get": {
"summary": "List all pets",
"operationId": "listPets",
"parameters": [
"name": "limit",
"in": "query",
"description": "How many items to return at one time (max 100)",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
],
"responses": {
"200": {
"description": "A paged array of pets",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"pets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier for the pet"
},
"name": {
"type": "string",
"description": "Name of the pet"
},
"tag": {
"type": "string",
"description": "Tag of the pet"
},
"nextPage": {
"type": "string",
"description": "URL to get the next page of pets"
},
"post": {
"summary": "Create a pet",
"operationId": "createPets",
"requestBody": {
"description": "Pet to add to the store",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"description": "Name of the pet"
},
"tag": {
"type": "string",
"description": "Tag of the pet"
},
"responses": {
"201": {
"description": "Null response"
},
"/pets/{petId}": {
"get": {
"summary": "Info for a specific pet",
"operationId": "showPetById",
"parameters": [
"name": "petId",
"in": "path",
"required": true,
"description": "The id of the pet to retrieve",
"schema": {
"type": "string"
],
"responses": {
"200": {
"description": "Expected response to a valid request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier for the pet"
},
"name": {
"type": "string",
"description": "Name of the pet"
},
"tag": {
"type": "string",
"description": "Tag of the pet"
2. Convert it to a Higress REST-to-MCP configuration:
bash
openapi-to-mcp --input petstore.json --output petstore-mcp.yaml --server-name petstore