docs: update readme with new schema, some cleanup
This commit is contained in:
parent
fa159e360f
commit
94c19fafa4
4 changed files with 124 additions and 18944 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -1,5 +1,5 @@
|
||||||
build/*
|
build/*
|
||||||
data
|
.db
|
||||||
.env
|
.env
|
||||||
.mcpregistry*
|
.mcpregistry*
|
||||||
**/bin
|
**/bin
|
||||||
|
|
|
||||||
152
README.md
152
README.md
|
|
@ -115,22 +115,79 @@ Response example:
|
||||||
{
|
{
|
||||||
"servers": [
|
"servers": [
|
||||||
{
|
{
|
||||||
"id": "1",
|
"id": "123e4567-e89b-12d3-a456-426614174000",
|
||||||
"name": "Example MCP Server",
|
"name": "Example MCP Server",
|
||||||
"description": "An example MCP server implementation",
|
|
||||||
"url": "https://example.com/mcp",
|
"url": "https://example.com/mcp",
|
||||||
"repository": {
|
"description": "An example MCP server",
|
||||||
"url": "https://github.com/example/mcp-server",
|
"created_at": "2025-05-17T17:34:22.912Z",
|
||||||
"stars": 120
|
"updated_at": "2025-05-17T17:34:22.912Z"
|
||||||
},
|
}
|
||||||
"version": "1.0.0",
|
],
|
||||||
}],
|
"metadata": {
|
||||||
"metadata": {
|
"next_cursor": "123e4567-e89b-12d3-a456-426614174000",
|
||||||
"next_cursor": "cursor-value-for-next-page"
|
"count": 30
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Get Server Details
|
||||||
|
|
||||||
|
```
|
||||||
|
GET /v0/servers/{id}
|
||||||
|
```
|
||||||
|
|
||||||
|
Retrieves detailed information about a specific MCP server entry.
|
||||||
|
|
||||||
|
Path parameters:
|
||||||
|
- `id`: Unique identifier of the server entry
|
||||||
|
|
||||||
|
Response example:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "01129bff-3d65-4e3d-8e82-6f2f269f818c",
|
||||||
|
"name": "io.github.gongrzhe/redis-mcp-server",
|
||||||
|
"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.",
|
||||||
|
"repository": {
|
||||||
|
"url": "https://github.com/GongRzhe/REDIS-MCP-Server",
|
||||||
|
"source": "github",
|
||||||
|
"id": "907849235"
|
||||||
|
},
|
||||||
|
"version_detail": {
|
||||||
|
"version": "0.0.1-seed",
|
||||||
|
"release_date": "2025-05-16T19:13:21Z",
|
||||||
|
"is_latest": true
|
||||||
|
},
|
||||||
|
"package_canonical": "docker",
|
||||||
|
"packages": [
|
||||||
|
{
|
||||||
|
"registry_name": "docker",
|
||||||
|
"name": "@gongrzhe/server-redis-mcp",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"package_arguments": [
|
||||||
|
{
|
||||||
|
"description": "Docker image to run",
|
||||||
|
"is_required": true,
|
||||||
|
"format": "string",
|
||||||
|
"value": "mcp/redis",
|
||||||
|
"default": "mcp/redis",
|
||||||
|
"type": "positional",
|
||||||
|
"value_hint": "mcp/redis"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"description": "Redis server connection string",
|
||||||
|
"is_required": true,
|
||||||
|
"format": "string",
|
||||||
|
"value": "redis://host.docker.internal:6379",
|
||||||
|
"default": "redis://host.docker.internal:6379",
|
||||||
|
"type": "positional",
|
||||||
|
"value_hint": "host.docker.internal:6379"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
#### Publish a Server Entry
|
#### Publish a Server Entry
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
@ -146,27 +203,62 @@ Headers:
|
||||||
Request body example:
|
Request body example:
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"server_detail": {
|
"description": "<your description here>",
|
||||||
"name": "io.github.username/repository",
|
"name": "io.github.<owner>/<server-name>",
|
||||||
"description": "Your MCP server description",
|
"package_canonical": "<package_registry",
|
||||||
"version_detail": {
|
"packages": [
|
||||||
"version": "1.0.0"
|
{
|
||||||
},
|
"registry_name": "npm",
|
||||||
"registries": [
|
"name": "@<owner>/<server-name>",
|
||||||
{
|
"version": "0.2.23",
|
||||||
"name": "npm",
|
"package_arguments": [
|
||||||
"package_name": "your-package-name",
|
{
|
||||||
"license": "MIT"
|
"description": "Specify services and permissions.",
|
||||||
}
|
"is_required": true,
|
||||||
|
"format": "string",
|
||||||
|
"value": "-s",
|
||||||
|
"default": "-s",
|
||||||
|
"type": "positional",
|
||||||
|
"value_hint": "-s"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"environment_variables": [
|
||||||
|
{
|
||||||
|
"description": "API Key to access the server",
|
||||||
|
"name": "API_KEY"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},{
|
||||||
|
"registry_name": "docker",
|
||||||
|
"name": "@<owner>/<server-name>-cli",
|
||||||
|
"version": "0.123.223",
|
||||||
|
"runtime_hint": "docker",
|
||||||
|
"runtime_arguments": [
|
||||||
|
{
|
||||||
|
"description": "Specify services and permissions.",
|
||||||
|
"is_required": true,
|
||||||
|
"format": "string",
|
||||||
|
"value": "--mount",
|
||||||
|
"default": "--mount",
|
||||||
|
"type": "positional",
|
||||||
|
"value_hint": "--mount"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"environment_variables": [
|
||||||
|
{
|
||||||
|
"description": "API Key to access the server",
|
||||||
|
"name": "API_KEY"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
],
|
],
|
||||||
"remotes": [
|
"repository": {
|
||||||
{
|
"url": "https://github.com//<owner>/<server-name>",
|
||||||
"transport_type": "http",
|
"source": "github"
|
||||||
"url": "https://your-api-endpoint.com"
|
},
|
||||||
}
|
"version_detail": {
|
||||||
]
|
"version": "0.0.1-<publisher_version>"
|
||||||
},
|
}
|
||||||
"repo_ref": "username/repository"
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
18912
data/seed.json
18912
data/seed.json
File diff suppressed because it is too large
Load diff
|
|
@ -19,7 +19,7 @@ services:
|
||||||
- PUID=1000
|
- PUID=1000
|
||||||
- PGID=1000
|
- PGID=1000
|
||||||
volumes:
|
volumes:
|
||||||
- './data:/data/db'
|
- './.db:/data/db'
|
||||||
ports:
|
ports:
|
||||||
- 27017:27017
|
- 27017:27017
|
||||||
restart: "unless-stopped"
|
restart: "unless-stopped"
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue