Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
70 commits
Select commit Hold shift + click to select a range
7801ce1
docs(adk-v2): scaffold get-started section with install page
jacksonyzj Apr 20, 2026
413afc0
docs(adk-v2): add quickstart page
jacksonyzj Apr 20, 2026
631f34c
docs(adk): replace intro/quickstart/project-structure with new Get st…
jacksonyzj Apr 20, 2026
1542e11
docs(adk): simplify install page
jacksonyzj Apr 20, 2026
daae826
docs(adk): fix vale warnings on quickstart
jacksonyzj Apr 20, 2026
377071d
docs(adk): drop Botpress account prerequisite from install page
jacksonyzj Apr 20, 2026
0736692
docs(adk): expand quickstart with project tree and adk dev breakdown
jacksonyzj Apr 20, 2026
f5f5792
docs(adk): show step labels, package manager wizard, and workspace li…
jacksonyzj Apr 20, 2026
7d857b3
docs(adk): add control panel screenshots to quickstart
jacksonyzj Apr 20, 2026
1a97bbe
docs(adk): tighten quickstart to feel quick again
jacksonyzj Apr 20, 2026
c24250a
docs(adk): highlight hello-world in template wizard output
jacksonyzj Apr 20, 2026
83d6937
docs(adk): note that quickstart tree is an abbreviated view
jacksonyzj Apr 20, 2026
60f7f63
docs(adk): add welcome and coding assistant quickstart pages
jacksonyzj Apr 20, 2026
4141eb3
docs(adk): consolidate images into adk/assets
jacksonyzj Apr 20, 2026
cc6a4f5
docs(adk): restructure welcome around start here, what you can build,…
jacksonyzj Apr 20, 2026
aef3c25
docs(adk): add hero image to welcome page
jacksonyzj Apr 20, 2026
75241eb
docs(adk): swap build with ai card for whats new linking to changelog
jacksonyzj Apr 20, 2026
731b336
docs(adk): add quickstart next-step cards to install page
jacksonyzj Apr 20, 2026
f9a175d
docs(adk): drop check and next steps from quickstart
jacksonyzj Apr 20, 2026
8642a13
docs(adk): rewrite coding assistant quickstart around skills
jacksonyzj Apr 20, 2026
d9dcd1f
docs(adk): drop botpress cloud card from welcome resources
jacksonyzj Apr 20, 2026
8253df4
docs(adk): add debug and evals prompt examples to coding assistant qu…
jacksonyzj Apr 20, 2026
b07ed62
docs(adk): drop npm install path from install page
jacksonyzj Apr 20, 2026
0564b02
docs(adk): highlight instructions line and clarify edit hint
jacksonyzj Apr 20, 2026
7c090d6
docs(adk): lead coding assistant quickstart with build with AI framing
jacksonyzj Apr 20, 2026
68e3d52
docs(adk): match deploy section detail with main quickstart
jacksonyzj Apr 20, 2026
7a40c1e
docs(adk): restructure quickstarts with Steps and goal statement
jacksonyzj Apr 20, 2026
ca0f61e
docs(home): point adk card to welcome with get started cta
jacksonyzj Apr 20, 2026
62254a0
docs(adk): smooth out package manager and workspace linking prose
jacksonyzj Apr 20, 2026
85a3947
docs(adk): swap persistent state jargon for plain language
jacksonyzj Apr 20, 2026
ea5796d
docs(adk): rename control panel to dev console, split run step into b…
jacksonyzj Apr 20, 2026
b9e22ea
docs(adk): show more files in quickstart tree, drop hidden files apology
jacksonyzj Apr 20, 2026
df19da4
docs(adk): replace notion prompt with coin flip and group examples in…
jacksonyzj Apr 20, 2026
ad739b7
docs(adk): tighten coding assistant quickstart description and intro
jacksonyzj Apr 20, 2026
52a6927
docs(adk): replace coin flip with recipe prompt, frame accordions as …
jacksonyzj Apr 20, 2026
78a7195
docs(adk): lead coding assistant quickstart with goal and introduce s…
jacksonyzj Apr 20, 2026
b195c64
docs(adk): swap add a feature prompt to email collection into a table
jacksonyzj Apr 20, 2026
8984ded
docs(adk): drop timing estimate from coding assistant goal
jacksonyzj Apr 20, 2026
7a77a89
docs(adk): explain skills vs slash commands in coding assistant quick…
jacksonyzj Apr 20, 2026
c492029
docs(adk): add adk login as first step in quickstart
jacksonyzj Apr 20, 2026
d0a2b1b
docs(adk): show profile selection screen in adk login step
jacksonyzj Apr 20, 2026
8af0948
docs(adk): simplify adk login step to command plus one sentence
jacksonyzj Apr 20, 2026
ff15a68
docs(adk): drop timing claim from quickstart opener
jacksonyzj Apr 20, 2026
b84abe7
docs(adk): simplify welcome to hero plus quickstart and whats new
jacksonyzj Apr 21, 2026
82d6112
docs(adk): fold install into quickstart as step 1, drop install page
jacksonyzj Apr 21, 2026
fa24419
docs(adk): collapse welcome intro to a single tagline
jacksonyzj Apr 21, 2026
5599c2b
docs(adk): swap quickstart intro for casual hello-world framing
jacksonyzj Apr 21, 2026
b0e0918
docs(adk): tighten quickstart to 5 steps and drop project structure i…
jacksonyzj Apr 21, 2026
afd9e5a
docs(adk): switch install commands to accordion group by OS
jacksonyzj Apr 21, 2026
cdc8d92
chore: nudge mintlify preview
jacksonyzj Apr 21, 2026
edb6d56
Merge branch 'master' into adk-v2-get-started
jacksonyzj Apr 21, 2026
890161a
docs(adk): align next steps card with configuration page it links to
jacksonyzj Apr 21, 2026
d5b6376
docs(adk): use folder icon and plain description for project structur…
jacksonyzj Apr 21, 2026
015c829
docs(adk): reshape coding assistant quickstart into a drop-in 3-step …
jacksonyzj Apr 21, 2026
5faa875
docs(adk): generalize coding assistant refs and point next steps forward
jacksonyzj Apr 21, 2026
695ac1c
docs(adk): restructure sidebar and rewrite Get Started section
aj-botpress Apr 21, 2026
e6aae62
docs(adk): write Setting up your agent section
aj-botpress Apr 21, 2026
52cbdbc
docs(adk): write Handling conversations section
aj-botpress Apr 21, 2026
2ff12cf
docs(adk): write Handling longform logic section
aj-botpress Apr 21, 2026
af7a2c8
docs(adk): write Actions and triggers section
aj-botpress Apr 21, 2026
0a6a425
docs(adk): write Working with data section
aj-botpress Apr 21, 2026
cd5eff0
docs(adk): write Testing and debugging section
aj-botpress Apr 21, 2026
f41484d
docs(adk): write LLM Utilities section
aj-botpress Apr 21, 2026
917ede8
docs(adk): write AI Native Development section
aj-botpress Apr 21, 2026
cd191d5
docs(adk): write Advanced section, clean up orphaned files
aj-botpress Apr 21, 2026
4028f31
docs(adk): add note distinguishing HITL from Botpress Desk
aj-botpress Apr 21, 2026
1bcdb20
docs(adk): rewrite CLI reference from source
aj-botpress Apr 21, 2026
e1c16cc
docs(adk): expand ADK section by default in sidebar
aj-botpress Apr 21, 2026
74ef72d
docs(adk): fix stale cards on Welcome page
aj-botpress Apr 21, 2026
253a967
docs(adk): fix broken links and add placeholder images
aj-botpress Apr 21, 2026
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
157 changes: 157 additions & 0 deletions adk/advanced/hitl.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
---
title: Human-in-the-loop
description: Escalate conversations to live human agents.
---

<Info>
This covers the HITL integration and plugin, which connects your agent to external helpdesk platforms (Zendesk, Intercom, etc.). This is separate from integrating your ADK agent with [Botpress Desk](/desk/introduction).
</Info>

HITL (Human-in-the-Loop) lets your agent hand off a conversation to a live human agent. This is powered by two dependencies working together: the **HITL integration** (provides the transport to a helpdesk or agent platform) and the **HITL plugin** (provides the actions your code calls).
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'helpdesk'?


## Setup

Add both the integration and plugin to `agent.config.ts`:

```typescript
import { defineConfig } from "@botpress/runtime"

export default defineConfig({
name: "my-agent",

defaultModels: {
autonomous: "openai:gpt-4.1-mini-2025-04-14",
zai: "openai:gpt-4.1-mini-2025-04-14",
},

dependencies: {
integrations: {
chat: { version: "chat@0.7.3", enabled: true },
webchat: { version: "webchat@0.3.0", enabled: true },
hitl: { version: "hitl@2.0.2", enabled: true },
},

plugins: {
hitl: {
version: "hitl@1.3.0",
dependencies: {
hitl: {
integrationAlias: "hitl",
integrationInterfaceAlias: "hitl<hitlSession>",
},
},
},
},
},
})
```

### How the plugin wiring works

The `plugins` block connects the plugin to the integration:

```typescript
plugins: {
hitl: {
version: "hitl@1.3.0",
dependencies: {
hitl: {
integrationAlias: "hitl", // Must match a key in dependencies.integrations
integrationInterfaceAlias: "hitl<hitlSession>",
},
},
},
},
```

`integrationAlias` tells the plugin which installed integration to use. It must match a key in `dependencies.integrations`. The ADK validates this at build time.

### Optional plugin config

```typescript
plugins: {
hitl: {
version: "hitl@1.3.0",
config: {
flowOnHitlStopped: false,
useHumanAgentInfo: false,
},
dependencies: { /* ... */ },
},
},
```

## Starting a handoff

Import `plugins` from `@botpress/runtime` and call `startHitl`. All inputs are fully typed.

```typescript
import { Conversation, plugins } from "@botpress/runtime"

export default new Conversation({
channel: ["chat.channel", "webchat.channel"],
handler: async ({ execute, conversation, message }) => {
if (message.payload.text.toLowerCase() === "/starthitl") {
await plugins.hitl.actions.startHitl({
title: "Support HITL",
description: "Escalate to support agent",
conversationId: conversation.id,
userId: message.userId,
configurationOverrides: {
onHitlHandoffMessage: "Escalating to support...",
userHitlCloseCommand: "/end",
agentAssignedTimeoutSeconds: 100,
},
})
return
}

await execute({
instructions: "You are a helpful assistant. If the user asks for a human, tell them to type /starthitl.",
})
},
})
```

## Using a different provider

The HITL plugin works with any integration that implements the HITL interface. To use Zendesk instead of the generic HITL integration, swap the integration and update the alias:

```typescript
dependencies: {
integrations: {
zendesk: { version: "zendesk@1.0.0", enabled: true },
},
plugins: {
hitl: {
version: "hitl@1.3.0",
dependencies: {
hitl: {
integrationAlias: "zendesk",
integrationInterfaceAlias: "hitl<hitlTicket>",
},
},
},
},
},
```

The plugin doesn't care about the specific provider, only that it implements the HITL interface.

## Deploy and test

```bash
adk deploy
```

<Warning>
HITL does not work in dev mode because conversations don't exist on the dev bot. You must deploy and test on the production bot.
</Warning>

When you run `adk dev`, the ADK downloads the plugin, installs it into `bp_modules/`, and generates TypeScript types. But testing the actual handoff requires a deployed bot.

---

<Card title="CLI Reference" icon="terminal" href="/adk/cli-reference">
All commands and flags available with the ADK CLI.
</Card>
87 changes: 87 additions & 0 deletions adk/ai-native/skills.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: Skills
description: Give AI coding assistants deep ADK knowledge with installable skills.
---

Skills are packaged instructions and documentation that teach AI coding assistants how to build with the ADK. When installed, your assistant (Claude Code, Cursor, Codex) automatically uses them when you ask it to build features, debug issues, write evals, or connect integrations.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'evals'?


Skills are packaged with every new ADK project. When you run `adk init`, skills are installed automatically alongside your dependencies.

## Manual installation

If you need to install skills in an existing project or reinstall them:

```bash
npx skills add botpress/skills -s '*' -a claude-code codex -y
```

Install a single skill:

```bash
npx skills add botpress/skills --skill adk
```

Or install as a Claude Code plugin:

```
/plugin marketplace add botpress/skills
/plugin install adk@botpress-skills
```

## Available skills

| Skill | What it teaches | Use when |
|-------|----------------|----------|
| **adk** | Core ADK framework: actions, tools, workflows, conversations, tables, knowledge, triggers, Zai, configuration | Building any feature with the ADK |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'adk'?

| **adk-debugger** | Trace reading, log analysis, common failure diagnosis, the debug loop | Bot isn't responding, tools failing, workflows stuck, LLM issues |
| **adk-evals** | Eval file format, all assertion types, CLI usage, per-primitive testing patterns | Writing and running automated tests |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Eval'?

| **adk-frontend** | Authentication, type generation, client setup, calling bot actions from React/Next.js | Building a frontend that connects to your bot |
| **adk-integrations** | Discovery, adding, configuring, and using integrations end-to-end | Connecting Slack, WhatsApp, Linear, or any integration |
| **adk-docs** | Documentation standards, creation, review, and maintenance | Writing or updating docs for your bot |

## Slash commands

Skills come with slash commands for Claude Code. Type the command instead of describing what you need:

| Command | What it does |
|---------|-------------|
| `/adk-init` | Scaffold a new ADK project |
| `/adk-debug` | Debug bot issues using traces, logs, and the debug loop |
| `/adk-eval` | Write, run, or debug evals |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'evals'?

| `/adk-frontend` | Build frontend apps that integrate with ADK bots |
| `/adk-integration` | Discover, add, and configure integrations |
| `/adk-doc-create` | Create documentation for a feature |
| `/adk-doc-review` | Review project docs for accuracy |
| `/adk-doc-update` | Update docs after code changes |
| `/adk-doc-sync` | Check if docs are in sync with code |
| `/adk-doc-search` | Search project documentation |

## MCP server

The ADK also includes an MCP (Model Context Protocol) server that gives assistants live access to your running project. It provides tools for querying traces, searching integrations, sending test messages, and starting workflows.

Generate the MCP configuration:

```bash
adk mcp:init --all
```

This creates config files for Claude Code (`.mcp.json`), VS Code (`.vscode/mcp.json`), and Cursor (`.cursor/mcp.json`).

| Tool | What it does |
|------|-------------|
| `adk_get_agent_info` | Get project structure and primitives |
| `adk_search_integrations` | Search the Botpress Hub |
| `adk_get_integration` | Get detailed integration info |
| `adk_add_integration` | Add an integration to the project |
| `adk_send_message` | Send a test message to the running bot |
| `adk_query_traces` | Query trace spans for debugging |
| `adk_get_dev_logs` | Get dev server logs and errors |
| `adk_list_workflows` | List available workflows |
| `adk_start_workflow` | Start a workflow or get its input schema |

---

<Card title="Human-in-the-loop" icon="user" href="/adk/advanced/hitl">
Escalate conversations to live human agents.
</Card>
Binary file added adk/assets/actions-console-dark.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 added adk/assets/actions-console.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 added adk/assets/agent-steps-dark.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 added adk/assets/agent-steps.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 added adk/assets/config-variables-console-dark.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 added adk/assets/config-variables-console.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 adk/assets/control-panel-quickstart-dark.png
Binary file not shown.
Binary file removed adk/assets/control-panel-quickstart.png
Binary file not shown.
Binary file added adk/assets/conversations-chat-dark.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 added adk/assets/conversations-chat.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 added adk/assets/environment-selector-dark.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 added adk/assets/environment-selector.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 added adk/assets/evals-console-dark.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 added adk/assets/evals-console.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added adk/assets/integration-config-console.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 added adk/assets/integrations-console-dark.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 added adk/assets/integrations-console.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 added adk/assets/knowledge-console-dark.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 added adk/assets/knowledge-console.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 added adk/assets/logs-view-dark.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 added adk/assets/logs-view.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 added adk/assets/quickstart-dark.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 added adk/assets/quickstart.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 added adk/assets/secrets-console-dark.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 added adk/assets/secrets-console.png
Binary file added adk/assets/tables-console-dark.png
Binary file added adk/assets/tables-console.png
Binary file added adk/assets/traces-view-dark.png
Binary file added adk/assets/traces-view.png
Binary file added adk/assets/triggers-console-dark.png
Binary file added adk/assets/triggers-console.png
Binary file added adk/assets/welcome-dark.png
Binary file added adk/assets/welcome.png
Binary file added adk/assets/workflows-console-dark.png
Binary file added adk/assets/workflows-console.png
Loading
Loading