Skip to content

Commit f3d994b

Browse files
ArthurFlagArthurFlag
committed
update docs
1 parent d1888b4 commit f3d994b

File tree

2 files changed

+66
-32
lines changed

2 files changed

+66
-32
lines changed

‎docs/generator/reference/docker_mcp_gateway_run.yaml

Lines changed: 40 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,36 @@ usage: docker mcp gateway run
55
pname: docker mcp gateway
66
plink: docker_mcp_gateway.yaml
77
options:
8+
- option: additional-catalog
9+
value_type: stringSlice
10+
default_value: '[]'
11+
description: additional catalog paths to append to the default catalogs
12+
deprecated: false
13+
hidden: false
14+
experimental: false
15+
experimentalcli: false
16+
kubernetes: false
17+
swarm: false
18+
- option: additional-config
19+
value_type: stringSlice
20+
default_value: '[]'
21+
description: additional config paths to merge with the default config.yaml
22+
deprecated: false
23+
hidden: false
24+
experimental: false
25+
experimentalcli: false
26+
kubernetes: false
27+
swarm: false
28+
- option: additional-registry
29+
value_type: stringSlice
30+
default_value: '[]'
31+
description: additional registry paths to merge with the default registry.yaml
32+
deprecated: false
33+
hidden: false
34+
experimental: false
35+
experimentalcli: false
36+
kubernetes: false
37+
swarm: false
838
- option: block-network
939
value_type: bool
1040
default_value: "false"
@@ -26,20 +56,20 @@ options:
2656
kubernetes: false
2757
swarm: false
2858
- option: catalog
29-
value_type: string
30-
default_value: docker-mcp.yaml
59+
value_type: stringSlice
60+
default_value: '[docker-mcp.yaml]'
3161
description: |
32-
path to the docker-mcp.yaml catalog (absolute or relative to ~/.docker/mcp/catalogs/)
62+
paths to docker catalogs (absolute or relative to ~/.docker/mcp/catalogs/)
3363
deprecated: false
3464
hidden: false
3565
experimental: false
3666
experimentalcli: false
3767
kubernetes: false
3868
swarm: false
3969
- option: config
40-
value_type: string
41-
default_value: config.yaml
42-
description: path to the config.yaml (absolute or relative to ~/.docker/mcp/)
70+
value_type: stringSlice
71+
default_value: '[config.yaml]'
72+
description: paths to the config files (absolute or relative to ~/.docker/mcp/)
4373
deprecated: false
4474
hidden: false
4575
experimental: false
@@ -130,9 +160,10 @@ options:
130160
kubernetes: false
131161
swarm: false
132162
- option: registry
133-
value_type: string
134-
default_value: registry.yaml
135-
description: path to the registry.yaml (absolute or relative to ~/.docker/mcp/)
163+
value_type: stringSlice
164+
default_value: '[registry.yaml]'
165+
description: |
166+
paths to the registry files (absolute or relative to ~/.docker/mcp/)
136167
deprecated: false
137168
hidden: false
138169
experimental: false

‎docs/generator/reference/mcp_gateway_run.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,32 @@ Run the gateway
55

66
### Options
77

8-
| Name | Type | Default | Description |
9-
|:----------------------|:--------------|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------|
10-
| `--block-network` | `bool` | | Block tools from accessing forbidden network resources |
11-
| `--block-secrets` | `bool` | `true` | Block secrets from being/received sent to/from tools |
12-
| `--catalog` | `string` | `docker-mcp.yaml` | path to the docker-mcp.yaml catalog (absolute or relative to ~/.docker/mcp/catalogs/) |
13-
| `--config` | `string` | `config.yaml` | path to the config.yaml (absolute or relative to ~/.docker/mcp/) |
14-
| `--cpus` | `int` | `1` | CPUs allocated to each MCP Server (default is 1) |
15-
| `--debug-dns` | `bool` | | Debug DNS resolution |
16-
| `--dry-run` | `bool` | | Start the gateway but do not listen for connections (useful for testing the configuration) |
17-
| `--interceptor` | `stringArray` | | List of interceptors to use (format: when:type:path, e.g. 'before:exec:/bin/path') |
18-
| `--log-calls` | `bool` | `true` | Log calls to the tools |
19-
| `--long-lived` | `bool` | | Containers are long-lived and will not be removed until the gateway is stopped, useful for stateful servers |
20-
| `--memory` | `string` | `2Gb` | Memory allocated to each MCP Server (default is 2Gb) |
21-
| `--port` | `int` | `0` | TCP port to listen on (default is to listen on stdio) |
22-
| `--registry` | `string` | `registry.yaml` | path to the registry.yaml (absolute or relative to ~/.docker/mcp/) |
23-
| `--secrets` | `string` | `docker-desktop` | colon separated paths to search for secrets. Can be `docker-desktop` or a path to a .env file (default to using Docker Deskop's secrets API) |
24-
| `--servers` | `stringSlice` | | names of the servers to enable (if non empty, ignore --registry flag) |
25-
| `--static` | `bool` | | Enable static mode (aka pre-started servers) |
26-
| `--tools` | `stringSlice` | | List of tools to enable |
27-
| `--transport` | `string` | `stdio` | stdio, sse or streaming (default is stdio) |
28-
| `--verbose` | `bool` | | Verbose output |
29-
| `--verify-signatures` | `bool` | | Verify signatures of the server images |
30-
| `--watch` | `bool` | `true` | Watch for changes and reconfigure the gateway |
8+
| Name | Type | Default | Description |
9+
|:------------------------|:--------------|:--------------------|:---------------------------------------------------------------------------------------------------------------------------------------------|
10+
| `--additional-catalog` | `stringSlice` | | additional catalog paths to append to the default catalogs |
11+
| `--additional-config` | `stringSlice` | | additional config paths to merge with the default config.yaml |
12+
| `--additional-registry` | `stringSlice` | | additional registry paths to merge with the default registry.yaml |
13+
| `--block-network` | `bool` | | Block tools from accessing forbidden network resources |
14+
| `--block-secrets` | `bool` | `true` | Block secrets from being/received sent to/from tools |
15+
| `--catalog` | `stringSlice` | `[docker-mcp.yaml]` | paths to docker catalogs (absolute or relative to ~/.docker/mcp/catalogs/) |
16+
| `--config` | `stringSlice` | `[config.yaml]` | paths to the config files (absolute or relative to ~/.docker/mcp/) |
17+
| `--cpus` | `int` | `1` | CPUs allocated to each MCP Server (default is 1) |
18+
| `--debug-dns` | `bool` | | Debug DNS resolution |
19+
| `--dry-run` | `bool` | | Start the gateway but do not listen for connections (useful for testing the configuration) |
20+
| `--interceptor` | `stringArray` | | List of interceptors to use (format: when:type:path, e.g. 'before:exec:/bin/path') |
21+
| `--log-calls` | `bool` | `true` | Log calls to the tools |
22+
| `--long-lived` | `bool` | | Containers are long-lived and will not be removed until the gateway is stopped, useful for stateful servers |
23+
| `--memory` | `string` | `2Gb` | Memory allocated to each MCP Server (default is 2Gb) |
24+
| `--port` | `int` | `0` | TCP port to listen on (default is to listen on stdio) |
25+
| `--registry` | `stringSlice` | `[registry.yaml]` | paths to the registry files (absolute or relative to ~/.docker/mcp/) |
26+
| `--secrets` | `string` | `docker-desktop` | colon separated paths to search for secrets. Can be `docker-desktop` or a path to a .env file (default to using Docker Deskop's secrets API) |
27+
| `--servers` | `stringSlice` | | names of the servers to enable (if non empty, ignore --registry flag) |
28+
| `--static` | `bool` | | Enable static mode (aka pre-started servers) |
29+
| `--tools` | `stringSlice` | | List of tools to enable |
30+
| `--transport` | `string` | `stdio` | stdio, sse or streaming (default is stdio) |
31+
| `--verbose` | `bool` | | Verbose output |
32+
| `--verify-signatures` | `bool` | | Verify signatures of the server images |
33+
| `--watch` | `bool` | `true` | Watch for changes and reconfigure the gateway |
3134

3235

3336
<!---MARKER_GEN_END-->

0 commit comments

Comments
 (0)