Skip to content

Commit b3ae1c2

Browse files
JAORMXdomdomegg
andauthored
Add OpenAPI example demonstrating publisher extensions (#299)
This PR adds a new example to the OpenAPI specification that demonstrates the publisher extensions feature recently added in #298. ## Changes - Added \`example_org_server\` example to the OpenAPI spec - Demonstrates \`x-publisher\` fields for contact email and build metadata - Shows organization-specific extensions (\`x-com.example\`) including: - Marketplace icon URL - Category classification - Documentation URL - Verified publisher status This example helps developers understand how to use the new vendor extensions functionality when publishing servers to the registry. Co-authored-by: adam jones <[email protected]>
1 parent 03ac9c9 commit b3ae1c2

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/server-registry-api/openapi.yaml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,32 @@ paths:
104104
build_info:
105105
commit: "abc123def456"
106106
timestamp: "2023-12-01T10:30:00Z"
107+
example_org_server:
108+
summary: Server with example.com organization extensions
109+
value:
110+
server:
111+
name: "com.example/demo-server"
112+
description: "Example MCP server demonstrating publisher extensions."
113+
status: "active"
114+
repository:
115+
url: "https://github.com/example/mcp-demo"
116+
source: "github"
117+
version_detail:
118+
version: "1.0.0"
119+
packages:
120+
- registry_name: "npm"
121+
name: "@example/mcp-demo-server"
122+
version: "1.0.0"
123+
x-publisher:
124+
contact_email: "[email protected]"
125+
build_metadata:
126+
commit: "abc123"
127+
timestamp: "2024-01-15T10:30:00Z"
128+
x-com.example:
129+
marketplace_icon: "https://example.com/icon.png"
130+
category: ["software_development"]
131+
documentation_url: "https://docs.example.org"
132+
verified_publisher: true
107133
responses:
108134
'200':
109135
description: Successfully published server

0 commit comments

Comments
 (0)