About adk-integrations
A skill for managing integrations in Botpress ADK projects, aimed at developers building agents that connect to external services. It covers discovery, version-pinned installation, configuration, and calling integration actions in code.
Key features
- 01Search, list, and inspect integrations
- 02Add integrations with pinned versions
- 03Review OAuth, API key, and other configuration
- 04Call integration actions in code
Use cases
- 01Find a Slack integration for an agent
- 02Configure WhatsApp or OAuth credentials
- 03Call Linear actions in a workflow
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ botpress/ skills --skill adk-integrationsAfter installing, type/adk-integrationsin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
references/common-integrations.mdconfiguration.mddiscovery.mdlifecycle.mdDetails
From the project READMEADK Integration Management
Use this skill when helping users discover, add, configure, and use Botpress integrations in their ADK projects.
When to Use This Skill
Activate this skill when users:
- Ask about integrations ("How do I add Slack?", "What integrations are available?")
- Want to connect an external service (Slack, WhatsApp, Linear, etc.)
- Mention
adk add,adk search,adk info, oradk list - Ask about
agent.config.tsdependencies or thedependencies.integrationsblock - Need help configuring an integration (OAuth, API keys, Dev Console)
- Ask about calling integration actions in code (
actions.slack.*, etc.) - Mention specific platforms or services they want their agent to interact with
- Get errors related to integration registration or configuration
Available Documentation
| File | Description |
|---|---|
| references/discovery.md | Finding integrations: adk search, adk list, adk info with all flags |
| references/lifecycle.md | End-to-end walkthrough: discover, add, configure, use in code |
| references/configuration.md | Configuration types: no-config, optional, OAuth, API key, sandbox |
| references/common-integrations.md | Quick reference for chat, webchat, browser, slack, whatsapp, linear, webhook |
How to Answer
- Start with CLI commands — Use
adk search,adk info,adk listto get live data before suggesting anything. Run these via the Bash tool. - Confirm before running
adk add— Always ask the user before adding an integration to their project. - Always specify version — Use
adk add <name>@<version>rather than justadk add <name>. - Explain configuration requirements — After adding, tell the user what configuration is needed (OAuth link, API key, etc.) based on
adk info --format jsonoutput. - Point to Dev Console — OAuth flows and credential entry happen in the Botpress Dev Console, not in code.
CLI Quick Reference
| Command | Description | Key Flags |
|---|---|---|
adk search <query> | Search integrations by keyword | --format json, --limit <number> (default: 20) |
adk list --available | Browse all Hub integrations | --format json, --limit <number> (default: 50) |
adk list | Show installed dependencies | --format json, --limit <number> (default: 50) |
adk info <name> | Full integration details (integrations only, not plugins) | --actions, --channels, --events, --full, --format json |
adk add <name>@<version> | Add integration to project | --alias <name>, --format json |
adk add plugin:<name>@<version> | Add plugin to project | --alias <name>, --format json |
adk remove <name> | Remove integration, plugin, or interface | --format json |
adk upgrade [name] | Upgrade dependency (or all interactively) | --format json |
Use --format json for CLI inspection.
Critical Patterns
Always Use the CLI
# CORRECT - Use adk add
adk add [email protected]
adk add plugin:[email protected]
adk add interface:[email protected]
# WRONG - Never manually edit agent.config.ts dependencies
# Don't hand-write entries in the dependencies block
Version Pinning
# CORRECT - Pin to specific version
adk add [email protected]
# RISKY - Resolves to latest, may change unexpectedly
adk add browser
Accessing Integration Actions
// CORRECT - Import from @botpress/runtime, use alias from agent.config.ts
import { actions } from '@botpress/runtime'
await actions.slack.sendMessage({ channel: '#general', text: 'Hello' })
// The alias in agent.config.ts determines the accessor name
// { browser: { version: '[email protected]', enabled: true } }
await actions.browser.webSearch({ query: 'search term' })
Inspecting Config Requirements
# Use --format json to check what configuration an integration needs
adk info slack --format json
# Look at configuration.schema for required fields
# Look at configuration.identifier for OAuth
# Look at configurations for alternative config modes
Examples of Questions This Skill Answers
Beginner
- "What integrations are available?"
- "How do I add Slack to my agent?"
- "What is the browser integration?"
Intermediate
- "How do I configure WhatsApp in sandbox mode?"
- "What actions does the webchat integration provide?"
- "How do I call a Linear action from my workflow?"
- "What's the difference between chat and webchat?"
Advanced
- "How do I use a private workspace integration?"
- "What does
registration_pendingstatus mean?" - "How do I alias an integration for cleaner code?"
- "How do I inspect an integration's config schema programmatically?"
Comments
Markdown supported