mirror of
https://github.com/docker/docs.git
synced 2026-11-04 10:01:00 +00:00
wip: vendor: mcp-gateway@v0.39.2 cli reference
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
213 files changed
+1252
-2040
No files matched your search
-40
@@ -1,40 +0,0 @@
|
||||
command: docker mcp catalog
|
||||
aliases: docker mcp catalog, docker mcp catalogs
|
||||
short: Manage MCP server catalogs
|
||||
long: |
|
||||
Manage MCP server catalogs for organizing and configuring custom MCP servers alongside Docker's official catalog.
|
||||
pname: docker mcp
|
||||
plink: docker_mcp.yaml
|
||||
cname:
|
||||
- docker mcp catalog add
|
||||
- docker mcp catalog bootstrap
|
||||
- docker mcp catalog create
|
||||
- docker mcp catalog export
|
||||
- docker mcp catalog fork
|
||||
- docker mcp catalog import
|
||||
- docker mcp catalog init
|
||||
- docker mcp catalog ls
|
||||
- docker mcp catalog reset
|
||||
- docker mcp catalog rm
|
||||
- docker mcp catalog show
|
||||
- docker mcp catalog update
|
||||
clink:
|
||||
- docker_mcp_catalog_add.yaml
|
||||
- docker_mcp_catalog_bootstrap.yaml
|
||||
- docker_mcp_catalog_create.yaml
|
||||
- docker_mcp_catalog_export.yaml
|
||||
- docker_mcp_catalog_fork.yaml
|
||||
- docker_mcp_catalog_import.yaml
|
||||
- docker_mcp_catalog_init.yaml
|
||||
- docker_mcp_catalog_ls.yaml
|
||||
- docker_mcp_catalog_reset.yaml
|
||||
- docker_mcp_catalog_rm.yaml
|
||||
- docker_mcp_catalog_show.yaml
|
||||
- docker_mcp_catalog_update.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-27
@@ -1,27 +0,0 @@
|
||||
command: docker mcp catalog add
|
||||
short: Add a server to a catalog
|
||||
long: |-
|
||||
Add an MCP server definition to an existing catalog by copying it from another catalog file.
|
||||
The server definition includes all configuration, tools, and metadata.
|
||||
usage: docker mcp catalog add <catalog> <server-name> <catalog-file>
|
||||
pname: docker mcp catalog
|
||||
plink: docker_mcp_catalog.yaml
|
||||
options:
|
||||
- option: force
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Overwrite existing server in the catalog
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
examples: " # Add a server from another catalog file\n docker mcp catalog add my-catalog github-server ./github-catalog.yaml\n \n # Add with force to overwrite existing server\n docker mcp catalog add my-catalog slack-bot ./team-catalog.yaml --force"
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-20
@@ -1,20 +0,0 @@
|
||||
command: docker mcp catalog bootstrap
|
||||
short: |
|
||||
Create a starter catalog file with Docker and Docker Hub server entries as examples
|
||||
long: |-
|
||||
Create a starter catalog file with Docker Hub and Docker CLI server entries as examples.
|
||||
This command extracts the official Docker server definitions and creates a properly formatted
|
||||
catalog file that users can modify and use as a foundation for their custom catalogs.
|
||||
|
||||
The output file is standalone and not automatically imported - users can modify it and then
|
||||
import it or use it as a source for the 'catalog add' command.
|
||||
usage: docker mcp catalog bootstrap <output-file-path>
|
||||
pname: docker mcp catalog
|
||||
plink: docker_mcp_catalog.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-15
@@ -1,15 +0,0 @@
|
||||
command: docker mcp catalog create
|
||||
short: Create a new empty catalog
|
||||
long: |
|
||||
Create a new empty catalog for organizing custom MCP servers. The catalog will be stored locally and can be populated using 'docker mcp catalog add'.
|
||||
usage: docker mcp catalog create <name>
|
||||
pname: docker mcp catalog
|
||||
plink: docker_mcp_catalog.yaml
|
||||
examples: " # Create a new catalog for development servers\n docker mcp catalog create dev-servers\n \n # Create a catalog for production monitoring tools \n docker mcp catalog create prod-monitoring"
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-16
@@ -1,16 +0,0 @@
|
||||
command: docker mcp catalog export
|
||||
short: Export a configured catalog to a file
|
||||
long: |-
|
||||
Export a user-managed catalog to a file. This command only works with catalogs
|
||||
that have been imported or configured manually. The canonical Docker MCP catalog
|
||||
cannot be exported as it is managed by Docker.
|
||||
usage: docker mcp catalog export <catalog-name> <file-path>
|
||||
pname: docker mcp catalog
|
||||
plink: docker_mcp_catalog.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-15
@@ -1,15 +0,0 @@
|
||||
command: docker mcp catalog fork
|
||||
short: Create a copy of an existing catalog
|
||||
long: |
|
||||
Create a new catalog by copying all servers from an existing catalog. Useful for creating variations of existing catalogs.
|
||||
usage: docker mcp catalog fork <src-catalog> <new-name>
|
||||
pname: docker mcp catalog
|
||||
plink: docker_mcp_catalog.yaml
|
||||
examples: " # Fork the Docker catalog to customize it\n docker mcp catalog fork docker-mcp my-custom-docker\n \n # Fork a team catalog for personal use\n docker mcp catalog fork team-servers my-servers"
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-34
@@ -1,34 +0,0 @@
|
||||
command: docker mcp catalog import
|
||||
short: Import a catalog from URL or file
|
||||
long: "Import an MCP server catalog from a URL or local file. The catalog will be downloaded \nand stored locally for use with the MCP gateway.\n\nWhen --mcp-registry flag is used, the argument must be an existing catalog name, and the\ncommand will import servers from the MCP registry URL into that catalog."
|
||||
usage: docker mcp catalog import <alias|url|file>
|
||||
pname: docker mcp catalog
|
||||
plink: docker_mcp_catalog.yaml
|
||||
options:
|
||||
- option: dry-run
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Show Imported Data but do not update the Catalog
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: mcp-registry
|
||||
value_type: string
|
||||
description: Import server from MCP registry URL into existing catalog
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
examples: " # Import from URL\n docker mcp catalog import https://example.com/my-catalog.yaml\n \n # Import from local file\n docker mcp catalog import ./shared-catalog.yaml\n \n # Import from MCP registry URL into existing catalog\n docker mcp catalog import my-catalog --mcp-registry https://registry.example.com/server"
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-17
@@ -1,17 +0,0 @@
|
||||
command: docker mcp catalog init
|
||||
short: Initialize the catalog system
|
||||
long: |
|
||||
Initialize the local catalog management system by creating the necessary configuration files and directories.
|
||||
usage: docker mcp catalog init
|
||||
pname: docker mcp catalog
|
||||
plink: docker_mcp_catalog.yaml
|
||||
examples: |4-
|
||||
# Initialize catalog system
|
||||
docker mcp catalog init
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-18
@@ -1,18 +0,0 @@
|
||||
command: docker mcp catalog reset
|
||||
aliases: docker mcp catalog reset, docker mcp catalog empty
|
||||
short: Reset the catalog system
|
||||
long: |
|
||||
Reset the local catalog management system by removing all user-managed catalogs and configuration. This does not affect Docker's official catalog.
|
||||
usage: docker mcp catalog reset
|
||||
pname: docker mcp catalog
|
||||
plink: docker_mcp_catalog.yaml
|
||||
examples: |4-
|
||||
# Reset all user catalogs
|
||||
docker mcp catalog reset
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-31
@@ -1,31 +0,0 @@
|
||||
command: docker mcp catalog show
|
||||
short: Display catalog contents
|
||||
long: |-
|
||||
Display the contents of a catalog including all server definitions and metadata.
|
||||
If no name is provided, shows the Docker official catalog.
|
||||
usage: docker mcp catalog show [name]
|
||||
pname: docker mcp catalog
|
||||
plink: docker_mcp_catalog.yaml
|
||||
options:
|
||||
- option: format
|
||||
value_type: format
|
||||
description: 'Supported: "json", "yaml".'
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
examples: |4-
|
||||
# Show Docker's official catalog
|
||||
docker mcp catalog show
|
||||
|
||||
# Show a specific catalog in JSON format
|
||||
docker mcp catalog show my-catalog --format=json
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-21
@@ -1,21 +0,0 @@
|
||||
command: docker mcp catalog update
|
||||
short: Update catalog(s) from remote sources
|
||||
long: |-
|
||||
Update one or more catalogs by re-downloading from their original sources.
|
||||
If no name is provided, updates all catalogs that have remote sources.
|
||||
usage: docker mcp catalog update [name]
|
||||
pname: docker mcp catalog
|
||||
plink: docker_mcp_catalog.yaml
|
||||
examples: |4-
|
||||
# Update all catalogs
|
||||
docker mcp catalog update
|
||||
|
||||
# Update specific catalog
|
||||
docker mcp catalog update team-servers
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
-24
@@ -1,24 +0,0 @@
|
||||
command: docker mcp client manual-instructions
|
||||
short: Display the manual instructions to connect the MCP client
|
||||
long: Display the manual instructions to connect the MCP client
|
||||
usage: docker mcp client manual-instructions
|
||||
pname: docker mcp client
|
||||
plink: docker_mcp_client.yaml
|
||||
options:
|
||||
- option: json
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Print as JSON.
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
hidden: true
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
-20
@@ -1,20 +0,0 @@
|
||||
command: docker mcp config
|
||||
short: Manage the configuration
|
||||
long: Manage the configuration
|
||||
pname: docker mcp
|
||||
plink: docker_mcp.yaml
|
||||
cname:
|
||||
- docker mcp config read
|
||||
- docker mcp config reset
|
||||
- docker mcp config write
|
||||
clink:
|
||||
- docker_mcp_config_read.yaml
|
||||
- docker_mcp_config_reset.yaml
|
||||
- docker_mcp_config_write.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-13
@@ -1,13 +0,0 @@
|
||||
command: docker mcp config dump
|
||||
short: Dump the whole configuration
|
||||
long: Dump the whole configuration
|
||||
usage: docker mcp config dump
|
||||
pname: docker mcp config
|
||||
plink: docker_mcp_config.yaml
|
||||
deprecated: false
|
||||
hidden: true
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-13
@@ -1,13 +0,0 @@
|
||||
command: docker mcp config read
|
||||
short: Read the configuration
|
||||
long: Read the configuration
|
||||
usage: docker mcp config read
|
||||
pname: docker mcp config
|
||||
plink: docker_mcp_config.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-13
@@ -1,13 +0,0 @@
|
||||
command: docker mcp config reset
|
||||
short: Reset the configuration
|
||||
long: Reset the configuration
|
||||
usage: docker mcp config reset
|
||||
pname: docker mcp config
|
||||
plink: docker_mcp_config.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-13
@@ -1,13 +0,0 @@
|
||||
command: docker mcp config restore
|
||||
short: Restore the whole configuration
|
||||
long: Restore the whole configuration
|
||||
usage: docker mcp config restore
|
||||
pname: docker mcp config
|
||||
plink: docker_mcp_config.yaml
|
||||
deprecated: false
|
||||
hidden: true
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-13
@@ -1,13 +0,0 @@
|
||||
command: docker mcp config write
|
||||
short: Write the configuration
|
||||
long: Write the configuration
|
||||
usage: docker mcp config write
|
||||
pname: docker mcp config
|
||||
plink: docker_mcp_config.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
-49
@@ -1,49 +0,0 @@
|
||||
command: docker mcp import
|
||||
short: Import a server
|
||||
long: |-
|
||||
Import and parse a server definition from an official MCP registry URL.
|
||||
|
||||
This command fetches the server definition from the provided URL, parses it as a ServerDetail,
|
||||
converts it to the internal Server format, and displays the results.
|
||||
|
||||
Example:
|
||||
docker mcp officialregistry import https://registry.example.com/servers/my-server
|
||||
usage: docker mcp import
|
||||
pname: docker mcp
|
||||
plink: docker_mcp.yaml
|
||||
options:
|
||||
- option: catalog
|
||||
value_type: string
|
||||
description: import to local catalog
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: mcp-registry
|
||||
value_type: string
|
||||
description: import from MCP registry format
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: push
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: push the new server artifact
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
-18
@@ -1,18 +0,0 @@
|
||||
command: docker mcp oauth
|
||||
pname: docker mcp
|
||||
plink: docker_mcp.yaml
|
||||
cname:
|
||||
- docker mcp oauth authorize
|
||||
- docker mcp oauth ls
|
||||
- docker mcp oauth revoke
|
||||
clink:
|
||||
- docker_mcp_oauth_authorize.yaml
|
||||
- docker_mcp_oauth_ls.yaml
|
||||
- docker_mcp_oauth_revoke.yaml
|
||||
deprecated: false
|
||||
hidden: true
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-23
@@ -1,23 +0,0 @@
|
||||
command: docker mcp oauth authorize
|
||||
short: Authorize the specified OAuth app.
|
||||
long: Authorize the specified OAuth app.
|
||||
usage: docker mcp oauth authorize <app>
|
||||
pname: docker mcp oauth
|
||||
plink: docker_mcp_oauth.yaml
|
||||
options:
|
||||
- option: scopes
|
||||
value_type: string
|
||||
description: OAuth scopes to request (space-separated)
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
hidden: true
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
-24
@@ -1,24 +0,0 @@
|
||||
command: docker mcp oauth ls
|
||||
short: List available OAuth apps.
|
||||
long: List available OAuth apps.
|
||||
usage: docker mcp oauth ls
|
||||
pname: docker mcp oauth
|
||||
plink: docker_mcp_oauth.yaml
|
||||
options:
|
||||
- option: json
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Print as JSON.
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
hidden: true
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-13
@@ -1,13 +0,0 @@
|
||||
command: docker mcp oauth revoke
|
||||
short: Revoke the specified OAuth app.
|
||||
long: Revoke the specified OAuth app.
|
||||
usage: docker mcp oauth revoke <app>
|
||||
pname: docker mcp oauth
|
||||
plink: docker_mcp_oauth.yaml
|
||||
deprecated: false
|
||||
hidden: true
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
command: docker mcp policy
|
||||
aliases: docker mcp policy, docker mcp policies
|
||||
short: Manage secret policies
|
||||
long: Manage secret policies
|
||||
pname: docker mcp
|
||||
plink: docker_mcp.yaml
|
||||
cname:
|
||||
- docker mcp policy dump
|
||||
- docker mcp policy set
|
||||
clink:
|
||||
- docker_mcp_policy_dump.yaml
|
||||
- docker_mcp_policy_set.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-13
@@ -1,13 +0,0 @@
|
||||
command: docker mcp policy dump
|
||||
short: Dump the policy content
|
||||
long: Dump the policy content
|
||||
usage: docker mcp policy dump
|
||||
pname: docker mcp policy
|
||||
plink: docker_mcp_policy.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
-22
@@ -1,22 +0,0 @@
|
||||
command: docker mcp policy set
|
||||
short: Set a policy for secret management in Docker Desktop
|
||||
long: Set a policy for secret management in Docker Desktop
|
||||
usage: docker mcp policy set <content>
|
||||
pname: docker mcp policy
|
||||
plink: docker_mcp_policy.yaml
|
||||
examples: |-
|
||||
### Backup the current policy to a file
|
||||
docker mcp policy dump > policy.conf
|
||||
|
||||
### Set a new policy
|
||||
docker mcp policy set "my-secret allows postgres"
|
||||
|
||||
### Restore the previous policy
|
||||
cat policy.conf | docker mcp policy set
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
-16
@@ -1,16 +0,0 @@
|
||||
command: docker mcp registry
|
||||
short: Registry operations
|
||||
long: Registry operations
|
||||
pname: docker mcp
|
||||
plink: docker_mcp.yaml
|
||||
cname:
|
||||
- docker mcp registry convert
|
||||
clink:
|
||||
- docker_mcp_registry_convert.yaml
|
||||
deprecated: false
|
||||
hidden: true
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-23
@@ -1,23 +0,0 @@
|
||||
command: docker mcp registry convert
|
||||
short: Convert OCI registry server definition to catalog server format
|
||||
long: Convert OCI registry server definition to catalog server format
|
||||
usage: docker mcp registry convert
|
||||
pname: docker mcp registry
|
||||
plink: docker_mcp_registry.yaml
|
||||
options:
|
||||
- option: file
|
||||
value_type: string
|
||||
description: Path to the OCI registry server definition JSON file
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
hidden: true
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-13
@@ -1,13 +0,0 @@
|
||||
command: docker mcp secret export
|
||||
short: Export secrets for the specified servers
|
||||
long: Export secrets for the specified servers
|
||||
usage: docker mcp secret export [server1] [server2] ...
|
||||
pname: docker mcp secret
|
||||
plink: docker_mcp_secret.yaml
|
||||
deprecated: false
|
||||
hidden: true
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
-24
@@ -1,24 +0,0 @@
|
||||
command: docker mcp server
|
||||
short: Manage servers
|
||||
long: Manage servers
|
||||
pname: docker mcp
|
||||
plink: docker_mcp.yaml
|
||||
cname:
|
||||
- docker mcp server disable
|
||||
- docker mcp server enable
|
||||
- docker mcp server inspect
|
||||
- docker mcp server ls
|
||||
- docker mcp server reset
|
||||
clink:
|
||||
- docker_mcp_server_disable.yaml
|
||||
- docker_mcp_server_enable.yaml
|
||||
- docker_mcp_server_inspect.yaml
|
||||
- docker_mcp_server_ls.yaml
|
||||
- docker_mcp_server_reset.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-14
@@ -1,14 +0,0 @@
|
||||
command: docker mcp server disable
|
||||
aliases: docker mcp server disable, docker mcp server remove, docker mcp server rm
|
||||
short: Disable a server or multiple servers
|
||||
long: Disable a server or multiple servers
|
||||
usage: docker mcp server disable
|
||||
pname: docker mcp server
|
||||
plink: docker_mcp_server.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-14
@@ -1,14 +0,0 @@
|
||||
command: docker mcp server enable
|
||||
aliases: docker mcp server enable, docker mcp server add
|
||||
short: Enable a server or multiple servers
|
||||
long: Enable a server or multiple servers
|
||||
usage: docker mcp server enable
|
||||
pname: docker mcp server
|
||||
plink: docker_mcp_server.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-24
@@ -1,24 +0,0 @@
|
||||
command: docker mcp server import
|
||||
short: Import a server
|
||||
long: Import a server
|
||||
usage: docker mcp server import
|
||||
pname: docker mcp server
|
||||
plink: docker_mcp_server.yaml
|
||||
options:
|
||||
- option: push
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: push the new server artifact
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-13
@@ -1,13 +0,0 @@
|
||||
command: docker mcp server inspect
|
||||
short: Get information about a server or inspect an OCI artifact
|
||||
long: Get information about a server or inspect an OCI artifact
|
||||
usage: docker mcp server inspect
|
||||
pname: docker mcp server
|
||||
plink: docker_mcp_server.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-25
@@ -1,25 +0,0 @@
|
||||
command: docker mcp server list
|
||||
aliases: docker mcp server list, docker mcp server ls
|
||||
short: List enabled servers
|
||||
long: List enabled servers
|
||||
usage: docker mcp server list
|
||||
pname: docker mcp server
|
||||
plink: docker_mcp_server.yaml
|
||||
options:
|
||||
- option: json
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Output in JSON format
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
-25
@@ -1,25 +0,0 @@
|
||||
command: docker mcp server ls
|
||||
aliases: docker mcp server ls, docker mcp server list
|
||||
short: List enabled servers
|
||||
long: List enabled servers
|
||||
usage: docker mcp server ls
|
||||
pname: docker mcp server
|
||||
plink: docker_mcp_server.yaml
|
||||
options:
|
||||
- option: json
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Output in JSON format
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-13
@@ -1,13 +0,0 @@
|
||||
command: docker mcp server reset
|
||||
short: Disable all the servers
|
||||
long: Disable all the servers
|
||||
usage: docker mcp server reset
|
||||
pname: docker mcp server
|
||||
plink: docker_mcp_server.yaml
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
||||
Generated
-65
@@ -1,65 +0,0 @@
|
||||
command: docker mcp tools disable
|
||||
short: disable one or more tools
|
||||
long: disable one or more tools
|
||||
usage: docker mcp tools disable [tool1] [tool2] ...
|
||||
pname: docker mcp tools
|
||||
plink: docker_mcp_tools.yaml
|
||||
options:
|
||||
- option: server
|
||||
value_type: string
|
||||
description: |
|
||||
Specify which server provides the tools (optional, will auto-discover if not provided)
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
inherited_options:
|
||||
- option: format
|
||||
value_type: string
|
||||
default_value: list
|
||||
description: Output format (json|list)
|
||||
deprecated: false
|
||||
hidden: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: gateway-arg
|
||||
value_type: stringSlice
|
||||
default_value: '[]'
|
||||
description: Additional arguments passed to the gateway
|
||||
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: version
|
||||
value_type: string
|
||||
default_value: "2"
|
||||
description: Version of 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
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
# docker mcp
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Manage MCP servers and clients
|
||||
|
||||
### Subcommands
|
||||
|
||||
| Name | Description |
|
||||
|:----------------------------|:------------------------------|
|
||||
| [`catalog`](mcp_catalog.md) | Manage MCP server catalogs |
|
||||
| [`client`](mcp_client.md) | Manage MCP clients |
|
||||
| [`config`](mcp_config.md) | Manage the configuration |
|
||||
| [`feature`](mcp_feature.md) | Manage experimental features |
|
||||
| [`gateway`](mcp_gateway.md) | Manage the MCP Server gateway |
|
||||
| [`policy`](mcp_policy.md) | Manage secret policies |
|
||||
| [`secret`](mcp_secret.md) | Manage secrets |
|
||||
| [`server`](mcp_server.md) | Manage servers |
|
||||
| [`tools`](mcp_tools.md) | Manage tools |
|
||||
| [`version`](mcp_version.md) | Show the version information |
|
||||
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:------------------|:-------|:--------|:-----------------------------------|
|
||||
| `-v`, `--version` | `bool` | | Print version information and quit |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
## Description
|
||||
|
||||
The MCP Gateway is Docker's open-source enterprise solution for orchestrating
|
||||
Model Context Protocol (MCP) servers and clients.
|
||||
|
||||
For more information see [Docker MCP](https://docs.docker.com/ai/mcp-gateway/) and
|
||||
the public [GitHub repository](https://github.com/docker/mcp-gateway).
|
||||
-30
@@ -1,30 +0,0 @@
|
||||
# docker mcp catalog
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Manage MCP server catalogs for organizing and configuring custom MCP servers alongside Docker's official catalog.
|
||||
|
||||
### Aliases
|
||||
|
||||
`docker mcp catalog`, `docker mcp catalogs`
|
||||
|
||||
### Subcommands
|
||||
|
||||
| Name | Description |
|
||||
|:----------------------------------------|:------------------------------------------------------------------------------------|
|
||||
| [`add`](mcp_catalog_add.md) | Add a server to a catalog |
|
||||
| [`bootstrap`](mcp_catalog_bootstrap.md) | Create a starter catalog file with Docker and Docker Hub server entries as examples |
|
||||
| [`create`](mcp_catalog_create.md) | Create a new empty catalog |
|
||||
| [`export`](mcp_catalog_export.md) | Export a configured catalog to a file |
|
||||
| [`fork`](mcp_catalog_fork.md) | Create a copy of an existing catalog |
|
||||
| [`import`](mcp_catalog_import.md) | Import a catalog from URL or file |
|
||||
| [`init`](mcp_catalog_init.md) | Initialize the catalog system |
|
||||
| [`ls`](mcp_catalog_ls.md) | List all configured catalogs |
|
||||
| [`reset`](mcp_catalog_reset.md) | Reset the catalog system |
|
||||
| [`rm`](mcp_catalog_rm.md) | Remove a catalog |
|
||||
| [`show`](mcp_catalog_show.md) | Display catalog contents |
|
||||
| [`update`](mcp_catalog_update.md) | Update catalog(s) from remote sources |
|
||||
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-15
@@ -1,15 +0,0 @@
|
||||
# docker mcp catalog add
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Add an MCP server definition to an existing catalog by copying it from another catalog file.
|
||||
The server definition includes all configuration, tools, and metadata.
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:----------|:-------|:--------|:-----------------------------------------|
|
||||
| `--force` | `bool` | | Overwrite existing server in the catalog |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
# docker mcp catalog bootstrap
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Create a starter catalog file with Docker Hub and Docker CLI server entries as examples.
|
||||
This command extracts the official Docker server definitions and creates a properly formatted
|
||||
catalog file that users can modify and use as a foundation for their custom catalogs.
|
||||
|
||||
The output file is standalone and not automatically imported - users can modify it and then
|
||||
import it or use it as a source for the 'catalog add' command.
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-8
@@ -1,8 +0,0 @@
|
||||
# docker mcp catalog create
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Create a new empty catalog for organizing custom MCP servers. The catalog will be stored locally and can be populated using 'docker mcp catalog add'.
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-10
@@ -1,10 +0,0 @@
|
||||
# docker mcp catalog export
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Export a user-managed catalog to a file. This command only works with catalogs
|
||||
that have been imported or configured manually. The canonical Docker MCP catalog
|
||||
cannot be exported as it is managed by Docker.
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-8
@@ -1,8 +0,0 @@
|
||||
# docker mcp catalog fork
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Create a new catalog by copying all servers from an existing catalog. Useful for creating variations of existing catalogs.
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
# docker mcp catalog import
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Import an MCP server catalog from a URL or local file. The catalog will be downloaded
|
||||
and stored locally for use with the MCP gateway.
|
||||
|
||||
When --mcp-registry flag is used, the argument must be an existing catalog name, and the
|
||||
command will import servers from the MCP registry URL into that catalog.
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:-----------------|:---------|:--------|:----------------------------------------------------------|
|
||||
| `--dry-run` | `bool` | | Show Imported Data but do not update the Catalog |
|
||||
| `--mcp-registry` | `string` | | Import server from MCP registry URL into existing catalog |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-8
@@ -1,8 +0,0 @@
|
||||
# docker mcp catalog init
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Initialize the local catalog management system by creating the necessary configuration files and directories.
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-14
@@ -1,14 +0,0 @@
|
||||
# docker mcp catalog ls
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
List all configured catalogs including Docker's official catalog and any locally managed catalogs.
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:-----------|:---------|:--------|:------------------------------------------|
|
||||
| `--format` | `format` | | Output format. Supported: "json", "yaml". |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-12
@@ -1,12 +0,0 @@
|
||||
# docker mcp catalog reset
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Reset the local catalog management system by removing all user-managed catalogs and configuration. This does not affect Docker's official catalog.
|
||||
|
||||
### Aliases
|
||||
|
||||
`docker mcp catalog reset`, `docker mcp catalog empty`
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
# docker mcp catalog rm
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Remove a locally configured catalog. This will delete the catalog and all its server definitions.
|
||||
The Docker official catalog cannot be removed.
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-15
@@ -1,15 +0,0 @@
|
||||
# docker mcp catalog show
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Display the contents of a catalog including all server definitions and metadata.
|
||||
If no name is provided, shows the Docker official catalog.
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:-----------|:---------|:--------|:---------------------------|
|
||||
| `--format` | `format` | | Supported: "json", "yaml". |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
# docker mcp catalog update
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Update one or more catalogs by re-downloading from their original sources.
|
||||
If no name is provided, updates all catalogs that have remote sources.
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-17
@@ -1,17 +0,0 @@
|
||||
# docker mcp client
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Manage MCP clients
|
||||
|
||||
### Subcommands
|
||||
|
||||
| Name | Description |
|
||||
|:-----------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [`connect`](mcp_client_connect.md) | Connect the Docker MCP Toolkit to a client. Supported clients: claude-code claude-desktop codex continue cursor gemini goose gordon lmstudio opencode sema4 vscode zed |
|
||||
| [`disconnect`](mcp_client_disconnect.md) | Disconnect the Docker MCP Toolkit from a client. Supported clients: claude-code claude-desktop codex continue cursor gemini goose gordon lmstudio opencode sema4 vscode zed |
|
||||
| [`ls`](mcp_client_ls.md) | List client configurations |
|
||||
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-15
@@ -1,15 +0,0 @@
|
||||
# docker mcp client connect
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Connect the Docker MCP Toolkit to a client. Supported clients: claude-code claude-desktop codex continue cursor gemini goose gordon lmstudio opencode sema4 vscode zed
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:-----------------|:-------|:--------|:------------------------------------------------------------------------------------|
|
||||
| `-g`, `--global` | `bool` | | Change the system wide configuration or the clients setup in your current git repo. |
|
||||
| `-q`, `--quiet` | `bool` | | Only display errors. |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-15
@@ -1,15 +0,0 @@
|
||||
# docker mcp client disconnect
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Disconnect the Docker MCP Toolkit from a client. Supported clients: claude-code claude-desktop codex continue cursor gemini goose gordon lmstudio opencode sema4 vscode zed
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:-----------------|:-------|:--------|:------------------------------------------------------------------------------------|
|
||||
| `-g`, `--global` | `bool` | | Change the system wide configuration or the clients setup in your current git repo. |
|
||||
| `-q`, `--quiet` | `bool` | | Only display errors. |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-15
@@ -1,15 +0,0 @@
|
||||
# docker mcp client ls
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
List client configurations
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:-----------------|:-------|:--------|:------------------------------------------------------------------------------------|
|
||||
| `-g`, `--global` | `bool` | | Change the system wide configuration or the clients setup in your current git repo. |
|
||||
| `--json` | `bool` | | Print as JSON. |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-17
@@ -1,17 +0,0 @@
|
||||
# docker mcp config
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Manage the configuration
|
||||
|
||||
### Subcommands
|
||||
|
||||
| Name | Description |
|
||||
|:-------------------------------|:------------------------|
|
||||
| [`read`](mcp_config_read.md) | Read the configuration |
|
||||
| [`reset`](mcp_config_reset.md) | Reset the configuration |
|
||||
| [`write`](mcp_config_write.md) | Write the configuration |
|
||||
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-8
@@ -1,8 +0,0 @@
|
||||
# docker mcp config read
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Read the configuration
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-8
@@ -1,8 +0,0 @@
|
||||
# docker mcp config reset
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Reset the configuration
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-8
@@ -1,8 +0,0 @@
|
||||
# docker mcp config write
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Write the configuration
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-20
@@ -1,20 +0,0 @@
|
||||
# docker mcp feature
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Manage experimental features for Docker MCP Gateway.
|
||||
|
||||
Features are stored in your Docker configuration file (~/.docker/config.json)
|
||||
and control optional functionality that may change in future versions.
|
||||
|
||||
### Subcommands
|
||||
|
||||
| Name | Description |
|
||||
|:------------------------------------|:---------------------------------------------|
|
||||
| [`disable`](mcp_feature_disable.md) | Disable an experimental feature |
|
||||
| [`enable`](mcp_feature_enable.md) | Enable an experimental feature |
|
||||
| [`ls`](mcp_feature_ls.md) | List all available features and their status |
|
||||
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-8
@@ -1,8 +0,0 @@
|
||||
# docker mcp feature disable
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Disable an experimental feature that was previously enabled.
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-13
@@ -1,13 +0,0 @@
|
||||
# docker mcp feature enable
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Enable an experimental feature.
|
||||
|
||||
Available features:
|
||||
oauth-interceptor Enable GitHub OAuth flow interception for automatic authentication
|
||||
mcp-oauth-dcr Enable Dynamic Client Registration (DCR) for automatic OAuth client setup
|
||||
dynamic-tools Enable internal MCP management tools (mcp-find, mcp-add, mcp-remove)
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-8
@@ -1,8 +0,0 @@
|
||||
# docker mcp feature list
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
List all available experimental features and show whether they are enabled or disabled.
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-12
@@ -1,12 +0,0 @@
|
||||
# docker mcp feature ls
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
List all available experimental features and show whether they are enabled or disabled.
|
||||
|
||||
### Aliases
|
||||
|
||||
`docker mcp feature ls`, `docker mcp feature list`
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-15
@@ -1,15 +0,0 @@
|
||||
# docker mcp gateway
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Manage the MCP Server gateway
|
||||
|
||||
### Subcommands
|
||||
|
||||
| Name | Description |
|
||||
|:----------------------------|:----------------|
|
||||
| [`run`](mcp_gateway_run.md) | Run the gateway |
|
||||
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-42
@@ -1,42 +0,0 @@
|
||||
# docker mcp gateway run
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Run the gateway
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:----------------------------|:--------------|:--------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `--additional-catalog` | `stringSlice` | | Additional catalog paths to append to the default catalogs |
|
||||
| `--additional-config` | `stringSlice` | | Additional config paths to merge with the default config.yaml |
|
||||
| `--additional-registry` | `stringSlice` | | Additional registry paths to merge with the default registry.yaml |
|
||||
| `--additional-tools-config` | `stringSlice` | | Additional tools paths to merge with the default tools.yaml |
|
||||
| `--block-network` | `bool` | | Block tools from accessing forbidden network resources |
|
||||
| `--block-secrets` | `bool` | `true` | Block secrets from being/received sent to/from tools |
|
||||
| `--catalog` | `stringSlice` | `[docker-mcp.yaml]` | Paths to docker catalogs (absolute or relative to ~/.docker/mcp/catalogs/) |
|
||||
| `--config` | `stringSlice` | `[config.yaml]` | Paths to the config files (absolute or relative to ~/.docker/mcp/) |
|
||||
| `--cpus` | `int` | `1` | CPUs allocated to each MCP Server (default is 1) |
|
||||
| `--debug-dns` | `bool` | | Debug DNS resolution |
|
||||
| `--dry-run` | `bool` | | Start the gateway but do not listen for connections (useful for testing the configuration) |
|
||||
| `--enable-all-servers` | `bool` | | Enable all servers in the catalog (instead of using individual --servers options) |
|
||||
| `--interceptor` | `stringArray` | | List of interceptors to use (format: when:type:path, e.g. 'before:exec:/bin/path') |
|
||||
| `--log-calls` | `bool` | `true` | Log calls to the tools |
|
||||
| `--long-lived` | `bool` | | Containers are long-lived and will not be removed until the gateway is stopped, useful for stateful servers |
|
||||
| `--mcp-registry` | `stringSlice` | | MCP registry URLs to fetch servers from (can be repeated) |
|
||||
| `--memory` | `string` | `2Gb` | Memory allocated to each MCP Server (default is 2Gb) |
|
||||
| `--oci-ref` | `stringArray` | | OCI image references to use |
|
||||
| `--port` | `int` | `0` | TCP port to listen on (default is to listen on stdio) |
|
||||
| `--registry` | `stringSlice` | `[registry.yaml]` | Paths to the registry files (absolute or relative to ~/.docker/mcp/) |
|
||||
| `--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) |
|
||||
| `--servers` | `stringSlice` | | Names of the servers to enable (if non empty, ignore --registry flag) |
|
||||
| `--static` | `bool` | | Enable static mode (aka pre-started servers) |
|
||||
| `--tools` | `stringSlice` | | List of tools to enable |
|
||||
| `--tools-config` | `stringSlice` | `[tools.yaml]` | Paths to the tools files (absolute or relative to ~/.docker/mcp/) |
|
||||
| `--transport` | `string` | `stdio` | stdio, sse or streaming (default is stdio) |
|
||||
| `--verbose` | `bool` | | Verbose output |
|
||||
| `--verify-signatures` | `bool` | | Verify signatures of the server images |
|
||||
| `--watch` | `bool` | `true` | Watch for changes and reconfigure the gateway |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-22
@@ -1,22 +0,0 @@
|
||||
# docker mcp import
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Import and parse a server definition from an official MCP registry URL.
|
||||
|
||||
This command fetches the server definition from the provided URL, parses it as a ServerDetail,
|
||||
converts it to the internal Server format, and displays the results.
|
||||
|
||||
Example:
|
||||
docker mcp officialregistry import https://registry.example.com/servers/my-server
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:-----------------|:---------|:--------|:--------------------------------|
|
||||
| `--catalog` | `string` | | import to local catalog |
|
||||
| `--mcp-registry` | `string` | | import from MCP registry format |
|
||||
| `--push` | `bool` | | push the new server artifact |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-20
@@ -1,20 +0,0 @@
|
||||
# docker mcp policy
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Manage secret policies
|
||||
|
||||
### Aliases
|
||||
|
||||
`docker mcp policy`, `docker mcp policies`
|
||||
|
||||
### Subcommands
|
||||
|
||||
| Name | Description |
|
||||
|:-----------------------------|:-----------------------------------------------------|
|
||||
| [`dump`](mcp_policy_dump.md) | Dump the policy content |
|
||||
| [`set`](mcp_policy_set.md) | Set a policy for secret management in Docker Desktop |
|
||||
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-8
@@ -1,8 +0,0 @@
|
||||
# docker mcp policy dump
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Dump the policy content
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-8
@@ -1,8 +0,0 @@
|
||||
# docker mcp policy set
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Set a policy for secret management in Docker Desktop
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-17
@@ -1,17 +0,0 @@
|
||||
# docker mcp secret
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Manage secrets
|
||||
|
||||
### Subcommands
|
||||
|
||||
| Name | Description |
|
||||
|:---------------------------|:-------------------------------------------------------|
|
||||
| [`ls`](mcp_secret_ls.md) | List all secret names in Docker Desktop's secret store |
|
||||
| [`rm`](mcp_secret_rm.md) | Remove secrets from Docker Desktop's secret store |
|
||||
| [`set`](mcp_secret_set.md) | Set a secret in Docker Desktop's secret store |
|
||||
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-14
@@ -1,14 +0,0 @@
|
||||
# docker mcp secret ls
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
List all secret names in Docker Desktop's secret store
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:---------|:-------|:--------|:---------------|
|
||||
| `--json` | `bool` | | Print as JSON. |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-14
@@ -1,14 +0,0 @@
|
||||
# docker mcp secret rm
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Remove secrets from Docker Desktop's secret store
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:--------|:-------|:--------|:-------------------|
|
||||
| `--all` | `bool` | | Remove all secrets |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-29
@@ -1,29 +0,0 @@
|
||||
# docker mcp secret set
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Set a secret in Docker Desktop's secret store
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:-------------|:---------|:--------|:---------------------------------------|
|
||||
| `--provider` | `string` | | Supported: credstore, oauth/<provider> |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
## Examples
|
||||
|
||||
### Use secrets for postgres password with default policy
|
||||
|
||||
```console
|
||||
docker mcp secret set POSTGRES_PASSWORD=my-secret-password
|
||||
docker run -d -l x-secret:POSTGRES_PASSWORD=/pwd.txt -e POSTGRES_PASSWORD_FILE=/pwd.txt -p 5432 postgres
|
||||
```
|
||||
|
||||
### Pass the secret via STDIN
|
||||
|
||||
```console
|
||||
echo my-secret-password > pwd.txt
|
||||
cat pwd.txt | docker mcp secret set POSTGRES_PASSWORD
|
||||
```
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
# docker mcp server
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Manage servers
|
||||
|
||||
### Subcommands
|
||||
|
||||
| Name | Description |
|
||||
|:-----------------------------------|:----------------------------------------------------------|
|
||||
| [`disable`](mcp_server_disable.md) | Disable a server or multiple servers |
|
||||
| [`enable`](mcp_server_enable.md) | Enable a server or multiple servers |
|
||||
| [`inspect`](mcp_server_inspect.md) | Get information about a server or inspect an OCI artifact |
|
||||
| [`ls`](mcp_server_ls.md) | List enabled servers |
|
||||
| [`reset`](mcp_server_reset.md) | Disable all the servers |
|
||||
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-12
@@ -1,12 +0,0 @@
|
||||
# docker mcp server disable
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Disable a server or multiple servers
|
||||
|
||||
### Aliases
|
||||
|
||||
`docker mcp server disable`, `docker mcp server remove`, `docker mcp server rm`
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-12
@@ -1,12 +0,0 @@
|
||||
# docker mcp server enable
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Enable a server or multiple servers
|
||||
|
||||
### Aliases
|
||||
|
||||
`docker mcp server enable`, `docker mcp server add`
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-14
@@ -1,14 +0,0 @@
|
||||
# docker mcp server import
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Import a server
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:---------|:-------|:--------|:-----------------------------|
|
||||
| `--push` | `bool` | | push the new server artifact |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-8
@@ -1,8 +0,0 @@
|
||||
# docker mcp server inspect
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Get information about a server or inspect an OCI artifact
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-18
@@ -1,18 +0,0 @@
|
||||
# docker mcp server list
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
List enabled servers
|
||||
|
||||
### Aliases
|
||||
|
||||
`docker mcp server list`, `docker mcp server ls`
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:---------|:-------|:--------|:----------------------|
|
||||
| `--json` | `bool` | | Output in JSON format |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-18
@@ -1,18 +0,0 @@
|
||||
# docker mcp server ls
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
List enabled servers
|
||||
|
||||
### Aliases
|
||||
|
||||
`docker mcp server ls`, `docker mcp server list`
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:---------|:-------|:--------|:----------------------|
|
||||
| `--json` | `bool` | | Output in JSON format |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-8
@@ -1,8 +0,0 @@
|
||||
# docker mcp server reset
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Disable all the servers
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
# docker mcp tools
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Manage tools
|
||||
|
||||
### Subcommands
|
||||
|
||||
| Name | Description |
|
||||
|:----------------------------------|:--------------------------|
|
||||
| [`call`](mcp_tools_call.md) | Call a tool |
|
||||
| [`count`](mcp_tools_count.md) | Count tools |
|
||||
| [`disable`](mcp_tools_disable.md) | disable one or more tools |
|
||||
| [`enable`](mcp_tools_enable.md) | enable one or more tools |
|
||||
| [`inspect`](mcp_tools_inspect.md) | Inspect a tool |
|
||||
| [`ls`](mcp_tools_ls.md) | List tools |
|
||||
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:----------------|:--------------|:--------|:-------------------------------------------|
|
||||
| `--format` | `string` | `list` | Output format (json\|list) |
|
||||
| `--gateway-arg` | `stringSlice` | | Additional arguments passed to the gateway |
|
||||
| `--verbose` | `bool` | | Verbose output |
|
||||
| `--version` | `string` | `2` | Version of the gateway |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-17
@@ -1,17 +0,0 @@
|
||||
# docker mcp tools call
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Call a tool
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:----------------|:--------------|:--------|:-------------------------------------------|
|
||||
| `--format` | `string` | `list` | Output format (json\|list) |
|
||||
| `--gateway-arg` | `stringSlice` | | Additional arguments passed to the gateway |
|
||||
| `--verbose` | `bool` | | Verbose output |
|
||||
| `--version` | `string` | `2` | Version of the gateway |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-17
@@ -1,17 +0,0 @@
|
||||
# docker mcp tools count
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Count tools
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:----------------|:--------------|:--------|:-------------------------------------------|
|
||||
| `--format` | `string` | `list` | Output format (json\|list) |
|
||||
| `--gateway-arg` | `stringSlice` | | Additional arguments passed to the gateway |
|
||||
| `--verbose` | `bool` | | Verbose output |
|
||||
| `--version` | `string` | `2` | Version of the gateway |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-18
@@ -1,18 +0,0 @@
|
||||
# docker mcp tools disable
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
disable one or more tools
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:----------------|:--------------|:--------|:---------------------------------------------------------------------------------------|
|
||||
| `--format` | `string` | `list` | Output format (json\|list) |
|
||||
| `--gateway-arg` | `stringSlice` | | Additional arguments passed to the gateway |
|
||||
| `--server` | `string` | | Specify which server provides the tools (optional, will auto-discover if not provided) |
|
||||
| `--verbose` | `bool` | | Verbose output |
|
||||
| `--version` | `string` | `2` | Version of the gateway |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-18
@@ -1,18 +0,0 @@
|
||||
# docker mcp tools enable
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
enable one or more tools
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:----------------|:--------------|:--------|:---------------------------------------------------------------------------------------|
|
||||
| `--format` | `string` | `list` | Output format (json\|list) |
|
||||
| `--gateway-arg` | `stringSlice` | | Additional arguments passed to the gateway |
|
||||
| `--server` | `string` | | Specify which server provides the tools (optional, will auto-discover if not provided) |
|
||||
| `--verbose` | `bool` | | Verbose output |
|
||||
| `--version` | `string` | `2` | Version of the gateway |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-17
@@ -1,17 +0,0 @@
|
||||
# docker mcp tools inspect
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Inspect a tool
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:----------------|:--------------|:--------|:-------------------------------------------|
|
||||
| `--format` | `string` | `list` | Output format (json\|list) |
|
||||
| `--gateway-arg` | `stringSlice` | | Additional arguments passed to the gateway |
|
||||
| `--verbose` | `bool` | | Verbose output |
|
||||
| `--version` | `string` | `2` | Version of the gateway |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-21
@@ -1,21 +0,0 @@
|
||||
# docker mcp tools list
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
List tools
|
||||
|
||||
### Aliases
|
||||
|
||||
`docker mcp tools list`, `docker mcp tools ls`
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:----------------|:--------------|:--------|:-------------------------------------------|
|
||||
| `--format` | `string` | `list` | Output format (json\|list) |
|
||||
| `--gateway-arg` | `stringSlice` | | Additional arguments passed to the gateway |
|
||||
| `--verbose` | `bool` | | Verbose output |
|
||||
| `--version` | `string` | `2` | Version of the gateway |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-21
@@ -1,21 +0,0 @@
|
||||
# docker mcp tools ls
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
List tools
|
||||
|
||||
### Aliases
|
||||
|
||||
`docker mcp tools ls`, `docker mcp tools list`
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|:----------------|:--------------|:--------|:-------------------------------------------|
|
||||
| `--format` | `string` | `list` | Output format (json\|list) |
|
||||
| `--gateway-arg` | `stringSlice` | | Additional arguments passed to the gateway |
|
||||
| `--verbose` | `bool` | | Verbose output |
|
||||
| `--version` | `string` | `2` | Version of the gateway |
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
-8
@@ -1,8 +0,0 @@
|
||||
# docker mcp version
|
||||
|
||||
<!---MARKER_GEN_START-->
|
||||
Show the version information
|
||||
|
||||
|
||||
<!---MARKER_GEN_END-->
|
||||
|
||||
Generated
-1
@@ -4,4 +4,3 @@
|
||||
# github.com/docker/cli v29.2.0+incompatible
|
||||
# github.com/docker/compose/v5 v5.0.2
|
||||
# github.com/docker/model-runner/cmd/cli v1.0.3
|
||||
# github.com/docker/mcp-gateway v0.22.0
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
datafolder: mcp-cli
|
||||
datafile: docker_mcp_catalog_update
|
||||
title: docker mcp catalog update
|
||||
layout: cli
|
||||
---
|
||||
|
||||
<!--
|
||||
This page is automatically generated from Docker's source code. If you want to
|
||||
suggest a change to the text that appears here, open a ticket or pull request
|
||||
in the source repository on GitHub:
|
||||
|
||||
https://github.com/docker/mcp-gateway
|
||||
-->
|
||||
|
||||
File renamed without changes.
+2
-3
@@ -1,7 +1,7 @@
|
||||
---
|
||||
datafolder: mcp-cli
|
||||
datafile: docker_mcp_catalog_add
|
||||
title: docker mcp catalog add
|
||||
datafile: docker_mcp_catalog_list
|
||||
title: docker mcp catalog list
|
||||
layout: cli
|
||||
---
|
||||
|
||||
@@ -12,4 +12,3 @@ in the source repository on GitHub:
|
||||
|
||||
https://github.com/docker/mcp-gateway
|
||||
-->
|
||||
|
||||
File renamed without changes.
+2
-3
@@ -1,7 +1,7 @@
|
||||
---
|
||||
datafolder: mcp-cli
|
||||
datafile: docker_mcp_config_dump
|
||||
title: docker mcp config dump
|
||||
datafile: docker_mcp_catalog_pull
|
||||
title: docker mcp catalog pull
|
||||
layout: cli
|
||||
---
|
||||
|
||||
@@ -12,4 +12,3 @@ in the source repository on GitHub:
|
||||
|
||||
https://github.com/docker/mcp-gateway
|
||||
-->
|
||||
|
||||
+2
-3
@@ -1,7 +1,7 @@
|
||||
---
|
||||
datafolder: mcp-cli
|
||||
datafile: docker_mcp_config_read
|
||||
title: docker mcp config read
|
||||
datafile: docker_mcp_catalog_push
|
||||
title: docker mcp catalog push
|
||||
layout: cli
|
||||
---
|
||||
|
||||
@@ -12,4 +12,3 @@ in the source repository on GitHub:
|
||||
|
||||
https://github.com/docker/mcp-gateway
|
||||
-->
|
||||
|
||||
+2
-3
@@ -1,7 +1,7 @@
|
||||
---
|
||||
datafolder: mcp-cli
|
||||
datafile: docker_mcp_catalog_reset
|
||||
title: docker mcp catalog reset
|
||||
datafile: docker_mcp_catalog_remove
|
||||
title: docker mcp catalog remove
|
||||
layout: cli
|
||||
---
|
||||
|
||||
@@ -12,4 +12,3 @@ in the source repository on GitHub:
|
||||
|
||||
https://github.com/docker/mcp-gateway
|
||||
-->
|
||||
|
||||
Loaded 100 of 213 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user