Skip to content

Commit 9c674b8

Browse files
authored
Merge branch 'main' into tadasant/split-server-json
2 parents 177770e + 6a2e5d1 commit 9c674b8

File tree

2 files changed

+279
-149
lines changed

2 files changed

+279
-149
lines changed

docs/openapi.yaml

Lines changed: 32 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
openapi: 3.1.0
2+
jsonSchemaDialect: "https://json-schema.org/draft/2020-12/schema"
23
info:
34
title: MCP Server Registry API
45
summary: API for discovering and accessing MCP servers metadata
@@ -82,7 +83,6 @@ paths:
8283
example: "Server not found"
8384
components:
8485
schemas:
85-
jsonSchemaDialect: "https://json-schema.org/draft/2020-12/schema"
8686
Repository:
8787
type: object
8888
required:
@@ -116,33 +116,36 @@ components:
116116
example: "a5e8a7f0-d4e4-4a1d-b12f-2896a23fd4f1"
117117
name:
118118
type: string
119-
example: "@modelcontextprotocol/servers/src/filesystem"
119+
description: Human-readable description of the server's functionality
120+
example: "io.modelcontextprotocol/filesystem"
120121
description:
121122
type: string
122123
example: "Node.js server implementing Model Context Protocol (MCP) for filesystem operations."
123124
repository:
124125
$ref: '#/components/schemas/Repository'
125126
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.
146149

147150
ServerList:
148151
type: object
@@ -172,12 +175,15 @@ components:
172175
registry_name:
173176
type: string
174177
enum: [npm, docker, pypi, homebrew, nuget]
178+
description: Package registry type
175179
example: "npm"
176180
name:
177181
type: string
182+
description: Package name in the registry
178183
example: "io.modelcontextprotocol/filesystem"
179184
version:
180185
type: string
186+
description: Package version
181187
example: "1.0.2"
182188
runtime_hint:
183189
type: string
@@ -317,17 +323,21 @@ components:
317323
transport_type:
318324
type: string
319325
enum: [streamable, sse]
326+
description: Transport protocol type
320327
example: "sse"
321328
url:
322329
type: string
323330
format: uri
331+
description: Remote server URL
324332
example: "https://mcp-fs.example.com/sse"
325333
headers:
326334
type: array
335+
description: HTTP headers to include
327336
items:
328337
$ref: '#/components/schemas/KeyValueInput'
329338

330339
ServerDetail:
340+
description: Schema for a static representation of an MCP server. Used in various contexts related to discovery, installation, and configuration.
331341
allOf:
332342
- $ref: '#/components/schemas/Server'
333343
- type: object

0 commit comments

Comments
 (0)