Skip to main content

Codex Configuration Guide

Codex can install the CloudBase plugin through the plugin marketplace to get both MCP tool connectivity and AI Skills in one go, or connect manually via MCP configuration. The plugin marketplace approach is recommended.

For example:

  • "Build a WeChat Mini Program ordering system with CloudBase" — AI scaffolds pages, creates the cloud database, writes cloud functions, and guides preview
  • "Build a reservation management system that lets users place orders and admins update status" — AI models it with CloudBase PostgreSQL, configures permissions, and wires up frontend and backend
  • "Add phone-number login to a Web app" — AI enables the auth method and integrates the CloudBase SDK

No need to switch to the cloud console — all operations can be done in Codex using natural language.

Prerequisites​

Before configuring, ensure the following conditions are met:

Node.js environment and CloudBase environment ready

Node.js Environment: Make sure Node.js v18.15.0 or later is installed:

node --version

If not installed, download from the Node.js website.

CloudBase Environment: See the guide Create a CloudBase Environment. New users on the domestic site can try it for free.

Git installed (required for the plugin marketplace)

Codex runs git clone to fetch the marketplace repository, so a machine without git fails with program not found:

git --version

On Windows, install Git for Windows. After installing, quit Codex completely and reopen it so the new process picks up the updated PATH.

The MCP configuration approach (Method 2) does not require Git.

The plugin marketplace installs both MCP tools and AI Skills simultaneously — one installation provides full capabilities.

Add the CloudBase plugin marketplace and install the plugin via the Codex App graphical interface.

1
Open Plugin Directory

Click the + button in the top-right corner of Codex App.

2
Add Plugin Marketplace

Select Add Plugin Marketplace from the menu.

3
Fill in Marketplace Info

Enter the following information in the dialog:

Source:TencentCloudBase/CloudBase-MCP
Git Ref:main
Sparse Path:Leave empty
4
Click Add Marketplace

Once added, find the Tencent CloudBase marketplace in the plugin list.

5
Install CloudBase Plugin

Click the install button next to the cloudbase plugin.

6
Start a New Thread to Verify

After installation, start a new Codex thread to let the plugin, skills, and MCP tools fully load.

After the plugin updates to a new version, remove and reinstall it once — refreshing the marketplace does not replace the copy that is already installed.

Method 2: Connect via MCP Configuration​

If you only need MCP tool connectivity, you can also configure manually:

Client
Connection
Site

Remote needs only a URL — your client walks you through browser authorization, so no keys land in config files.

Configure your AI tool to connect with CloudBase capabilities. Supports local and remote connection. See connection modes.

Step 1: Install / Configure CloudBase

Prerequisite: install the CloudBase MCP tool globally first:

bash
npm i @cloudbase/cloudbase-mcp -g

Then run the command for your platform:

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
Need help?View Codex CLI docs

Step 2: Chat with AI

Enter the following in your AI chat in order:

prompt
Read https://docs.cloudbase.net/skill.md and tell me what it can do
Use CloudBase Skills: 在 CloudBase 关系型数据库中帮我创建一个用户表并设置权限

FAQ​

Q: Adding the plugin marketplace fails with failed to run git clone ... program not found? A: Codex uses git clone to fetch the marketplace repository, and no usable git was found on this machine. Install Git for Windows, quit and reopen Codex, and make sure Sparse path is left empty.

Q: MCP connection failed? A: Check if the command executed correctly, restart Codex, and verify your network connection.

Q: Showing 0 tools? A: See the FAQ.

Q: Nothing changed after the plugin updated to a new version? A: Codex records each plugin install against a version, so refreshing the marketplace snapshot does not replace the copy that is already installed. Uninstall and reinstall once after updating:

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

In the Codex App, remove cloudbase from the plugin panel and install it again. Start a new thread afterwards so the plugin and its tools reload.

More questions: Full FAQ

相关资源