Skip to content

Commit 9e385a4

Browse files
domdomeggdomdomegg
authored
Update server.schema.json for registry preview (#3)
1 parent bd477b6 commit 9e385a4

File tree

1 file changed

+138
-44
lines changed

1 file changed

+138
-44
lines changed

‎schemas/2025-07-09/server.schema.json‎

Lines changed: 138 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
"$defs": {
77
"Repository": {
88
"type": "object",
9+
"description": "Repository metadata for the MCP server source code. Enables users and security experts to inspect the code, improving transparency.",
910
"required": [
1011
"url",
1112
"source"
@@ -14,31 +15,23 @@
1415
"url": {
1516
"type": "string",
1617
"format": "uri",
18+
"description": "Repository URL for browsing source code. Should support both web browsing and git clone operations.",
1719
"example": "https://github.com/modelcontextprotocol/servers"
1820
},
1921
"source": {
2022
"type": "string",
21-
"description": "Repository hosting service",
23+
"description": "Repository hosting service identifier. Used by registries to determine validation and API access methods.",
2224
"example": "github"
2325
},
2426
"id": {
2527
"type": "string",
28+
"description": "Repository identifier from the hosting service (e.g., GitHub repo ID). Owned and determined by the source forge. Should remain stable across repository renames and may be used to detect repository resurrection attacks - if a repository is deleted and recreated, the ID should change. For GitHub, use: gh api repos/<owner>/<repo> --jq '.id'",
2629
"example": "b94b5f7e-c7c6-d760-2c78-a5e9b8a5b8c9"
27-
}
28-
}
29-
},
30-
"VersionDetail": {
31-
"type": "object",
32-
"description": "Version information for this server. Defined as an object to allow for downstream extensibility (e.g. release_date)",
33-
"required": [
34-
"version"
35-
],
36-
"properties": {
37-
"version": {
30+
},
31+
"subfolder": {
3832
"type": "string",
39-
"maxLength": 255,
40-
"example": "1.0.2",
41-
"description": "Version string for this server. SHOULD follow semantic versioning (e.g., '1.0.2', '2.1.0-alpha'). Equivalent of Implementation.version in MCP specification. Non-semantic versions are allowed but may not sort predictably."
33+
"description": "Optional relative path from repository root to the server location within a monorepo or nested package structure. Must be a clean relative path.",
34+
"example": "src/everything"
4235
}
4336
}
4437
},
@@ -47,65 +40,97 @@
4740
"required": [
4841
"name",
4942
"description",
50-
"version_detail"
43+
"version"
5144
],
5245
"properties": {
5346
"name": {
5447
"type": "string",
55-
"description": "Server name/identifier",
56-
"example": "io.modelcontextprotocol/filesystem"
48+
"description": "Server name in reverse-DNS format. Must contain exactly one forward slash separating namespace from server name.",
49+
"example": "io.github.user/weather",
50+
"pattern": "^[a-zA-Z0-9.-]+/[a-zA-Z0-9._-]+$",
51+
"minLength": 3,
52+
"maxLength": 200
5753
},
5854
"description": {
5955
"type": "string",
60-
"description": "Human-readable description of the server's functionality",
61-
"example": "Node.js server implementing Model Context Protocol (MCP) for filesystem operations."
56+
"description": "Clear human-readable explanation of server functionality. Should focus on capabilities, not implementation details.",
57+
"example": "MCP server providing weather data and forecasts via OpenWeatherMap API",
58+
"minLength": 1,
59+
"maxLength": 100
6260
},
6361
"status": {
6462
"type": "string",
65-
"enum": ["active", "deprecated"],
63+
"enum": ["active", "deprecated", "deleted"],
6664
"default": "active",
67-
"description": "Server lifecycle status. 'deprecated' indicates the server is no longer recommended for new usage."
65+
"description": "Server lifecycle status. 'deprecated' indicates the server is no longer recommended for new usage. 'deleted' indicates the server should never be installed and existing installations should be uninstalled - this is rare, and usually indicates malware or a legal takedown."
6866
},
6967
"repository": {
70-
"$ref": "#/$defs/Repository"
68+
"$ref": "#/$defs/Repository",
69+
"description": "Optional repository metadata for the MCP server source code. Recommended for transparency and security inspection."
7170
},
72-
"version_detail": {
73-
"$ref": "#/$defs/VersionDetail"
71+
"version": {
72+
"type": "string",
73+
"maxLength": 255,
74+
"example": "1.0.2",
75+
"description": "Version string for this server. SHOULD follow semantic versioning (e.g., '1.0.2', '2.1.0-alpha'). Equivalent of Implementation.version in MCP specification. Non-semantic versions are allowed but may not sort predictably."
7476
}
7577
}
7678
},
7779
"Package": {
7880
"type": "object",
79-
"required": [
80-
"registry_name",
81-
"name",
82-
"version"
83-
],
8481
"properties": {
85-
"registry_name": {
82+
"registry_type": {
8683
"type": "string",
87-
"description": "Package registry type",
88-
"example": "npm"
84+
"description": "Registry type indicating how to download packages (e.g., 'npm', 'pypi', 'oci', 'nuget', 'mcpb')",
85+
"examples": ["npm", "pypi", "oci", "nuget", "mcpb"]
8986
},
90-
"name": {
87+
"registry_base_url": {
9188
"type": "string",
92-
"description": "Package name in the registry",
93-
"example": "io.modelcontextprotocol/filesystem"
89+
"format": "uri",
90+
"description": "Base URL of the package registry",
91+
"examples": ["https://registry.npmjs.org", "https://pypi.org", "https://docker.io", "https://api.nuget.org", "https://github.com", "https://gitlab.com"]
92+
},
93+
"identifier": {
94+
"type": "string",
95+
"description": "Package identifier - either a package name (for registries) or URL (for direct downloads)",
96+
"examples": ["@modelcontextprotocol/server-brave-search", "https://github.com/example/releases/download/v1.0.0/package.mcpb"]
9497
},
9598
"version": {
9699
"type": "string",
97100
"description": "Package version",
98-
"example": "1.0.2"
101+
"example": "1.0.2",
102+
"minLength": 1
103+
},
104+
"file_sha256": {
105+
"type": "string",
106+
"pattern": "^[a-f0-9]{64}$",
107+
"description": "SHA-256 hash of the package file for integrity verification. Required for MCPB packages and optional for other package types. Authors are responsible for generating correct SHA-256 hashes when creating server.json. If present, MCP clients must validate the downloaded file matches the hash before running packages to ensure file integrity.",
108+
"example": "fe333e598595000ae021bd27117db32ec69af6987f507ba7a63c90638ff633ce"
99109
},
100110
"runtime_hint": {
101111
"type": "string",
102112
"description": "A hint to help clients determine the appropriate runtime for the package. This field should be provided when `runtime_arguments` are present.",
103113
"examples": [
104114
"npx",
105115
"uvx",
116+
"docker",
106117
"dnx"
107118
]
108119
},
120+
"transport": {
121+
"anyOf": [
122+
{
123+
"$ref": "#/$defs/StdioTransport"
124+
},
125+
{
126+
"$ref": "#/$defs/StreamableHttpTransport"
127+
},
128+
{
129+
"$ref": "#/$defs/SseTransport"
130+
}
131+
],
132+
"description": "Transport protocol configuration for the package"
133+
},
109134
"runtime_arguments": {
110135
"type": "array",
111136
"description": "A list of arguments to be passed to the package's runtime command (such as docker or npx). The `runtime_hint` field should be provided when `runtime_arguments` are present.",
@@ -293,6 +318,7 @@
293318
]
294319
},
295320
"Argument": {
321+
"description": "Warning: Arguments construct command-line parameters that may contain user-provided input. This creates potential command injection risks if clients execute commands in a shell environment. For example, a malicious argument value like ';rm -rf ~/Development' could execute dangerous commands. Clients should prefer non-shell execution methods (e.g., posix_spawn) when possible to eliminate injection risks entirely. Where not possible, clients should obtain consent from users or agents to run the resolved command before execution.",
296322
"anyOf": [
297323
{
298324
"$ref": "#/$defs/PositionalArgument"
@@ -302,26 +328,70 @@
302328
}
303329
]
304330
},
305-
"Remote": {
331+
"StdioTransport": {
332+
"type": "object",
333+
"required": [
334+
"type"
335+
],
336+
"properties": {
337+
"type": {
338+
"type": "string",
339+
"enum": [
340+
"stdio"
341+
],
342+
"description": "Transport type",
343+
"example": "stdio"
344+
}
345+
}
346+
},
347+
"StreamableHttpTransport": {
348+
"type": "object",
349+
"required": [
350+
"type",
351+
"url"
352+
],
353+
"properties": {
354+
"type": {
355+
"type": "string",
356+
"enum": [
357+
"streamable-http"
358+
],
359+
"description": "Transport type",
360+
"example": "streamable-http"
361+
},
362+
"url": {
363+
"type": "string",
364+
"description": "URL template for the streamable-http transport. Variables in {curly_braces} reference argument value_hints, argument names, or environment variable names. After variable substitution, this should produce a valid URI.",
365+
"example": "https://api.example.com/mcp"
366+
},
367+
"headers": {
368+
"type": "array",
369+
"description": "HTTP headers to include",
370+
"items": {
371+
"$ref": "#/$defs/KeyValueInput"
372+
}
373+
}
374+
}
375+
},
376+
"SseTransport": {
306377
"type": "object",
307378
"required": [
308-
"transport_type",
379+
"type",
309380
"url"
310381
],
311382
"properties": {
312-
"transport_type": {
383+
"type": {
313384
"type": "string",
314385
"enum": [
315-
"streamable",
316386
"sse"
317387
],
318-
"description": "Transport protocol type",
388+
"description": "Transport type",
319389
"example": "sse"
320390
},
321391
"url": {
322392
"type": "string",
323393
"format": "uri",
324-
"description": "Remote server URL",
394+
"description": "Server-Sent Events endpoint URL",
325395
"example": "https://mcp-fs.example.com/sse"
326396
},
327397
"headers": {
@@ -357,7 +427,31 @@
357427
"remotes": {
358428
"type": "array",
359429
"items": {
360-
"$ref": "#/$defs/Remote"
430+
"anyOf": [
431+
{
432+
"$ref": "#/$defs/StreamableHttpTransport"
433+
},
434+
{
435+
"$ref": "#/$defs/SseTransport"
436+
}
437+
]
438+
}
439+
},
440+
"_meta": {
441+
"type": "object",
442+
"description": "Extension metadata using reverse DNS namespacing for vendor-specific data",
443+
"additionalProperties": true,
444+
"properties": {
445+
"io.modelcontextprotocol.registry/publisher-provided": {
446+
"type": "object",
447+
"description": "Publisher-provided metadata for downstream registries",
448+
"additionalProperties": true
449+
},
450+
"io.modelcontextprotocol.registry/official": {
451+
"type": "object",
452+
"description": "Official MCP registry metadata (read-only, added by registry)",
453+
"additionalProperties": true
454+
}
361455
}
362456
}
363457
}

0 commit comments

Comments
 (0)