adk-document

A documentation assistant for Botpress ADK projects, covering project documentation and its underlying bot code.

In plain words
What is it for?
Use it to create, review, update, synchronize, or search documentation, using source files and existing guides to produce verifiable examples.
Why use it?
It removes the need to write generic documentation that does not match the project's actual workflows, tools, or actions.

Command

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/botpress/skills/adk-document
Clone the repo
git clone --depth 1 https://github.com/botpress/skills
Per session 21 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 846 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00021 $0.00846
Opus 5 $0.00010 $0.00423
Sonnet 5 $0.00004 $0.00169
Haiku 4.5 $0.00002 $0.00085

Measured 2d ago against content hash 099931067c9e, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

adk-document scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

commands/adk-document.md · 77 lines

How it starts

The opening of the file, as written. The whole thing — 77 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Load the adk-docs skill for documentation standards and the adk skill for ADK context, then help with documentation immediately.

Parse $ARGUMENTS to determine the action. The first word is usually the action (but not always); everything after is the target.

Route by Action

create [topic]

E.g., /adk-document create workflows, /adk-document create the checkout flow

If the topic is a broad term ("workflows", "tools", "actions"), read src/<relevant-dir>/ to enumerate the user's actual primitives first. Document their specific implementations — not generic concepts.

  1. Research: Find the user's ADK project (agent.config.ts), read relevant source files in src/, check existing docs in ./docs/ or ./guides/.
  2. Choose type: Reference (400-500 lines), Conceptual (500-700), Comprehensive (600-800) — see doc-standards reference.
  3. Write: Every concept needs a working code example from the user's actual code. Include file paths for verification. Use clear headers for ripgrep searchability. No speculative Common Mistakes or Best Practices sections.
  4. Save: Ask where if unclear (common: ./docs/, ./guides/). Verify headers are searchable.

review [doc-path]

E.g., /adk-document review docs/workflows.md

Review the doc for technical accuracy, searchability, and completeness:

  • Code accuracy: correct imports (@botpress/runtime), examples from actual code with file paths, no speculation
  • Searchability: clear section headers, TOC present, keyword-rich section names
  • ADK-specific: distinguishes ADK vs SDK primitives, messages vs events, channel-specific vs agnostic
  • Validation: Grep for imports, check referenced files exist, flag speculative content

Report: Critical Issues → Searchability Issues → Speculative Content → Missing Verification → Recommendations.

update [doc-path] [what-changed]

E.g., /adk-document update docs/workflows.md added new step type

  1. Read the existing doc.
  2. Find what changed in the user's project code.
  3. Preserve existing structure, style, and TOC.
  4. Verify all code examples still work. Add new features with project code examples.
  5. Mark deprecations clearly. Update file path references.

Read the full file on GitHub · 77 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 77 lines · 21 tokens per session scan A 099931067c9e

Subscribe to this mod's changes

adk-document is a command published in the GitHub repository botpress/skills (11 stars, last pushed 1mo ago), licensed MIT. It adds 21 tokens to every session and 846 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.