mirror of
https://github.com/docker/docs.git
synced 2026-03-28 23:08:49 +07:00
333 lines
9.5 KiB
YAML
Generated
333 lines
9.5 KiB
YAML
Generated
command: docker mcp gateway run
|
|
short: Run the gateway
|
|
long: Run the gateway
|
|
usage: docker mcp gateway run
|
|
pname: docker mcp gateway
|
|
plink: docker_mcp_gateway.yaml
|
|
options:
|
|
- option: additional-catalog
|
|
value_type: stringSlice
|
|
default_value: '[]'
|
|
description: Additional catalog paths to append to the default catalogs
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: additional-config
|
|
value_type: stringSlice
|
|
default_value: '[]'
|
|
description: Additional config paths to merge with the default config.yaml
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: additional-registry
|
|
value_type: stringSlice
|
|
default_value: '[]'
|
|
description: Additional registry paths to merge with the default registry.yaml
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: additional-tools-config
|
|
value_type: stringSlice
|
|
default_value: '[]'
|
|
description: Additional tools paths to merge with the default tools.yaml
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: block-network
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Block tools from accessing forbidden network resources
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: block-secrets
|
|
value_type: bool
|
|
default_value: "true"
|
|
description: Block secrets from being/received sent to/from tools
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: catalog
|
|
value_type: stringSlice
|
|
default_value: '[]'
|
|
description: |
|
|
Paths to docker catalogs (absolute or relative to ~/.docker/mcp/catalogs/)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: config
|
|
value_type: stringSlice
|
|
default_value: '[]'
|
|
description: Paths to the config files (absolute or relative to ~/.docker/mcp/)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: cpus
|
|
value_type: int
|
|
default_value: "1"
|
|
description: CPUs allocated to each MCP Server (default is 1)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: debug-dns
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Debug DNS resolution
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: dry-run
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: |
|
|
Start the gateway but do not listen for connections (useful for testing the configuration)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: enable-all-servers
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: |
|
|
Enable all servers in the catalog (instead of using individual --servers options)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: interceptor
|
|
value_type: stringArray
|
|
default_value: '[]'
|
|
description: |
|
|
List of interceptors to use (format: when:type:path, e.g. 'before:exec:/bin/path')
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: log
|
|
value_type: string
|
|
description: Path to log file for stderr output (relative or absolute)
|
|
deprecated: false
|
|
hidden: true
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: log-calls
|
|
value_type: bool
|
|
default_value: "true"
|
|
description: Log calls to the tools
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: long-lived
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: |
|
|
Containers are long-lived and will not be removed until the gateway is stopped, useful for stateful servers
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: mcp-registry
|
|
value_type: stringSlice
|
|
default_value: '[]'
|
|
description: MCP registry URLs to fetch servers from (can be repeated)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: memory
|
|
value_type: string
|
|
default_value: 2Gb
|
|
description: Memory allocated to each MCP Server (default is 2Gb)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: oci-ref
|
|
value_type: stringArray
|
|
default_value: '[]'
|
|
description: OCI image references to use
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: port
|
|
value_type: int
|
|
default_value: "0"
|
|
description: TCP port to listen on (default is to listen on stdio)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: profile
|
|
value_type: string
|
|
description: |
|
|
Profile ID to use (mutually exclusive with --servers and --enable-all-servers)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: registry
|
|
value_type: stringSlice
|
|
default_value: '[]'
|
|
description: |
|
|
Paths to the registry files (absolute or relative to ~/.docker/mcp/)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: secrets
|
|
value_type: string
|
|
default_value: docker-desktop
|
|
description: |
|
|
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)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: servers
|
|
value_type: stringSlice
|
|
default_value: '[]'
|
|
description: |
|
|
Names of the servers to enable (if non empty, ignore --registry flag)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: static
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Enable static mode (aka pre-started servers)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: tools
|
|
value_type: stringSlice
|
|
default_value: '[]'
|
|
description: List of tools to enable
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: tools-config
|
|
value_type: stringSlice
|
|
default_value: '[]'
|
|
description: Paths to the tools files (absolute or relative to ~/.docker/mcp/)
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: transport
|
|
value_type: string
|
|
default_value: stdio
|
|
description: |
|
|
stdio, sse or streaming. Uses MCP_GATEWAY_AUTH_TOKEN environment variable for localhost authentication to prevent dns rebinding attacks.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: verbose
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Verbose output
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: verify-signatures
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Verify signatures of the server images
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: watch
|
|
value_type: bool
|
|
default_value: "true"
|
|
description: Watch for changes and reconfigure the gateway
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
|