adk-integrations

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

ADK Integration Management

ADK集成管理

Use this skill when helping users discover, add, configure, and use Botpress integrations in their ADK projects.

当帮助用户在ADK项目中发现、添加、配置和使用Botpress集成时，使用此技能。

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
```
, or
```
adk list
```

Ask about

agent.config.ts

dependencies or the

dependencies.integrations

block

Need help configuring an integration (OAuth, API keys, Control Panel)
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

当用户出现以下情况时激活此技能：

询问集成相关问题（如“如何添加Slack？”、“有哪些可用的集成？”）
想要连接外部服务（Slack、WhatsApp、Linear等）
提及
```
adk add
```
、
```
adk search
```
、
```
adk info
```
或
```
adk list
```
命令

询问

agent.config.ts

依赖项或

dependencies.integrations

配置块相关问题

需要帮助配置集成（OAuth、API密钥、控制面板）
询问如何在代码中调用集成操作（如
```
actions.slack.*
```
等）
提及希望其Agent与之交互的特定平台或服务
遇到与集成注册或配置相关的错误

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

文件	描述
references/discovery.md	查找集成：带所有参数的 `adk search` 、 `adk list` 、 `adk info` 命令
references/lifecycle.md	端到端流程：发现、添加、配置、在代码中使用集成
references/configuration.md	配置类型：无需配置、可选配置、OAuth、API密钥、沙箱模式
references/common-integrations.md	聊天、网页聊天、浏览器、Slack、WhatsApp、Linear、Webhook等常用集成速查

How to Answer

回答方式

Start with CLI commands — Use
```
adk search
```
,
```
adk info
```
,
```
adk list
```
to 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 just
```
adk add <name>
```
.
Explain configuration requirements — After adding, tell the user what configuration is needed (OAuth link, API key, etc.) based on
```
adk info --format json
```
output.
Point to Control Panel — OAuth flows and credential entry happen in the Botpress Control Panel, not in code.

从CLI命令入手 — 在给出建议前，先使用
```
adk search
```
、
```
adk info
```
、
```
adk list
```
获取实时数据，通过Bash工具运行这些命令。
运行
adk add
前确认 — 在向用户项目添加集成前，务必先征得用户同意。
始终指定版本 — 使用
```
adk add <name>@<version>
```
而非仅
```
adk add <name>
```
。
说明配置要求 — 添加完成后，根据
```
adk info --format json
```
的输出，告知用户所需的配置信息（如OAuth链接、API密钥等）。
引导至控制面板 — OAuth流程和凭证录入需在Botpress控制面板中完成，而非代码中。

CLI Quick Reference

CLI速查

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 integrations	`--format json` , `--limit <number>` (default: 50)
`adk info <name>`	Full integration details	`--actions` , `--channels` , `--events` , `--full` , `--format json`
`adk add <name>@<version>`	Add integration to project	`--alias <name>`

Use

--format json

for CLI inspection.

命令	描述	关键参数
`adk search <query>`	按关键词搜索集成	`--format json` , `--limit <number>` （默认值：20）
`adk list --available`	浏览所有Hub集成	`--format json` , `--limit <number>` （默认值：50）
`adk list`	显示已安装的集成	`--format json` , `--limit <number>` （默认值：50）
`adk info <name>`	查看集成完整详情	`--actions` , `--channels` , `--events` , `--full` , `--format json`
`adk add <name>@<version>`	向项目添加集成	`--alias <name>`

使用

--format json

参数便于CLI检查。

Critical Patterns

核心规范

Always Use the CLI

始终使用CLI

bash

undefined

bash

undefined

CORRECT - Use adk add

正确做法 - 使用adk add命令

adk add slack@3.0.0

WRONG - Never manually edit agent.config.ts dependencies

错误做法 - 切勿手动编辑agent.config.ts依赖项

Don't hand-write entries in the dependencies.integrations block

不要手动编写dependencies.integrations块中的内容

undefined

undefined

Version Pinning

版本锁定

bash

undefined

bash

undefined

CORRECT - Pin to specific version

正确做法 - 锁定到特定版本

adk add browser@0.8.6

RISKY - Resolves to latest, may change unexpectedly

不推荐做法 - 会解析为最新版本，可能出现意外变更

adk add browser

undefined

adk add browser

undefined

Accessing Integration Actions

调用集成操作

typescript

// 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: 'browser@0.8.6', enabled: true } }
await actions.browser.webSearch({ query: 'search term' })

typescript

// 正确做法 - 从@botpress/runtime导入，使用agent.config.ts中的别名
import { actions } from '@botpress/runtime'
await actions.slack.sendMessage({ channel: '#general', text: 'Hello' })

// agent.config.ts中的别名决定了访问器名称
// { browser: { version: 'browser@0.8.6', enabled: true } }
await actions.browser.webSearch({ query: 'search term' })

Inspecting Config Requirements

检查配置要求

bash

undefined

bash

undefined

Use --format json to check what configuration an integration needs

使用--format json参数查看集成所需的配置

adk info slack --format json

Look at configuration.schema for required fields

查看configuration.schema获取必填字段

Look at configuration.identifier for OAuth

查看configuration.identifier获取OAuth相关信息

Look at configurations for alternative config modes

查看configurations获取可选配置模式

undefined

undefined

Examples of Questions This Skill Answers

此技能可解答的问题示例

Beginner

入门级

"What integrations are available?"
"How do I add Slack to my agent?"
"What is the browser integration?"

“有哪些可用的集成？”
“如何给我的Agent添加Slack？”
“浏览器集成是什么？”

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?"

“如何在沙箱模式下配置WhatsApp？”
“网页聊天集成提供哪些操作？”
“如何在工作流中调用Linear操作？”
“chat和webchat有什么区别？”

Advanced

高级

"How do I use a private workspace integration?"
"What does
```
registration_pending
```
status mean?"
"How do I alias an integration for cleaner code?"
"How do I inspect an integration's config schema programmatically?"

“如何使用私有工作区集成？”
“
```
registration_pending
```
状态是什么意思？”
“如何给集成设置别名以优化代码？”
“如何以编程方式检查集成的配置 schema？”