Skip to content

Commit 1333176

Browse files
committed
docs: update readme with new schema, some cleanup
1 parent fa159e3 commit 1333176

File tree

4 files changed

+124
-18944
lines changed

4 files changed

+124
-18944
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
build/*
2-
data
2+
.db
33
.env
44
.mcpregistry*
55
**/bin

README.md

Lines changed: 122 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -115,22 +115,79 @@ Response example:
115115
{
116116
"servers": [
117117
{
118-
"id": "1",
118+
"id": "123e4567-e89b-12d3-a456-426614174000",
119119
"name": "Example MCP Server",
120-
"description": "An example MCP server implementation",
121120
"url": "https://example.com/mcp",
122-
"repository": {
123-
"url": "https://github.com/example/mcp-server",
124-
"stars": 120
125-
},
126-
"version": "1.0.0",
127-
}],
128-
"metadata": {
129-
"next_cursor": "cursor-value-for-next-page"
121+
"description": "An example MCP server",
122+
"created_at": "2025-05-17T17:34:22.912Z",
123+
"updated_at": "2025-05-17T17:34:22.912Z"
124+
}
125+
],
126+
"metadata": {
127+
"next_cursor": "123e4567-e89b-12d3-a456-426614174000",
128+
"count": 30
130129
}
131130
}
132131
```
133132

133+
#### Get Server Details
134+
135+
```
136+
GET /v0/servers/{id}
137+
```
138+
139+
Retrieves detailed information about a specific MCP server entry.
140+
141+
Path parameters:
142+
- `id`: Unique identifier of the server entry
143+
144+
Response example:
145+
```json
146+
{
147+
"id": "01129bff-3d65-4e3d-8e82-6f2f269f818c",
148+
"name": "io.github.gongrzhe/redis-mcp-server",
149+
"description": "A Redis MCP server (pushed to https://github.com/modelcontextprotocol/servers/tree/main/src/redis) implementation for interacting with Redis databases. This server enables LLMs to interact with Redis key-value stores through a set of standardized tools.",
150+
"repository": {
151+
"url": "https://github.com/GongRzhe/REDIS-MCP-Server",
152+
"source": "github",
153+
"id": "907849235"
154+
},
155+
"version_detail": {
156+
"version": "0.0.1-seed",
157+
"release_date": "2025-05-16T19:13:21Z",
158+
"is_latest": true
159+
},
160+
"package_canonical": "docker",
161+
"packages": [
162+
{
163+
"registry_name": "docker",
164+
"name": "@gongrzhe/server-redis-mcp",
165+
"version": "1.0.0",
166+
"package_arguments": [
167+
{
168+
"description": "Docker image to run",
169+
"is_required": true,
170+
"format": "string",
171+
"value": "mcp/redis",
172+
"default": "mcp/redis",
173+
"type": "positional",
174+
"value_hint": "mcp/redis"
175+
},
176+
{
177+
"description": "Redis server connection string",
178+
"is_required": true,
179+
"format": "string",
180+
"value": "redis://host.docker.internal:6379",
181+
"default": "redis://host.docker.internal:6379",
182+
"type": "positional",
183+
"value_hint": "host.docker.internal:6379"
184+
}
185+
]
186+
}
187+
]
188+
}
189+
```
190+
134191
#### Publish a Server Entry
135192

136193
```
@@ -146,27 +203,62 @@ Headers:
146203
Request body example:
147204
```json
148205
{
149-
"server_detail": {
150-
"name": "io.github.username/repository",
151-
"description": "Your MCP server description",
152-
"version_detail": {
153-
"version": "1.0.0"
154-
},
155-
"registries": [
156-
{
157-
"name": "npm",
158-
"package_name": "your-package-name",
159-
"license": "MIT"
160-
}
206+
"description": "<your description here>",
207+
"name": "io.github.<owner>/<server-name>",
208+
"package_canonical": "<package_registry",
209+
"packages": [
210+
{
211+
"registry_name": "npm",
212+
"name": "@<owner>/<server-name>",
213+
"version": "0.2.23",
214+
"package_arguments": [
215+
{
216+
"description": "Specify services and permissions.",
217+
"is_required": true,
218+
"format": "string",
219+
"value": "-s",
220+
"default": "-s",
221+
"type": "positional",
222+
"value_hint": "-s"
223+
}
224+
],
225+
"environment_variables": [
226+
{
227+
"description": "API Key to access the server",
228+
"name": "API_KEY"
229+
}
230+
]
231+
},{
232+
"registry_name": "docker>",
233+
"name": "@<owner>/<server-name>-cli",
234+
"version": "0.123.223",
235+
"runtime_hint": "docker",
236+
"runtime_arguments": [
237+
{
238+
"description": "Specify services and permissions.",
239+
"is_required": true,
240+
"format": "string",
241+
"value": "--mount",
242+
"default": "--mount",
243+
"type": "positional",
244+
"value_hint": "--mount"
245+
}
246+
],
247+
"environment_variables": [
248+
{
249+
"description": "API Key to access the server",
250+
"name": "API_KEY"
251+
}
252+
]
253+
}
161254
],
162-
"remotes": [
163-
{
164-
"transport_type": "http",
165-
"url": "https://your-api-endpoint.com"
166-
}
167-
]
168-
},
169-
"repo_ref": "username/repository"
255+
"repository": {
256+
"url": "https://github.com//<owner>/<server-name>",
257+
"source": "github"
258+
},
259+
"version_detail": {
260+
"version": "0.0.1-<publisher_version>"
261+
}
170262
}
171263
```
172264

0 commit comments

Comments
 (0)