a set of guidelines to build with Botpress's Agent Development Kit (ADK) - use these whenever you're tasked with building a feature using the ADK
Detected risks:
Guidelines for building on Botpress's Agent Development Kit (ADK), a convention-based TypeScript framework in which file structure maps directly to bot behavior — placing a file in the right directory automatically registers it as a capability. The ADK exposes primitives for Actions and Tools (reusable functions and AI-callable tools), Workflows (long-running, resumable processes), Conversations (message handling), Tables and Files (storage with semantic search), Knowledge Bases (RAG), Triggers, Assets, Integrations, Plugins, and Zai, a production-ready LLM utility library.
The documented project layout puts most primitives under src/ (actions/, tools/, workflows/, conversations/, tables/, triggers/, knowledge/, utils/), with static assets in assets/ at the project root and generated dependency snapshots under .adk/dependencies/; files outside src/ are not discovered, so location equals behavior. It emphasizes a session-start health check — running adk check --format json and adk status --format json, plus tsc --noEmit to catch type errors — and surfacing any errors or warnings before continuing with the user's question.
For integration discovery and project queries it favors direct CLI commands (adk integrations search/info/list and adk --version) over documentation lookups, and lists automation-friendly, non-interactive flags such as adk login --token, adk init --yes --skip-link, adk dev --non-interactive, adk deploy --yes, and adk project upgrade. It also references a set of /adk-* slash commands for scaffolding, building, testing, evaluating, shipping, documenting, and explaining a bot, and notes how to install the Botpress ADK plugin when those commands are not available. Use it whenever building ADK features involving any of these primitives.
A convention-based TypeScript framework where the file structure under src/ maps directly to bot behavior — placing files in the correct directories automatically registers them as capabilities.
Actions and Tools, Workflows, Conversations, Tables, Files, Knowledge Bases, Triggers, Assets, Integrations, Plugins, and Zai, a production-ready LLM utility library.
Most primitives go under the src/ directory (actions/, tools/, workflows/, and so on); static assets go in assets/ at the project root. Files outside src/ are not discovered.
Use the CLI directly: adk integrations search <query>, adk integrations info <name> for actions/channels/events, and adk integrations list when inside an ADK project.
Silently run adk check --format json and adk status --format json (plus tsc --noEmit), and proactively mention any errors or warnings before answering. This is done only once per session.
Quick Setup:
.claude/skills/Repository
botpress/skills