You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/server-entry-spec.md
+18-53Lines changed: 18 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,10 @@
2
2
3
3
This document defines the specification for MCP server entries in the Docker MCP Gateway catalog system.
4
4
5
-
Server entries can be found in legacy catalog files such as `.docker/mcp/catalogs/docker-mcp.yaml` under the `registry` property. They can also be used to define an mcp server by writing a yaml file and using it as a CLI flag for profiles or catalogs via `--server file://my-server.yaml`.
5
+
Server entries can be defined for an mcp server by writing a yaml file and using it as a CLI flag for profiles or catalogs via `--server file://my-server.yaml`.
6
+
7
+
**A note about legacy catalogs:** Legacy catalogs such as `.docker/mcp/catalogs/docker-mcp.yaml` or http://desktop.docker.com/mcp/catalog/v3/catalog.yaml use a similar schema for servers under the `registry` property. However, this spec is intended for defining server configurations for MCP Profiles and OCI Catalogs. Thus, it's expected that this spec will drift from what exists in legacy catalogs.
8
+
6
9
7
10
## Example Server Entry YAML
8
11
@@ -27,6 +30,7 @@ allowHosts:
27
30
| `title` | string | **Yes** | Human-readable display name for the server. |
28
31
| `description` | string | **Yes** | Brief description of the server's capabilities and purpose. |
29
32
| `icon` | string | No | URL to an icon/logo representing the server. |
33
+
| `readme` | string | No | URL to a README file with detailed documentation for the server. |
30
34
31
35
### Container Configuration (for type: "server")
32
36
@@ -115,33 +119,28 @@ allowHosts:
115
119
|-------|------|----------|-------------|
116
120
| `name` | string | Yes | Tool identifier (unique within the server). |
117
121
| `description` | string | No | Human-readable description of what the tool does. |
118
-
| `parameters` | Parameters | No | JSON Schema for tool input parameters. |
119
-
| `container` | Container | No | Container configuration for POCI (per-invocation) tools. |
0 commit comments