|
| 1 | +# Openapi-schema MCP Server |
| 2 | + |
| 3 | +OpenAPI Schema Model Context Protocol Server |
| 4 | + |
| 5 | +[What is an MCP Server?](https://www.anthropic.com/news/model-context-protocol) |
| 6 | + |
| 7 | +## Characteristics |
| 8 | +Attribute|Details| |
| 9 | +|-|-| |
| 10 | +**Image Source**|Official Image |
| 11 | +|**Author**|[slimslenderslacks](https://github.com/slimslenderslacks) |
| 12 | +**Repository**|https://github.com/slimslenderslacks/mcp-openapi-schema |
| 13 | +**Dockerfile**|https://github.com/slimslenderslacks/mcp-openapi-schema/blob/master/Dockerfile |
| 14 | +**Docker Image built by**|Docker Inc. |
| 15 | +**Docker Scout Health Score**|  |
| 16 | +**Licence**| |
| 17 | + |
| 18 | +## Available Tools |
| 19 | +Tools provided by this Server|Short Description |
| 20 | +-|- |
| 21 | +`get-component`|Gets detailed definition for a specific component| |
| 22 | +`get-endpoint`|Gets detailed information about a specific API endpoint| |
| 23 | +`get-examples`|Gets examples for a specific component or endpoint| |
| 24 | +`get-path-parameters`|Gets the parameters for a specific path| |
| 25 | +`get-request-body`|Gets the request body schema for a specific endpoint| |
| 26 | +`get-response-schema`|Gets the response schema for a specific endpoint, method, and status code| |
| 27 | +`list-components`|Lists all schema components (schemas, parameters, responses, etc.)| |
| 28 | +`list-endpoints`|Lists all API paths and their HTTP methods with summaries, organized by path| |
| 29 | +`list-security-schemes`|Lists all available security schemes| |
| 30 | +`search-schema`|Searches across paths, operations, and schemas| |
| 31 | + |
| 32 | +--- |
| 33 | +## Tools Details |
| 34 | + |
| 35 | +#### Tool: **`get-component`** |
| 36 | +Gets detailed definition for a specific component |
| 37 | +Parameters|Type|Description |
| 38 | +-|-|- |
| 39 | +`name`|`string`|Component name |
| 40 | +`openapiSchemaPath`|`string`|Path to the OpenAPI schema file |
| 41 | +`type`|`string`|Component type (e.g., schemas, parameters, responses) |
| 42 | + |
| 43 | +--- |
| 44 | +#### Tool: **`get-endpoint`** |
| 45 | +Gets detailed information about a specific API endpoint |
| 46 | +Parameters|Type|Description |
| 47 | +-|-|- |
| 48 | +`method`|`string`| |
| 49 | +`openapiSchemaPath`|`string`|Path to the OpenAPI schema file |
| 50 | +`path`|`string`| |
| 51 | + |
| 52 | +--- |
| 53 | +#### Tool: **`get-examples`** |
| 54 | +Gets examples for a specific component or endpoint |
| 55 | +Parameters|Type|Description |
| 56 | +-|-|- |
| 57 | +`openapiSchemaPath`|`string`|Path to the OpenAPI schema file |
| 58 | +`type`|`string`|Type of example to retrieve |
| 59 | +`componentName`|`string` *optional*|Component name (required for component examples) |
| 60 | +`componentType`|`string` *optional*|Component type (required for component examples) |
| 61 | +`method`|`string` *optional*|HTTP method (required for request/response examples) |
| 62 | +`path`|`string` *optional*|API path (required for request/response examples) |
| 63 | +`statusCode`|`string` *optional*|Status code (for response examples) |
| 64 | + |
| 65 | +--- |
| 66 | +#### Tool: **`get-path-parameters`** |
| 67 | +Gets the parameters for a specific path |
| 68 | +Parameters|Type|Description |
| 69 | +-|-|- |
| 70 | +`openapiSchemaPath`|`string`|Path to the OpenAPI schema file |
| 71 | +`path`|`string`| |
| 72 | +`method`|`string` *optional*| |
| 73 | + |
| 74 | +--- |
| 75 | +#### Tool: **`get-request-body`** |
| 76 | +Gets the request body schema for a specific endpoint |
| 77 | +Parameters|Type|Description |
| 78 | +-|-|- |
| 79 | +`method`|`string`| |
| 80 | +`openapiSchemaPath`|`string`|Path to the OpenAPI schema file |
| 81 | +`path`|`string`| |
| 82 | + |
| 83 | +--- |
| 84 | +#### Tool: **`get-response-schema`** |
| 85 | +Gets the response schema for a specific endpoint, method, and status code |
| 86 | +Parameters|Type|Description |
| 87 | +-|-|- |
| 88 | +`method`|`string`| |
| 89 | +`openapiSchemaPath`|`string`|Path to the OpenAPI schema file |
| 90 | +`path`|`string`| |
| 91 | +`statusCode`|`string` *optional*| |
| 92 | + |
| 93 | +--- |
| 94 | +#### Tool: **`list-components`** |
| 95 | +Lists all schema components (schemas, parameters, responses, etc.) |
| 96 | +Parameters|Type|Description |
| 97 | +-|-|- |
| 98 | +`openapiSchemaPath`|`string`|Path to the OpenAPI schema file |
| 99 | + |
| 100 | +--- |
| 101 | +#### Tool: **`list-endpoints`** |
| 102 | +Lists all API paths and their HTTP methods with summaries, organized by path |
| 103 | +Parameters|Type|Description |
| 104 | +-|-|- |
| 105 | +`openapiSchemaPath`|`string`|Path to the OpenAPI schema file |
| 106 | + |
| 107 | +--- |
| 108 | +#### Tool: **`list-security-schemes`** |
| 109 | +Lists all available security schemes |
| 110 | +Parameters|Type|Description |
| 111 | +-|-|- |
| 112 | +`openapiSchemaPath`|`string`|Path to the OpenAPI schema file |
| 113 | + |
| 114 | +--- |
| 115 | +#### Tool: **`search-schema`** |
| 116 | +Searches across paths, operations, and schemas |
| 117 | +Parameters|Type|Description |
| 118 | +-|-|- |
| 119 | +`openapiSchemaPath`|`string`|Path to the OpenAPI schema file |
| 120 | +`pattern`|`string`|Search pattern (case-insensitive) |
| 121 | + |
| 122 | +--- |
| 123 | +## Use this MCP Server |
| 124 | + |
| 125 | +```json |
| 126 | +{ |
| 127 | + "mcpServers": { |
| 128 | + "openapi-schema": { |
| 129 | + "command": "docker", |
| 130 | + "args": [ |
| 131 | + "run", |
| 132 | + "-i", |
| 133 | + "--rm", |
| 134 | + "mcp/openapi-schema" |
| 135 | + ] |
| 136 | + } |
| 137 | + } |
| 138 | +} |
| 139 | +``` |
| 140 | + |
| 141 | +[Why is it safer to run MCP Servers with Docker?](https://www.docker.com/blog/the-model-context-protocol-simplifying-building-ai-apps-with-anthropic-claude-desktop-and-docker/) |
0 commit comments