Skip to main content

CloudBase AI Plugin

One-click integration of CloudBase capabilities into your AI coding assistant.


CloudBase Plugin for AI Coding Agents is a one-click installation package that gives your AI coding assistant full access to the CloudBase platform. It bundles CloudBase MCP Server and Agent Skills together — after installation, the AI can directly query databases, manage cloud functions, deploy static hosting, and operate cloud storage without manual configuration.

Fastest start: Copy the AI Prompt below into your AI IDE.

Help me get set up with CloudBase. Do the following:
1. Open https://docs.cloudbase.net/skill.md and follow the instructions.
2. When done, tell me you're ready and suggest the most relevant next steps.

Why Use a Plugin?

A plugin for AI coding assistants is a packaged collection of AI extensions. A single plugin can bundle:

  • MCP Services — External tool integrations that let AI interact with the CloudBase platform
  • Skills — On-demand professional knowledge and context for more accurate AI work
  • Hooks — Event handlers that auto-run at specific points in the AI lifecycle
  • Agents — Specialized sub-agents with specific roles and tool configurations
  • Slash Commands — Custom commands invocable directly within conversations

Packaging MCP Server and Agent Skills into a single plugin means one installation gives you both tool connectivity and domain expertise. You can also install them separately. Plugins can be installed globally (cross-project) or per-project (isolated).

Installation Guide

Preferred: one-click via plugins CLI

Install with the Open Plugin Spec plugins CLI (auto-detects local AI tools). Prefer this path; do not hand-write MCP JSON.

Default --scope user (global):

npx plugins add TencentCloudBase/cloudbase-plugin -y --scope user

# Optional: Sites plugin
npx plugins add TencentCloudBase/cloudbase-sites-plugin -y --scope user

Supported AI IDEs (npx plugins targets)

--target IDAI IDENotes
claude-codeClaude Code~/.claude
cursorCursor~/.cursor
codexCodex~/.codex
grokGrok Build~/.grok (per-user only)
kimiKimi Code~/.kimi-code (per-user only)
github-copilotGitHub Copilot CLI~/.copilot (standalone copilot CLI, not gh copilot)
vscodeVisual Studio CodeAgent plugins (Preview, per-user only)

Omit --target to install into all detected targets above. Inspect detection:

npx plugins targets

Install for one tool only:

npx plugins add TencentCloudBase/cloudbase-plugin -y --scope user --target cursor

Restart / reload the target tool after install.

Agent entry (decision tree + verify): https://docs.cloudbase.net/skill.md

If you already installed via marketplace / native plugin for the same IDE, do not also run npx plugins add (duplicate instances).

When GitHub is unreachable (CNB mirror)

Short owner/repo forms always resolve to GitHub. If git clone fails, use the full CNB URL (OPS artifacts synced by CI; no marketplace metadata):

npx plugins add https://cnb.cool/tencent/cloud/cloudbase/cloudbase-plugin.git -y --scope user

# Optional Sites plugin
npx plugins add https://cnb.cool/tencent/cloud/cloudbase/cloudbase-sites-plugin.git -y --scope user

Do not use the monorepo mirror CloudBase-AI-ToolKit with npx plugins add — its marketplace layout is not the same as the dedicated OPS plugin repos.

If the plugin still cannot install, fall back to Skills on CNB or npm MCP — see https://docs.cloudbase.net/skill.md.

Codex marketplace (fallback)

Codex supports installing plugins from the marketplace. You can use the Codex App GUI or the command line.

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

1
打开插件目录

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

2
添加插件市场

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

3
填写市场信息

在弹窗中填写以下信息:

来源:TencentCloudBase/CloudBase-MCP
Git 引用:main
稀疏路径:填两行(不要留空,否则会全量 clone,体积大且易失败):
.agents/plugins
plugin
4
点击添加市场

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

5
安装 CloudBase 插件

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

6
新开线程验证

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

Claude Code

Claude Code also supports marketplace plugin installation. After installation, MCP connections and Skills are automatically available:

# Add the CloudBase plugin marketplace
claude plugin marketplace add TencentCloudBase/cloudbase-mcp

# Install the CloudBase plugin
claude plugin install cloudbase@tencent-cloudbase

After installation, run /reload-plugins in Claude Code to activate the plugin. Default --scope user makes it globally available; use --scope project to share within a team.

Other IDEs

For IDEs that don't directly support a marketplace, you can configure MCP connections and use Skills. Select your tool below for detailed steps:

Client

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

Step 1: Install / Configure CloudBase

Use project template (recommended) - Template includes MCP configuration and AI rulesView templates

Install in one click:

Add to Cursor

Or manual configuration:

Or add this configuration to .cursor/mcp.json:

json
1{
2 "mcpServers": {
3 "cloudbase": {
4 "command": "npx",
5 "args": ["@cloudbase/cloudbase-mcp@latest"],
6 "env": {
7 "INTEGRATION_IDE": "Cursor"
8 }
9 }
10 }
11}

Step 2: Chat with AI

Enter the following in your AI chat in order:

prompt
Install CloudBase Skills: run npx skills add tencentcloudbase/cloudbase-skills -y
Use CloudBase Skills: 在 CloudBase 中启用邮箱验证码登录

What's Included

CapabilityDescription
MCP ServerEnvironment, database, cloud functions, hosting, storage, CloudBase Run, authentication, permissions, logs, etc. See MCP Tools
Agent SkillsPlatform, Web / Mini Program, cloud functions, authentication, database, AI models, UI and other expertise. See How to Use Skills