|
1 | 1 | openapi: 3.1.0 |
| 2 | +jsonSchemaDialect: "https://json-schema.org/draft/2020-12/schema" |
2 | 3 | info: |
3 | 4 | title: MCP Server Registry API |
4 | 5 | summary: API for discovering and accessing MCP servers metadata |
|
82 | 83 | example: "Server not found" |
83 | 84 | components: |
84 | 85 | schemas: |
85 | | - jsonSchemaDialect: "https://json-schema.org/draft/2020-12/schema" |
86 | 86 | Repository: |
87 | 87 | type: object |
88 | 88 | required: |
@@ -116,33 +116,36 @@ components: |
116 | 116 | example: "a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1" |
117 | 117 | name: |
118 | 118 | type: string |
119 | | - example: "@modelcontextprotocol/servers/src/filesystem" |
| 119 | + description: Human-readable description of the server's functionality |
| 120 | + example: "io.modelcontextprotocol/filesystem" |
120 | 121 | description: |
121 | 122 | type: string |
122 | 123 | example: "Node.js server implementing Model Context Protocol (MCP) for filesystem operations." |
123 | 124 | repository: |
124 | 125 | $ref: '#/components/schemas/Repository' |
125 | 126 | version_detail: |
126 | | - type: object |
127 | | - required: |
128 | | - - version |
129 | | - - release_date |
130 | | - - is_latest |
131 | | - properties: |
132 | | - version: |
133 | | - type: string |
134 | | - example: "1.0.2" |
135 | | - description: Equivalent of Implementation.version in MCP specification. |
136 | | - release_date: |
137 | | - type: string |
138 | | - format: date-time |
139 | | - example: "2023-06-15T10:30:00Z" |
140 | | - description: Datetime that the MCP server version was published to the registry. |
141 | | - is_latest: |
142 | | - type: boolean |
143 | | - example: true |
144 | | - description: Whether the MCP server version is the latest version available in the registry. |
145 | | - $schema: "https://json-schema.org/draft/2020-12/schema" |
| 127 | + $ref: '#/components/schemas/VersionDetail' |
| 128 | + |
| 129 | + VersionDetail: |
| 130 | + type: object |
| 131 | + required: |
| 132 | + - version |
| 133 | + - release_date |
| 134 | + - is_latest |
| 135 | + properties: |
| 136 | + version: |
| 137 | + type: string |
| 138 | + example: "1.0.2" |
| 139 | + description: Equivalent of Implementation.version in MCP specification. |
| 140 | + release_date: |
| 141 | + type: string |
| 142 | + format: date-time |
| 143 | + example: "2023-06-15T10:30:00Z" |
| 144 | + description: Datetime that the MCP server version was published to the registry. |
| 145 | + is_latest: |
| 146 | + type: boolean |
| 147 | + example: true |
| 148 | + description: Whether the MCP server version is the latest version available in the registry. |
146 | 149 |
|
147 | 150 | ServerList: |
148 | 151 | type: object |
@@ -172,12 +175,15 @@ components: |
172 | 175 | registry_name: |
173 | 176 | type: string |
174 | 177 | enum: [npm, docker, pypi, homebrew, nuget] |
| 178 | + description: Package registry type |
175 | 179 | example: "npm" |
176 | 180 | name: |
177 | 181 | type: string |
| 182 | + description: Package name in the registry |
178 | 183 | example: "io.modelcontextprotocol/filesystem" |
179 | 184 | version: |
180 | 185 | type: string |
| 186 | + description: Package version |
181 | 187 | example: "1.0.2" |
182 | 188 | runtime_hint: |
183 | 189 | type: string |
@@ -317,17 +323,21 @@ components: |
317 | 323 | transport_type: |
318 | 324 | type: string |
319 | 325 | enum: [streamable, sse] |
| 326 | + description: Transport protocol type |
320 | 327 | example: "sse" |
321 | 328 | url: |
322 | 329 | type: string |
323 | 330 | format: uri |
| 331 | + description: Remote server URL |
324 | 332 | example: "https://mcp-fs.example.com/sse" |
325 | 333 | headers: |
326 | 334 | type: array |
| 335 | + description: HTTP headers to include |
327 | 336 | items: |
328 | 337 | $ref: '#/components/schemas/KeyValueInput' |
329 | 338 |
|
330 | 339 | ServerDetail: |
| 340 | + description: Schema for a static representation of an MCP server. Used in various contexts related to discovery, installation, and configuration. |
331 | 341 | allOf: |
332 | 342 | - $ref: '#/components/schemas/Server' |
333 | 343 | - type: object |
|
0 commit comments