Skip to content

Commit ec2d04f

Browse files
committed
Docs
1 parent c429bdb commit ec2d04f

38 files changed

+332
-41
lines changed

docs/generator/reference/docker_mcp.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ cname:
1212
- docker mcp catalog
1313
- docker mcp client
1414
- docker mcp config
15+
- docker mcp feature
1516
- docker mcp gateway
1617
- docker mcp policy
1718
- docker mcp secret
@@ -22,6 +23,7 @@ clink:
2223
- docker_mcp_catalog.yaml
2324
- docker_mcp_client.yaml
2425
- docker_mcp_config.yaml
26+
- docker_mcp_feature.yaml
2527
- docker_mcp_gateway.yaml
2628
- docker_mcp_policy.yaml
2729
- docker_mcp_secret.yaml

docs/generator/reference/docker_mcp_catalog.yaml

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,34 @@
11
command: docker mcp catalog
22
aliases: docker mcp catalog, docker mcp catalogs
3-
short: Manage the catalog
4-
long: Manage the catalog
3+
short: Manage MCP server catalogs
4+
long: |
5+
Manage MCP server catalogs for organizing and configuring custom MCP servers alongside Docker's official catalog.
56
pname: docker mcp
67
plink: docker_mcp.yaml
78
cname:
9+
- docker mcp catalog add
10+
- docker mcp catalog bootstrap
11+
- docker mcp catalog create
12+
- docker mcp catalog export
13+
- docker mcp catalog fork
14+
- docker mcp catalog import
815
- docker mcp catalog init
916
- docker mcp catalog ls
1017
- docker mcp catalog reset
18+
- docker mcp catalog rm
1119
- docker mcp catalog show
1220
- docker mcp catalog update
1321
clink:
22+
- docker_mcp_catalog_add.yaml
23+
- docker_mcp_catalog_bootstrap.yaml
24+
- docker_mcp_catalog_create.yaml
25+
- docker_mcp_catalog_export.yaml
26+
- docker_mcp_catalog_fork.yaml
27+
- docker_mcp_catalog_import.yaml
1428
- docker_mcp_catalog_init.yaml
1529
- docker_mcp_catalog_ls.yaml
1630
- docker_mcp_catalog_reset.yaml
31+
- docker_mcp_catalog_rm.yaml
1732
- docker_mcp_catalog_show.yaml
1833
- docker_mcp_catalog_update.yaml
1934
deprecated: false

docs/generator/reference/docker_mcp_catalog_add.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
command: docker mcp catalog add
2-
short: Add a server to your catalog
3-
long: Add a server to your catalog
2+
short: Add a server to a catalog
3+
long: |-
4+
Add an MCP server definition to an existing catalog by copying it from another catalog file.
5+
The server definition includes all configuration, tools, and metadata.
46
usage: docker mcp catalog add <catalog> <server-name> <catalog-file>
57
pname: docker mcp catalog
68
plink: docker_mcp_catalog.yaml
@@ -15,8 +17,9 @@ options:
1517
experimentalcli: false
1618
kubernetes: false
1719
swarm: false
20+
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"
1821
deprecated: false
19-
hidden: true
22+
hidden: false
2023
experimental: false
2124
experimentalcli: false
2225
kubernetes: false
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
command: docker mcp catalog bootstrap
2+
short: |
3+
Create a starter catalog file with Docker and Docker Hub server entries as examples
4+
long: |-
5+
Create a starter catalog file with Docker Hub and Docker CLI server entries as examples.
6+
This command extracts the official Docker server definitions and creates a properly formatted
7+
catalog file that users can modify and use as a foundation for their custom catalogs.
8+
9+
The output file is standalone and not automatically imported - users can modify it and then
10+
import it or use it as a source for the 'catalog add' command.
11+
usage: docker mcp catalog bootstrap <output-file-path>
12+
pname: docker mcp catalog
13+
plink: docker_mcp_catalog.yaml
14+
deprecated: false
15+
hidden: false
16+
experimental: false
17+
experimentalcli: false
18+
kubernetes: false
19+
swarm: false
20+

docs/generator/reference/docker_mcp_catalog_create.yaml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
command: docker mcp catalog create
2-
short: Create a new catalog
3-
long: Create a new catalog
2+
short: Create a new empty catalog
3+
long: |
4+
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'.
45
usage: docker mcp catalog create <name>
56
pname: docker mcp catalog
67
plink: docker_mcp_catalog.yaml
8+
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"
79
deprecated: false
8-
hidden: true
10+
hidden: false
911
experimental: false
1012
experimentalcli: false
1113
kubernetes: false
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
command: docker mcp catalog export
2+
short: Export a configured catalog to a file
3+
long: |-
4+
Export a user-managed catalog to a file. This command only works with catalogs
5+
that have been imported or configured manually. The canonical Docker MCP catalog
6+
cannot be exported as it is managed by Docker.
7+
usage: docker mcp catalog export <catalog-name> <file-path>
8+
pname: docker mcp catalog
9+
plink: docker_mcp_catalog.yaml
10+
deprecated: false
11+
hidden: false
12+
experimental: false
13+
experimentalcli: false
14+
kubernetes: false
15+
swarm: false
16+

docs/generator/reference/docker_mcp_catalog_fork.yaml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
command: docker mcp catalog fork
2-
short: Fork a catalog
3-
long: Fork a catalog
2+
short: Create a copy of an existing catalog
3+
long: |
4+
Create a new catalog by copying all servers from an existing catalog. Useful for creating variations of existing catalogs.
45
usage: docker mcp catalog fork <src-catalog> <new-name>
56
pname: docker mcp catalog
67
plink: docker_mcp_catalog.yaml
8+
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"
79
deprecated: false
8-
hidden: true
10+
hidden: false
911
experimental: false
1012
experimentalcli: false
1113
kubernetes: false

docs/generator/reference/docker_mcp_catalog_import.yaml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
command: docker mcp catalog import
2-
short: Import a catalog
3-
long: Import a catalog
2+
short: Import a catalog from URL or file
3+
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."
44
usage: docker mcp catalog import <alias|url|file>
55
pname: docker mcp catalog
66
plink: docker_mcp_catalog.yaml
7+
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"
78
deprecated: false
8-
hidden: true
9+
hidden: false
910
experimental: false
1011
experimentalcli: false
1112
kubernetes: false

docs/generator/reference/docker_mcp_catalog_init.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
command: docker mcp catalog init
2-
short: Initialize the catalog
3-
long: Initialize the catalog
2+
short: Initialize the catalog system
3+
long: |
4+
Initialize the local catalog management system by creating the necessary configuration files and directories.
45
usage: docker mcp catalog init
56
pname: docker mcp catalog
67
plink: docker_mcp_catalog.yaml
8+
examples: |4-
9+
# Initialize catalog system
10+
docker mcp catalog init
711
deprecated: false
812
hidden: false
913
experimental: false

docs/generator/reference/docker_mcp_catalog_ls.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
command: docker mcp catalog ls
2-
short: List configured catalogs
3-
long: List configured catalogs
2+
short: List all configured catalogs
3+
long: |
4+
List all configured catalogs including Docker's official catalog and any locally managed catalogs.
45
usage: docker mcp catalog ls
56
pname: docker mcp catalog
67
plink: docker_mcp_catalog.yaml
@@ -15,6 +16,7 @@ options:
1516
experimentalcli: false
1617
kubernetes: false
1718
swarm: false
19+
examples: " # List all catalogs\n docker mcp catalog ls\n \n # List catalogs in JSON format\n docker mcp catalog ls --json"
1820
deprecated: false
1921
hidden: false
2022
experimental: false

0 commit comments

Comments
 (0)