| summary |
read_when |
| List the MCP/agent tool catalog via peekaboo tools |
| deciding which automation tool to call from agents or scripts |
| debugging missing tool registrations |
|
peekaboo tools
peekaboo tools prints the MCP/agent tool catalog that peekaboo mcp exposes (Image, See, Click, Window, Browser, Inspect UI, etc.). These names are the tools available to agents and MCP clients. Some tools also have dedicated top-level CLI wrappers, including peekaboo browser and peekaboo inspect-ui; run peekaboo --help for the full CLI command list.
Key options
| Flag |
Description |
--no-sort |
Preserve registration order instead of alphabetizing every tool. |
--verbose |
Include each tool's description alongside its name. |
--json |
Emit {tools:[…], count:n} for machine parsing. |
Implementation notes
- The command and MCP server both use
MCPToolCatalog, so tool additions only need to be registered once.
- Allow/deny filtering happens before formatting (
ToolFiltering.apply), so the output matches MCP server behavior.
- Input-strategy availability filtering also runs before formatting, so action-only tools are hidden when the current policy cannot support them.
- The command runs locally by default because it only reports the static native catalog; use per-tool wrappers or an attached MCP client to execute tools.
- Because the command implements
RuntimeOptionsConfigurable, it respects global --json/--verbose flags even when invoked from other commands (e.g., peekaboo learn can embed the summaries verbatim).
Examples
# Produce a JSON blob for an agent integration test
peekaboo tools --json > /tmp/tools.json
Troubleshooting
- Verify Screen Recording + Accessibility permissions (
peekaboo permissions status).
- Confirm your target (app/window/selector) with
peekaboo list/peekaboo see before rerunning.
- Re-run with
--json or --verbose to surface detailed errors.
