Skip to content

Commit e4e0b8d

Browse files
committed
make docs
1 parent 578dc3d commit e4e0b8d

9 files changed

+230
-36
lines changed

docs/generator/reference/docker_mcp_gateway_run.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,16 @@ options:
3535
experimentalcli: false
3636
kubernetes: false
3737
swarm: false
38+
- option: additional-tools-config
39+
value_type: stringSlice
40+
default_value: '[]'
41+
description: Additional tools paths to merge with the default tools.yaml
42+
deprecated: false
43+
hidden: false
44+
experimental: false
45+
experimentalcli: false
46+
kubernetes: false
47+
swarm: false
3848
- option: block-network
3949
value_type: bool
4050
default_value: "false"
@@ -222,6 +232,16 @@ options:
222232
experimentalcli: false
223233
kubernetes: false
224234
swarm: false
235+
- option: tools-config
236+
value_type: stringSlice
237+
default_value: '[tools.yaml]'
238+
description: Paths to the tools files (absolute or relative to ~/.docker/mcp/)
239+
deprecated: false
240+
hidden: false
241+
experimental: false
242+
experimentalcli: false
243+
kubernetes: false
244+
swarm: false
225245
- option: transport
226246
value_type: string
227247
default_value: stdio

docs/generator/reference/docker_mcp_tools.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
command: docker mcp tools
2-
short: List/count/call MCP tools
3-
long: List/count/call MCP tools
2+
short: Manage tools
3+
long: Manage tools
44
pname: docker mcp
55
plink: docker_mcp.yaml
66
cname:
77
- docker mcp tools call
88
- docker mcp tools count
9+
- docker mcp tools disable
10+
- docker mcp tools enable
911
- docker mcp tools inspect
1012
- docker mcp tools list
1113
clink:
1214
- docker_mcp_tools_call.yaml
1315
- docker_mcp_tools_count.yaml
16+
- docker_mcp_tools_disable.yaml
17+
- docker_mcp_tools_enable.yaml
1418
- docker_mcp_tools_inspect.yaml
1519
- docker_mcp_tools_list.yaml
1620
options:
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
command: docker mcp tools disable
2+
short: disable one or more tools
3+
long: disable one or more tools
4+
usage: docker mcp tools disable [tool1] [tool2] ...
5+
pname: docker mcp tools
6+
plink: docker_mcp_tools.yaml
7+
options:
8+
- option: server
9+
value_type: string
10+
description: |
11+
Specify which server provides the tools (optional, will auto-discover if not provided)
12+
deprecated: false
13+
hidden: false
14+
experimental: false
15+
experimentalcli: false
16+
kubernetes: false
17+
swarm: false
18+
inherited_options:
19+
- option: format
20+
value_type: string
21+
default_value: list
22+
description: Output format (json|list)
23+
deprecated: false
24+
hidden: false
25+
experimental: false
26+
experimentalcli: false
27+
kubernetes: false
28+
swarm: false
29+
- option: gateway-arg
30+
value_type: stringSlice
31+
default_value: '[]'
32+
description: Additional arguments passed to the gateway
33+
deprecated: false
34+
hidden: false
35+
experimental: false
36+
experimentalcli: false
37+
kubernetes: false
38+
swarm: false
39+
- option: verbose
40+
value_type: bool
41+
default_value: "false"
42+
description: Verbose output
43+
deprecated: false
44+
hidden: false
45+
experimental: false
46+
experimentalcli: false
47+
kubernetes: false
48+
swarm: false
49+
- option: version
50+
value_type: string
51+
default_value: "2"
52+
description: Version of the gateway
53+
deprecated: false
54+
hidden: false
55+
experimental: false
56+
experimentalcli: false
57+
kubernetes: false
58+
swarm: false
59+
deprecated: false
60+
hidden: false
61+
experimental: false
62+
experimentalcli: false
63+
kubernetes: false
64+
swarm: false
65+
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
command: docker mcp tools enable
2+
short: enable one or more tools
3+
long: enable one or more tools
4+
usage: docker mcp tools enable [tool1] [tool2] ...
5+
pname: docker mcp tools
6+
plink: docker_mcp_tools.yaml
7+
options:
8+
- option: server
9+
value_type: string
10+
description: |
11+
Specify which server provides the tools (optional, will auto-discover if not provided)
12+
deprecated: false
13+
hidden: false
14+
experimental: false
15+
experimentalcli: false
16+
kubernetes: false
17+
swarm: false
18+
inherited_options:
19+
- option: format
20+
value_type: string
21+
default_value: list
22+
description: Output format (json|list)
23+
deprecated: false
24+
hidden: false
25+
experimental: false
26+
experimentalcli: false
27+
kubernetes: false
28+
swarm: false
29+
- option: gateway-arg
30+
value_type: stringSlice
31+
default_value: '[]'
32+
description: Additional arguments passed to the gateway
33+
deprecated: false
34+
hidden: false
35+
experimental: false
36+
experimentalcli: false
37+
kubernetes: false
38+
swarm: false
39+
- option: verbose
40+
value_type: bool
41+
default_value: "false"
42+
description: Verbose output
43+
deprecated: false
44+
hidden: false
45+
experimental: false
46+
experimentalcli: false
47+
kubernetes: false
48+
swarm: false
49+
- option: version
50+
value_type: string
51+
default_value: "2"
52+
description: Version of the gateway
53+
deprecated: false
54+
hidden: false
55+
experimental: false
56+
experimentalcli: false
57+
kubernetes: false
58+
swarm: false
59+
deprecated: false
60+
hidden: false
61+
experimental: false
62+
experimentalcli: false
63+
kubernetes: false
64+
swarm: false
65+

docs/generator/reference/mcp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Manage MCP servers and clients
1414
| [`policy`](mcp_policy.md) | Manage secret policies |
1515
| [`secret`](mcp_secret.md) | Manage secrets |
1616
| [`server`](mcp_server.md) | Manage servers |
17-
| [`tools`](mcp_tools.md) | List/count/call MCP tools |
17+
| [`tools`](mcp_tools.md) | Manage tools |
1818
| [`version`](mcp_version.md) | Show the version information |
1919

2020

docs/generator/reference/mcp_gateway_run.md

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

66
### Options
77

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

3537

3638
<!---MARKER_GEN_END-->

docs/generator/reference/mcp_tools.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
# docker mcp tools
22

33
<!---MARKER_GEN_START-->
4-
List/count/call MCP tools
4+
Manage tools
55

66
### Subcommands
77

8-
| Name | Description |
9-
|:----------------------------------|:---------------|
10-
| [`call`](mcp_tools_call.md) | Call a tool |
11-
| [`count`](mcp_tools_count.md) | Count tools |
12-
| [`inspect`](mcp_tools_inspect.md) | Inspect a tool |
13-
| [`list`](mcp_tools_list.md) | List tools |
8+
| Name | Description |
9+
|:----------------------------------|:--------------------------|
10+
| [`call`](mcp_tools_call.md) | Call a tool |
11+
| [`count`](mcp_tools_count.md) | Count tools |
12+
| [`disable`](mcp_tools_disable.md) | disable one or more tools |
13+
| [`enable`](mcp_tools_enable.md) | enable one or more tools |
14+
| [`inspect`](mcp_tools_inspect.md) | Inspect a tool |
15+
| [`list`](mcp_tools_list.md) | List tools |
1416

1517

1618
### Options
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# docker mcp tools disable
2+
3+
<!---MARKER_GEN_START-->
4+
disable one or more tools
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
|:----------------|:--------------|:--------|:---------------------------------------------------------------------------------------|
10+
| `--format` | `string` | `list` | Output format (json\|list) |
11+
| `--gateway-arg` | `stringSlice` | | Additional arguments passed to the gateway |
12+
| `--server` | `string` | | Specify which server provides the tools (optional, will auto-discover if not provided) |
13+
| `--verbose` | `bool` | | Verbose output |
14+
| `--version` | `string` | `2` | Version of the gateway |
15+
16+
17+
<!---MARKER_GEN_END-->
18+
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# docker mcp tools enable
2+
3+
<!---MARKER_GEN_START-->
4+
enable one or more tools
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
|:----------------|:--------------|:--------|:---------------------------------------------------------------------------------------|
10+
| `--format` | `string` | `list` | Output format (json\|list) |
11+
| `--gateway-arg` | `stringSlice` | | Additional arguments passed to the gateway |
12+
| `--server` | `string` | | Specify which server provides the tools (optional, will auto-discover if not provided) |
13+
| `--verbose` | `bool` | | Verbose output |
14+
| `--version` | `string` | `2` | Version of the gateway |
15+
16+
17+
<!---MARKER_GEN_END-->
18+

0 commit comments

Comments
 (0)