Documentation
¶
Overview ¶
Package builtin contains the stock tool implementations shipped with docker-agent. Each tool lives in its own sub-package:
- filesystem — file read/write/edit/search/list/tree
- shell — shell command execution
- backgroundjobs — long-running shell background jobs
- lsp — Language Server Protocol client tools
- think — structured thinking/scratchpad
- todo — task list management
- fetch — HTTP fetch with domain restrictions
- handoff — conversation handoff between agents
- transfertask — task delegation to sub-agents
- skills — skill runner
- tasks — persistent task management
- memory — persistent agent memory (sqlite)
- rag — retrieval-augmented generation (sqlite)
- modelpicker — runtime model switching
- userprompt — ask the user for input
- api — external API tool
- openapi — OpenAPI spec-driven tool
- openurl — open a fixed URL in the user's browser
- deferred — deferred toolset wrapper
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api provides HTTP API tools with JavaScript template expansion.
|
Package api provides HTTP API tools with JavaScript template expansion. |
|
client
Package client implements HTTP API tools with a caller-supplied template expander.
|
Package client implements HTTP API tools with a caller-supplied template expander. |
|
Package backgroundjobs exposes the built-in background_jobs toolset.
|
Package backgroundjobs exposes the built-in background_jobs toolset. |
|
Package environment exposes a single read-only tool the model can call to learn which OS and shell will run its shell-tool commands.
|
Package environment exposes a single read-only tool the model can call to learn which OS and shell will run its shell-tool commands. |
|
Package mcpcatalog exposes the Docker MCP Catalog's remote streamable-http servers as a single agent-side toolset that supports on-demand activation.
|
Package mcpcatalog exposes the Docker MCP Catalog's remote streamable-http servers as a single agent-side toolset that supports on-demand activation. |
|
Package openurl implements a built-in toolset that exposes a single tool which opens a fixed URL in the user's default browser.
|
Package openurl implements a built-in toolset that exposes a single tool which opens a fixed URL in the user's default browser. |
|
Package plan provides a toolset that lets two or more agents collaborate on plans addressed by name.
|
Package plan provides a toolset that lets two or more agents collaborate on plans addressed by name. |
|
Package sessioncontext provides read-only tools that let an agent discover previous sessions and pull one in as context for the current session, without the manual export/import (HTML export + @mention) workflow.
|
Package sessioncontext provides read-only tools that let an agent discover previous sessions and pull one in as context for the current session, without the manual export/import (HTML export + @mention) workflow. |
|
Package sessionplan provides a per-session plan tracker for the "draft, review, execute" workflow.
|
Package sessionplan provides a per-session plan tracker for the "draft, review, execute" workflow. |
|
Package structuredoutput implements the internal tool behind tool-mode structured output (structured_output.mode: tool).
|
Package structuredoutput implements the internal tool behind tool-mode structured output (structured_output.mode: tool). |
Click to show internal directories.
Click to hide internal directories.