使用 API Key 对接环境
为环境创建并下发 API Key 后，需要将 CloudBase 接入你的 AI Agent（AI 开发工具），让 Agent 能够直接操作云资源。根据 Agent 的运行形态，分为两种常见情况：
| 场景 | Agent 形态 | 典型产品 | 对接方式 |
|---|---|---|---|
| 对接客户端 Agent | 运行在用户本地 | WorkBuddy、Claude Code、Codex 等 | 用户获取 API Key 后配置 CloudBase MCP |
| 对接云端 Agent | 运行在平台云端 | Lovable、Bolt.new 等 | 平台服务配置 API Key 后调用 MCP 或 API |
客户端 Agent 对接
客户端 Agent 运行在用户自己的电脑上，例如 WorkBuddy、Claude Code、Codex 等。平台完成环境创建和 API Key 签发后，需要通过安全方式让用户将 CLOUDBASE_ENV_ID 与 CLOUDBASE_API_KEY 配置到 CloudBase MCP 中。
客户端 Agent 的接入方式主要有以下两种：
方式一：通过站内信、邮件等渠道下发配置
适合用户具备一定技术能力、可以自行编辑 Agent 配置的场景。
- 平台通过站内信、邮件等安全渠道，将用户专属的环境 ID 和 API Key 提供给用户。
- 用户在 Agent 工具中安装 CloudBase MCP。
- 用户按照 Agent 工具的 MCP 配置格式，填入以下环境变量：
{
"mcpServers": {
"cloudbase": {
"command": "npx",
"args": ["@cloudbase/cloudbase-mcp@latest"],
"env": {
"CLOUDBASE_API_KEY": "<平台下发的 API Key>",
"CLOUDBASE_ENV_ID": "<平台下发的环境 ID>"
}
}
}
}
- 用户重启或刷新 Agent，即可使用 CloudBase MCP 操作对应环境。
方式二：通过 MCP 授权页面完成配置
适合希望降低配置门槛、让用户在 Agent 工具中完成引导式接入的场景。
- 平台通过站内信、邮件等安全渠道，向用户发送 CloudBase MCP 的安装说明或入口。
- 用户在 Agent 工具中安装 CloudBase MCP。
- 用户打开 MCP 提供的授权页面，填入平台下发的环境 ID 和 API Key。
- 授权完成后，MCP 自动保存连接配置，用户无需手动编辑 MCP 配置文件即可操作对应环境。
具体授权页面和配置流程取决于 Agent 工具的实现。平台也可以将上述流程集成到自有产品中，提供统一的安装引导和凭证配置入口。
其他接入方式
除上述方式外，平台还可以根据 Agent 工具的能力提供一键安装、安装包预配置、企业软件分发或自有桌面端集成等接入方式。无论采用哪种方式，最终都应将用户专属的 CLOUDBASE_ENV_ID 与 CLOUDBASE_API_KEY 配置到 CloudBase MCP 中。
- WorkBuddy：已内置 CloudBase 连接器，可在对话界面通过连接器按钮一键启用，详见 WorkBuddy 配置指南。
- Claude Code、Codex 等：在对应 IDE 中安装 CloudBase MCP，并按工具支持的方式配置环境变量，具体配置方式见 连接 CloudBase MCP。
api_key 拥有该环境的完整管理员权限。API Key 仅用于用户本地 MCP 或平台服务端配置，不得写入业务前端、应用代码仓库或公开渠道。平台应通过安全渠道分发，并建议定期轮换，单环境最多创建 5 个。
云端 Agent 对接
云端 Agent 运行在平台的云端服务中，例如 Lovable、Bolt.new 这类「根据自然语言生成应用」的平台。这种场景下，平台自身负责创建环境、分配环境，云端 Agent 通过调用 CloudBase MCP（托管模式） 或 CloudBase API 完成云端资源的创建和管理。
推荐流程：
- 平台创建并分配环境：平台调用 CreateEnv 为用户创建专属环境，并维护用户 ID 与环境 ID 的映射关系，详见 创建环境。
- 获取环境 API Key：平台调用 CreateApiKey 为用户环境创建 API Key，并将 API Key 与环境 ID 安全地保存到平台服务端，详见 获取环境 API Key。
- 云端 Agent 接入 CloudBase：
- 资源创建与管理：云端 Agent 在用户环境内创建数据库、部署云函数、配置域名等，详见 管理环境的资源。
其他凭证方式
上述流程均使用 API Key 作为环境凭证，这也是平台集成场景下推荐的方式。如果您的场景需要用户通过自有域名完成一次性授权登录，或需要由平台服务端控制凭证生命周期，云开发还支持以下两种凭证方式：
- 自定义授权码：企业自建授权页面代理设备码流程，用户全程在自有域名下完成登录，无需感知腾讯云
- 临时密钥：通过 STS
GetFederationToken签发带策略限制的临时密钥，适合服务端控制凭证生命周期的场景
→ 详见 使用其他凭证方式对接环境
下一步
环境绑定到 Agent 后，即可开始管理环境内的资源：
→ 管理环境的资源