跳到主要内容

Codex 配置指南

Codex 可以通过 插件市场 安装 CloudBase 插件,一次性获得 MCP 工具连接和 AI Skills;也可以通过 MCP 配置 手工连接。推荐使用插件市场方式。

例如:

  • “用云开发做一个微信小程序点餐系统” - AI 搭页面、建云数据库、写云函数并引导预览
  • “做一个预约管理系统,支持用户下单和后台改状态” - AI 用 CloudBase PostgreSQL 建模、配权限并接好前后端
  • “给 Web 应用加上手机号登录” - AI 启用认证方式并接入 CloudBase SDK

无需切换到云控制台,所有操作都可以在 Codex 中用自然语言完成。

前置条件​

在开始配置之前,请确保满足以下条件:

已准备好 Node.js 环境和云开发环境

Node.js 环境: 确保已安装 Node.js v18.15.0 或更高版本:

node --version

如果未安装,请从 Node.js 官网 下载安装。

云开发环境: 请参考文档 开通云开发环境。国内站新用户可以免费开通体验。

已安装 Git(插件市场方式需要)

Codex 添加插件市场时会执行 git clone 拉取市场仓库,机器上找不到 git 会直接报 program not found:

git --version

Windows 用户请安装 Git for Windows。安装后请完全退出并重新打开 Codex,新进程才会读到更新后的 PATH。

只用 MCP 配置方式(方式二)不需要 Git。

方式一:通过插件市场安装(推荐)​

插件市场方式会同时安装 MCP 工具和 AI Skills,一次安装即可获得完整能力。

通过 Codex App 的图形界面添加 CloudBase 插件市场并安装插件。

1
打开插件目录

在 Codex App 中点击右上角的 + 按钮。

2
添加插件市场

在菜单中选择 添加插件市场。

3
填写市场信息

在弹窗中填写以下信息:

来源:TencentCloudBase/CloudBase-MCP
Git 引用:main
稀疏路径:留空
4
点击添加市场

添加成功后,在插件列表中找到 Tencent CloudBase 市场。

5
安装 CloudBase 插件

点击 cloudbase 插件旁的安装按钮。

6
新开线程验证

安装后建议新开一个 Codex 线程,让插件、技能和 MCP 工具完整加载。

插件更新到新版本后,需要移除再重新安装一次才会生效——刷新市场不会替换已经装好的那一份。

方式二:通过 MCP 配置连接​

如果只需 MCP 工具连接,也可以手工配置:

Client
连接方式
站点

远端模式只需填地址,客户端会在浏览器里引导你完成登录授权,密钥不落到配置文件。

配置你的 AI 工具以连接 CloudBase 能力 支持本地与远端两种连接方式,详见 连接方式。

步骤 1:安装 / 配置 CloudBase

前置步骤: 请先全局安装 CloudBase MCP 工具:

bash
npm i @cloudbase/cloudbase-mcp -g

根据运行系统在终端中运行指令:

MacOS, Linux, WSL:

bash
codex mcp add cloudbase --env INTEGRATION_IDE=CodeX -- cloudbase-mcp

Windows Powershell:

bash
codex mcp add cloudbase --env INTEGRATION_IDE=CodeX -- cmd /c cloudbase-mcp

步骤 2:和 AI 对话

在 AI 对话中依次输入以下内容:

prompt
阅读 https://docs.cloudbase.net/skill.md,帮我介绍可以做什么
使用 CloudBase Skills: 帮我排查 CloudBase PG 应用的数据库连接和权限配置问题

常见问题​

Q: 添加插件市场时报 failed to run git clone ... program not found? A: Codex 用 git clone 拉取市场仓库,这台机器上没有可用的 git。安装 Git for Windows 后完全退出并重新打开 Codex;再确认「稀疏路径」留空。

Q: MCP 连接失败? A: 检查命令是否正确执行,重启 Codex,确认网络连接正常。

Q: 工具数量显示为 0? A: 请参考常见问题。

Q: 插件更新到新版本后,工具连接或 AI Skills 没变化? A: Codex 按版本号记录插件的安装位置,刷新市场快照不会替换已经装好的那一份。更新后需要卸载再重装一次:

codex plugin remove cloudbase@tencent-cloudbase
codex plugin marketplace upgrade tencent-cloudbase
codex plugin add cloudbase@tencent-cloudbase

使用 Codex App 的话,在插件面板里移除 cloudbase 后重新安装即可。装完新开一个线程,让插件和工具重新加载。

更多问题请查看:完整 FAQ

相关资源