Skip to content

gordon: update GUI docs #22884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added content/manuals/ai/gordon/images/gordon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed content/manuals/ai/gordon/images/gordon.webp
Binary file not shown.
Binary file added content/manuals/ai/gordon/images/toolbox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed content/manuals/ai/gordon/images/toolbox.webp
Binary file not shown.
37 changes: 16 additions & 21 deletions content/manuals/ai/gordon/mcp/built-in-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@

1. On the **Ask Gordon** view in Docker Desktop, select the `Toolbox` button in the bottom left of the input area.

![Gordon page with the toolbox button](../images/gordon.webp)
![Gordon page with the toolbox button](../images/gordon.png)

2. Choose the tools you want to make available. Selecting a card lets you view extra information regarding each tool and what it does.
2. To enable or disable a tool, select it in the left-menu and select the toggle.

![Gordon's Toolbox](../images/toolbox.webp)
![Gordon's Toolbox](../images/toolbox.png)

For more information on the possible tools, see [Reference](#reference).
For more information on the available Docker tools, see [Reference](#reference).

## Usage examples

Expand Down Expand Up @@ -108,7 +108,7 @@


```console
# Scan for CVEs
# Scan for CVEs
$ docker ai "Scan my application for security vulnerabilities"

# Get security recommendations
Expand Down Expand Up @@ -136,13 +136,11 @@

#### Container management

| Name | Description |
|------|-------------|
| `list_containers` | List all Docker containers |
| `remove_containers` | Remove one or more Docker containers |
| `stop_container` | Stop a running Docker container |
| `fetch_container_logs` | Retrieve logs from a Docker container |
| `run_container` | Run a new Docker container |
| Name | Description |
|---------------|----------------------------------------|
| `docker` | Access to the Docker CLI |
| `list_builds` | List the builds in the Docker daemon |
| `build_logs` | Show the build logs. |

#### Volume management

Expand Down Expand Up @@ -224,15 +222,12 @@

| Tool | Description |
|------|-------------|
| `list_models` | List all available AI models |
| `pull_model` | Download an AI model |
| `list_models` | List all available Docker models |
| `pull_model` | Download an Docker model |
| `run_model` | Query a model with a prompt |
| `remove_model` | Remove an AI model |
| `remove_model` | Remove an Docker model |

### AI Tool Catalog
### Docker MCP Catalog

Check warning on line 230 in content/manuals/ai/gordon/mcp/built-in-tools.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.HeadingSentenceCase] Use sentence case for headings: 'Docker MCP Catalog'. Raw Output: {"message": "[Docker.HeadingSentenceCase] Use sentence case for headings: 'Docker MCP Catalog'.", "location": {"path": "content/manuals/ai/gordon/mcp/built-in-tools.md", "range": {"start": {"line": 230, "column": 5}}}, "severity": "WARNING"}

When the [AI Tool
Catalog](https://open.docker.com/extensions/marketplace?extensionId=docker/labs-ai-tools-for-devs)
Docker Desktop extension is installed, all the tools enabled in the catalog are
available for Gordon to use. After installation, you can enable the usage of the
AI Tool Catalog tools in the toolbox section of Gordon.
If you have enabled the [MCP Toolkit feature](../../mcp-catalog-and-toolkit/_index.md),
all the tools you have enabled and configured are available for Gordon to use.
39 changes: 0 additions & 39 deletions content/manuals/ai/gordon/mcp/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,42 +132,3 @@ you can get started:
With MCP support, Gordon offers powerful extensibility and flexibility to meet
your specific use cases whether you’re adding temporal awareness, file
management, or internet access.

### Compatible MCP servers

These are MCP servers that have been tested with Gordon and are known to be
working:

- `mcp/time`
- `mcp/fetch`
- `mcp/filesystem`
- `mcp/postgres`
- `mcp/git`
- `mcp/sqlite`
- `mcp/github`

### Untested (should work with appropriate API tokens)

These are MCP servers that were not tested but should work if given the
appropriate API tokens:

- `mcp/brave-search`
- `mcp/gdrive`
- `mcp/slack`
- `mcp/google-maps`
- `mcp/gitlab`
- `mcp/everything`
- `mcp/aws-kb-retrieval-server`
- `mcp/sentry`

### Unsupported

These are MCP servers that are currently known to be unsupported:

- `mcp/sequentialthinking` - (The tool description is too long)
- `mcp/puppeteer` - Puppeteer sends back images and Gordon doesn’t know how to
handle them, it only handles text responses from tools
- `mcp/everart` - Everart sends back images and Gordon doesn’t know how to
handle them, it only handles text responses from tools
- `mcp/memory` - There is no way to configure the server to use a custom path
for its knowledge base