Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions adk/coding-with-ai/adk-copilot.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: ADK Copilot
sidebarTitle: ADK Copilot
---
4 changes: 4 additions & 0 deletions adk/coding-with-ai/skills-for-agents.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Skills for Agents
sidebarTitle: Skills for Agents
---
2 changes: 1 addition & 1 deletion adk/concepts/actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ export default new Conversation({

## Integration actions

When you [install an integration](/adk/managing-integrations), its actions become available anywhere in your agent's source:
When you [install an integration](/adk/integrations/adding-integration), its actions become available anywhere in your agent's source:

```ts highlight={1, 12-14}
import { Trigger, actions } from "@botpress/runtime";
Expand Down
4 changes: 4 additions & 0 deletions adk/control-panel.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Control Panel
sidebarTitle: Control Panel
---
4 changes: 4 additions & 0 deletions adk/guides/build-extend/adding-hitl.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Adding HITL (Human-In-The-Loop)
sidebarTitle: Adding HITL
---
4 changes: 4 additions & 0 deletions adk/guides/build-extend/authentication.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Adding authentication
sidebarTitle: Adding authentication
---
4 changes: 4 additions & 0 deletions adk/guides/build-extend/external-apis.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Connecting external APIs
sidebarTitle: Connecting external APIs
---
4 changes: 4 additions & 0 deletions adk/guides/build-extend/mcp-server.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Setting up an MCP server
sidebarTitle: Setting up an MCP server
---
4 changes: 4 additions & 0 deletions adk/guides/evaluate-improve/debugging-traces.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Debugging agents
sidebarTitle: Debugging agents
---
4 changes: 4 additions & 0 deletions adk/guides/evaluate-improve/running-evals.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Running evaluations
sidebarTitle: Running evaluations
---
4 changes: 4 additions & 0 deletions adk/guides/operate-scale/deploying.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Deploying your agent
sidebarTitle: Deploying your agent
---
4 changes: 4 additions & 0 deletions adk/guides/operate-scale/react-frontend.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Connect to React frontend
sidebarTitle: Connect to React frontend
---
109 changes: 109 additions & 0 deletions adk/integrations/adding-integration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
title: Adding an integration
sidebarTitle: Adding an integration
---

This guide walks you through installing and configuring a Botpress integration in an ADK agent.

<Info>
You will need:

- A [Botpress account](https://sso.botpress.cloud)
- A local [ADK](/adk/introduction) project
</Info>

## 1. Discover and pick an integration

Search the hub by keyword:

```bash
adk search <query>
```

List every integration available to install:

```bash
adk list --available
```

Inspect a single integration—actions, channels, events, and metadata:

```bash
adk info <integration-name>
```

<Tip>
For a full list of flags (for example JSON output or limits), see [`adk search`](/adk/cli-reference#adk-search), [`adk list`](/adk/cli-reference#adk-list), and [`adk info`](/adk/cli-reference#adk-info) in the CLI reference.
</Tip>

## 2. Add it to the project

Install a specific version:

```bash
adk add slack@2.5.5
```

**Optional alias** (changes how you reference the integration in code):

```bash
adk add linear@2.0.0 --alias my-linear
```

The CLI updates your project configuration and generated types. **As of ADK 1.9+,** integrations are declared under `dependencies.integrations` in **`agent.config.ts`** (not `dependencies.json`).

<Note>
After adding or changing integrations, run `adk dev` or `adk build` so TypeScript types stay in sync with what you installed.
</Note>

## 3. Configure credentials and settings

### Method 1: Control Panel (recommended for OAuth and guided setup)

1. Run `adk dev`.
2. Open the Control Panel (often [`http://localhost:3001`](http://localhost:3001)) and go to the Integration page and configure your account.

For more detail, see [Managing an integration](/adk/integrations/managing-integration).

### Method 2: `agent.config.ts`

Edit `version`, `enabled`, and any `config` / `configurationType` fields the integration expects. Sensitive values are often wired through **`process.env.*`** and your workspace or deployment environment.

## 4. Use it in code

Import the generated **`actions`** object and call the integration using its **key** in `dependencies.integrations` (or the key from **`--alias`**):

```typescript
import { actions } from "@botpress/runtime";

await actions.slack.sendMessage({ channel: "#general", text: "Hello!" });
```

**Pattern:** `await actions.<integrationKey>.<actionName>(params)`.

- **`<integrationKey>`**: The name under `dependencies.integrations` in `agent.config.ts` (for example `slack`, or `my-linear` if you used `--alias my-linear`).
- **`<actionName>`**: The action exposed by that integration (see `adk info` or your editor’s types).

**Optional: expose to the model as a tool**

Inside a conversation `execute` call, you can pass integration actions as tools:

```typescript
await execute({
instructions: "…",
tools: [actions.slack.sendMessage.asTool()],
});
```

Use the same `actions.<integrationKey>.<actionName>.asTool()` pattern as for [custom actions](/adk/concepts/actions#as-a-tool-in-a-conversation).

## Next steps

<CardGroup cols={2}>
<Card title="Actions" icon="zap" href="/adk/concepts/actions">
Call and compose actions from conversations, workflows, and triggers
</Card>
<Card title="CLI reference" icon="terminal" href="/adk/cli-reference">
`adk add`, `adk remove`, and related commands
</Card>
</CardGroup>
4 changes: 4 additions & 0 deletions adk/integrations/integrations-overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Integrations overview
sidebarTitle: Overview
---
4 changes: 4 additions & 0 deletions adk/integrations/managing-integration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Managing an integration
sidebarTitle: Managing an integration
---
4 changes: 4 additions & 0 deletions adk/integrations/removing-integration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Removing an integration
sidebarTitle: Removing an integration
---
163 changes: 0 additions & 163 deletions adk/managing-integrations.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion adk/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Type "exit" or press ESC key to quit

### View the ADK console

Visit [`http://localhost:3001/`](http://localhost:3001/) to access the interactive ADK console. This gives you an intuitive, visual breakdown of your agent project and lets you [configure its integration's settings](/adk/managing-integrations#integration-configuration).
Visit [`http://localhost:3001/`](http://localhost:3001/) to access the interactive ADK console. This gives you an intuitive, visual breakdown of your agent project and lets you [configure its integration's settings](/adk/integrations/managing-integration).

## Build your agent

Expand Down
Loading
Loading