https://github.com/tencentcloudbase/cloudbase-ai-toolkit
๐ช ็จ AI IDE ไธ้ฎ็ๆใ้จ็ฝฒๅๆ็ฎกไฝ ็ๅ
จๆ Web ๅบ็จไธๅฐ็จๅบใๆฐๆฎๅบๅๅ็ซฏๆๅก๏ผๆ ้่ฟ็ปด๏ผๆ้ไธ็บฟไฝ ็ๅๆ ๐ซ CloudBase AI ToolKit
https://github.com/tencentcloudbase/cloudbase-ai-toolkit
ai cloudbase cursor mcp miniprogram prompt serverless tencent web
Last synced: 4 months ago
JSON representation
๐ช ็จ AI IDE ไธ้ฎ็ๆใ้จ็ฝฒๅๆ็ฎกไฝ ็ๅ จๆ Web ๅบ็จไธๅฐ็จๅบใๆฐๆฎๅบๅๅ็ซฏๆๅก๏ผๆ ้่ฟ็ปด๏ผๆ้ไธ็บฟไฝ ็ๅๆ ๐ซ CloudBase AI ToolKit
- Host: GitHub
- URL: https://github.com/tencentcloudbase/cloudbase-ai-toolkit
- Owner: TencentCloudBase
- License: mit
- Created: 2025-05-23T08:31:26.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-06-26T04:41:13.000Z (4 months ago)
- Last Synced: 2025-06-26T05:27:12.110Z (4 months ago)
- Topics: ai, cloudbase, cursor, mcp, miniprogram, prompt, serverless, tencent, web
- Language: TypeScript
- Homepage: https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/
- Size: 915 KB
- Stars: 205
- Watchers: 5
- Forks: 23
- Open Issues: 7
-
Metadata Files:
- Readme: README-EN.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
.png)
# ๐ CloudBase AI ToolKit
**Smarter, faster development with AI prompts, MCP protocol, and CloudBase.**
**๐ Languages:** [ไธญๆ](README.md) | **English**
[](https://opensource.org/licenses/MIT)
[](https://www.npmjs.com/package/@cloudbase/cloudbase-mcp)
[](https://www.npmjs.com/package/@cloudbase/cloudbase-mcp)
[](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit/stargazers)
[](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit/network/members)
[](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit/issues)
[](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit/pulls)
[](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit/commits)
[](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit/graphs/contributors)
[](https://cnb.cool/tencent/cloud/cloudbase/CloudBase-AI-ToolKit)
[](https://deepwiki.com/TencentCloudBase/CloudBase-AI-ToolKit)
When coding in AI programming tools like **Cursor/VSCode GitHub Copilot/WindSurf/CodeBuddy/Augment Code/Claude Code**, it automatically helps you generate deployable full-stack applications + mini-programs and publish them to Tencent CloudBase with one-click.
**๐น Complete Video Demo โฌ๏ธ**
| ๐ **Core Capabilities** | ๐ ๏ธ **Supported Platforms** |
|---|---|
| ๐ค **AI-Powered Development**: AI auto-generates code and architecture
โ๏ธ **Cloud Integration**: One-click access to database, cloud functions, static hosting
โก **Rapid Deployment**: Full-stack apps online in minutes | **Web Apps**: Modern frontend + static hosting
**WeChat Mini-Programs**: Cloud-native mini-program solutions
**Backend Services**: Cloud database + serverless functions + cloud hosting |
## โจ Key Features
- **๐ค AI-Native** - Rule library designed for AI programming tools, generates code following CloudBase best practices
- **๐ One-Click Deploy** - MCP automated deployment to Tencent CloudBase platform, Serverless architecture without server management
- **๐ฑ Full-Stack Apps** - Web + Mini-programs + Database + Backend integration, supports multiple app types and backend hosting
- **๐ง Smart Debugging** - AI automatically reviews logs and fixes issues, reducing operational costs
- **โก Lightning Fast** - Domestic CDN acceleration, faster access than overseas platforms
- **๐ Knowledge Retrieval** - Built-in intelligent vector search for CloudBase and WeChat Mini-Program professional knowledge bases
## ๐ Quick Start
### 0. Prerequisites
Install AI Development Tools
Such as [Cursor](https://www.cursor.com/) | [WindSurf](https://windsurf.com/editor) | [CodeBuddy](https://copilot.tencent.com/) etc. Click to see [list of supported AI development tools](#2-configure-your-ai-ide)
Set Up CloudBase Environment
Visit [Tencent CloudBase Console](https://tcb.cloud.tencent.com/dev) to create an environment. New users can start for free.
Install Node.js v18 or Higher
Make sure Node.js v18 or higher is installed on your computer. You can download and install the latest version from [Node.js official website](https://nodejs.org/).
Optional: Set npm Registry
To improve dependency download speed, it's recommended to set npm registry to Tencent mirror. You can run the following command in **terminal**:
```bash
npm config set registry https://mirrors.cloud.tencent.com/npm/
```
This speeds up dependency downloads, especially in mainland China.
Optional: Clear npx Cache
Due to a caching bug in npx itself, it may cause CloudBase AI ToolKit installation issues. You can try clearing the npx cache.
Run the following command in **terminal**:
```
npx -y clear-npx-cache
```
### 1. Quick Initialize or Enhance Your Project
We've prepared project templates with built-in CloudBase best practices and AI IDE rules. Two recommended approaches:
#### ๐ For New Projects
Choose a suitable template and initialize with one click:
- **WeChat Mini-Program + CloudBase Template**
[Download Package](https://static.cloudbase.net/cloudbase-examples/miniprogram-cloudbase-miniprogram-template.zip?v=2025053001) ๏ฝ [Source Code](https://github.com/TencentCloudBase/awesome-cloudbase-examples/tree/master/miniprogram/cloudbase-miniprogram-template)
- **React Web App + CloudBase Template**
[Download Package](https://static.cloudbase.net/cloudbase-examples/web-cloudbase-react-template.zip?v=2025053001) ๏ฝ [Source Code](https://github.com/TencentCloudBase/awesome-cloudbase-examples/tree/master/web/cloudbase-react-template)
- **Vue Web App + CloudBase Template**
[Download Package](https://static.cloudbase.net/cloudbase-examples/web-cloudbase-vue-template.zip?v=2025053001) ๏ฝ [Source Code](https://github.com/TencentCloudBase/awesome-cloudbase-examples/tree/master/web/cloudbase-vue-template)
- **UniApp Cross-Platform + CloudBase Template**
[Download Package](https://static.cloudbase.net/cloudbase-examples/universal-cloudbase-uniapp-template.zip?v=2025053001) ๏ฝ [Source Code](https://github.com/TencentCloudBase/awesome-cloudbase-examples/tree/master/universal/cloudbase-uniapp-template)
- **AI Rules Universal CloudBase Template**: Language and framework agnostic, includes CloudBase AI rules and MCP, suitable for any CloudBase project
[Download Package](https://static.cloudbase.net/cloudbase-examples/web-cloudbase-project.zip) ๏ฝ [Source Code](https://github.com/TencentCloudBase/awesome-cloudbase-examples/tree/master/web/cloudbase-project)
#### ๐ ๏ธ Enhance Existing Projects
If you already have a project, after configuring MCP, simply tell the AI "Download CloudBase AI rules in the current project" to instantly download and configure AI editor rules in your project directoryโno manual operations needed.
### 2. Configure Your AI IDE
> [!TIP]
> Tip: If you're using a template project, all configurations are pre-configured. Please follow the guide to check and enable tools. If not starting from a template, you need to manually add the corresponding configurations according to the specific instructions:
The following tools all support CloudBase AI ToolKit. Choose the appropriate tool and configure according to instructions:
| Tool | Platform |
|------|----------|
| [Cursor](https://cursor.com/) | Standalone IDE|
| [WindSurf](https://windsurf.com/editor) | Standalone IDE, VSCode, JetBrains plugin |
| [CodeBuddy](https://copilot.tencent.com/) | VS Code, JetBrains, WeChat DevTools plugin |
| [CLINE](https://cline.so/) | VS Code plugin |
| [GitHub Copilot](https://github.com/features/copilot) | VS Code plugin |
| [Trae](https://www.trae.ai/) | Standalone IDE |
| [Tongyi Lingma](https://tongyi.aliyun.com/lingma) | Standalone IDE, VS Code, JetBrains plugin |
| [RooCode](https://roocode.com/) | VS Code plugin |
| [Baidu Comate](https://comate.baidu.com/) | VS Code, JetBrains plugin|
| [Augment Code](https://www.augmentcode.com/) | VS Code, JetBrains plugin |
| [Claude Code](https://www.anthropic.com/claude-code) | Command line tool |
๐ง Cursor Configuration
#### Step 1: Use AI Rules
Template includes `.cursor/rules/` directory, AI will automatically recognize CloudBase best practices. If not starting from template, you can ask AI to help download CloudBase rules.
#### Step 2: Configure MCP
If using template project, MCP configuration is pre-configured. If not starting from template, click the button below to install in Cursor:
[](https://cursor.com/install-mcp?name=CloudBase&config=eyJjb21tYW5kIjoibnB4IEBjbG91ZGJhc2UvY2xvdWRiYXNlLW1jcEBsYXRlc3QiLCJkaXNhYmxlZCI6ZmFsc2V9)
Or manually add configuration to `.cursor/mcp.json`:
```json
{
"mcpServers": {
"cloudbase-mcp": {
"command": "npx",
"args": ["-y", "@cloudbase/cloudbase-mcp@latest"]
}
}
}
```
Then click the โ๏ธ icon in the top-right corner of Cursor client, go to "MCP" settings, find cloudbase and enable it.
#### Step 3: Switch to Agent Mode
Use Agent mode in the chat window for code generation and automation.
๐ Codeium/WindSurf Configuration
#### Step 1: Use AI Rules
Template's `.windsurf/` directory contains configurations optimized for WindSurf. If not starting from template, you can ask AI to help download CloudBase rules.
#### Step 2: Configure MCP
If using template project, MCP configuration is pre-configured. If not starting from template, add in WindSurf's Plugins configuration:
```json
{
"mcpServers": {
"cloudbase-mcp": {
"command": "npx",
"args": ["-y", "@cloudbase/cloudbase-mcp@latest"]
}
}
}
```
#### Step 3: Switch to Write Mode
Switch to Write mode in chat for intelligent generation.
๐ฅ CodeBuddy Configuration
#### Step 1: Use AI Rules
Template includes `.rules/` directory, CodeBuddy will automatically recognize CloudBase best practices. If not starting from template, you can ask AI to help download CloudBase rules.
#### Step 2: Configure MCP
Click the MCP button in the top-right corner of CodeBuddy, click add on the right, and add CloudBase MCP in the MCP configuration:
```json
{
"mcpServers": {
"cloudbase": {
"command": "npx",
"args": ["-y", "@cloudbase/cloudbase-mcp@latest"]
}
}
}
```
#### Step 3: Switch to Craft Agent
Switch to Craft mode in the chat window. It's recommended to disable the confirm plan feature in the right settings for a smoother experience.
๐ค CLINE Configuration
#### Step 1: Use AI Rules
Template includes `.clinerules/` directory, AI will automatically recognize CloudBase best practices. If not starting from template, you can ask AI to help download CloudBase rules.
#### Step 2: Configure MCP
If using template project, MCP configuration is pre-configured. If not starting from template, add in MCP Server configuration:
```json
{
"mcpServers": {
"cloudbase": {
"autoApprove": [],
"timeout": 60,
"command": "npx",
"args": [
"@cloudbase/cloudbase-mcp@latest"
],
"transportType": "stdio",
"disabled": false
}
}
}
```
#### Step 3: Use AI Chat
It's recommended to use models that support code generation and function calls.
๐ GitHub Copilot Configuration
#### Step 1: Use AI Rules
Template's `.github/` directory contains Copilot optimized configurations. If not starting from template, you can ask AI to help download CloudBase rules.
#### Step 2: Configure MCP
If using template project, MCP configuration is pre-configured. If not starting from template, add in `.vscode/mcp.json`:
```json
{
"servers": {
"cloudbase": {
"command": "npx",
"args": [
"@cloudbase/cloudbase-mcp@latest"
]
}
}
}
```
#### Step 3: Switch to Agent Mode
Switch to Agent mode in the bottom-left corner of the chat window.
๐ฏ Trae Configuration
This guide supports both Trae international and Trae CN versions. It's recommended to test with Claude/DeepSeek V3 0324 models.
#### Step 1: Use AI Rules
Template's `.trae/rules` directory contains CloudBase rule configurations for Trae. If not starting from template, you can ask AI to help download CloudBase rules.
#### Step 2: Configure MCP
If using template project, MCP configuration is pre-configured. If not starting from template, add in MCP configuration:
```json
{
"mcpServers": {
"cloudbase-mcp": {
"command": "npx",
"args": ["-y", "@cloudbase/cloudbase-mcp@latest"]
}
}
}
```
#### Step 3: Use Builder with MCP Chat
Select Builder with MCP in the agent for chat.
๐งฉ Tongyi Lingma Configuration
#### Step 1: Use AI Rules
Template includes `.lingma/` directory, Tongyi Lingma will automatically recognize CloudBase best practices. If not starting from template, you can ask AI to help download CloudBase rules.
#### Step 2: Configure MCP
If using template project, MCP configuration is pre-configured. If not starting from template, add in MCP configuration:
```json
{
"mcpServers": {
"cloudbase-mcp": {
"command": "npx",
"args": ["-y", "@cloudbase/cloudbase-mcp@latest"]
}
}
}
```
#### Step 3: Switch to Agent Mode
Switch to agent mode in the bottom-left corner of the chat window.
๐ค RooCode Configuration
#### Step 1: Use AI Rules
Template includes `.roo/rules` directory, RooCode will automatically recognize CloudBase best practices. If not starting from template, you can ask AI to help download CloudBase rules.
#### Step 2: Configure MCP
If using template project, MCP configuration is pre-configured. If not starting from template, add in MCP configuration:
```json
{
"mcpServers": {
"cloudbase": {
"command": "npx",
"args": [
"@cloudbase/cloudbase-mcp@latest"
],
"disabled": false
}
}
}
```
#### Step 3: Use AI Chat
Use the chat window for code generation and automation.
๐ค Baidu Comate Configuration
#### Step 1: Use AI Rules
Template includes `.comate/rules` directory, Baidu Comate will automatically recognize CloudBase best practices. If not starting from template, you can ask AI to help download CloudBase rules.
#### Step 2: Configure MCP
If using template project, MCP configuration is pre-configured. If not starting from template, add in MCP configuration:
```json
{
"mcpServers": {
"cloudbase": {
"command": "npx",
"args": [
"@cloudbase/cloudbase-mcp@latest"
],
"disabled": false
}
}
}
```
#### Step 3: Use AI Chat
Switch to Zulu mode in the chat window for operations.
๐ Augment Code Configuration
#### Step 1: Use AI Rules
Template includes `.augment-guidelines` file, Augment Code will automatically recognize CloudBase best practices. If not starting from template, you can ask AI to help download CloudBase rules.
#### Step 2: Configure MCP
If using template project, MCP configuration is pre-configured (built into `.vscode/settings.json`). If not starting from template, add CloudBase MCP in Augment's MCP configuration, [refer to documentation](https://docs.augmentcode.com/setup-augment/mcp):
```json
{
"augment.advanced": {
"mcpServers": {
"cloudbase": {
"command": "npx",
"args": [
"@cloudbase/cloudbase-mcp@latest"
]
}
}
}
}
```
#### Step 3: Use Agent Mode
Use Agent mode in the chat window for intelligent code generation and automation.
๐ค Claude Code Configuration
#### Step 1: Use AI Rules
Template includes `CLAUDE.md` file, Claude Code will automatically recognize CloudBase best practices. If not starting from template, you can ask AI to help download CloudBase rules.
#### Step 2: Configure MCP
If using template project, MCP configuration is pre-configured. If not starting from template, create `.mcp.json` file in project root:
```json
{
"mcpServers": {
"cloudbase": {
"command": "npx",
"args": [
"-y",
"@cloudbase/cloudbase-mcp@latest"
]
}
}
}
```
#### Step 3: Use AI Chat
Chat directly with AI in Claude Code for intelligent code generation and automation.
๐ Update CloudBase AI ToolKit
**Update AI Rules**
If you want to update to the latest CloudBase AI rules in an existing project, simply tell the AI:
```
Download CloudBase AI rules
```
AI will automatically download and update the latest rule configurations to your project directory.
**Update MCP Tools**
When new versions of MCP tools are released, you can update through:
1. **Auto Update (Recommended)**: In your AI development tool's MCP list, find cloudbase-mcp and re-enable or refresh the MCP list to automatically install the latest version
2. **Manual Update**: If auto update doesn't work, you can disable and re-enable cloudbase-mcp, or restart your AI IDE
Since the MCP configuration uses the `@latest` tag, it usually automatically gets the latest version.
### 3. Start Development
Before starting, simply tell the AI:
```
Login to CloudBase
```
AI will automatically open the Tencent Cloud login interface and CloudBase environment selection.
If you need to switch environments later, you can say:
```
Logout from CloudBase
```
AI will clean up local configurations, and you can then ask AI to login to CloudBase again for re-login.
After successful login, you can confirm AI is connected to CloudBase:
```
Query current CloudBase environment information
```
Describe your requirements to AI for development:
```
Create a two-player online Gomoku website with multiplayer battles, then deploy it
```
AI will automatically:
- ๐ Generate frontend and backend code
- ๐ Deploy to CloudBase
- ๐ Return online access link
If you encounter errors during development, you can send the error information to AI for troubleshooting:
```
Got an error, the error is xxxx
```
You can also ask AI to debug and modify code using cloud function logs:
```
Cloud function code doesn't meet requirements, requirement is xxx, please check logs and data for debugging and fixing
```
## ๐ฏ Use Cases
### Case 1: Two-Player Online Gomoku
**Development Process:**
1. Input requirement: "Create a two-player online Gomoku website with multiplayer battles"
2. AI generates: Web app + cloud database + real-time data push
3. Auto deploy and get access link
๐ **Experience**: [Gomoku Game](https://cloud1-5g39elugeec5ba0f-1300855855.tcloudbaseapp.com/gobang/#/)
๐ธ View Development Screenshots
| Development Process | Final Result |
|---------|---------|
| 
| 
|
| 
| Supports two-player online battles
Real-time game synchronization |
### Case 2: AI Pet Raising Mini-Program
**Development Process:**
1. Input: "Develop a Pokemon pet raising wechat mini-program with AI-enhanced interactions"
2. AI generates: Mini-program + cloud database + AI cloud functions
3. Import into WeChat DevTools for publishing
๐ธ View Development Screenshots and Mini-Program Preview
๐ฅ๏ธ Development Screenshots
๐ฑ Mini-Program Preview
๐ฒ Experience QR Code
### Case 3: Intelligent Problem Diagnosis
When applications have issues:
1. AI automatically checks cloud function logs
2. Analyzes error causes and generates fix code
3. Auto redeploy
๐ธ View Intelligent Diagnosis Process
AI automatically analyzes logs and generates fix solutions
---
## ๐ Why Choose CloudBase?
- **โก Lightning Deploy**: Domestic nodes, faster access than overseas
- **๐ก๏ธ Stable & Reliable**: Serverless platform chosen by 3.3 million developers
- **๐ง Developer Friendly**: Full-stack platform designed for AI era, supports auto environment configuration
- **๐ฐ Cost Optimized**: Serverless architecture more elastic, new users can experience for free during development
## ๐ FAQ
For common questions about migration, integration, etc., please check [FAQ](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq).
## ๐ฌ Tech Community
Having issues or want to share experiences? Join our tech community!
### ๐ฅ WeChat Community
Scan to join WeChat tech community
**In the group you can:**
- ๐ก Share your AI + CloudBase projects
- ๐ค Tech discussions and development Q&A
- ๐ข Get latest feature updates and best practices
- ๐ฏ Participate in product feature discussions and suggestions
### ๐ฑ Other Communication Channels
| Platform | Link | Description |
|------|------|------|
| **Official Docs** | [๐ View Docs](https://docs.cloudbase.net/) | Complete CloudBase documentation |
| **Issue Feedback** | [๐ Submit Issues](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit/issues) | Bug reports and feature requests |
### ๐ Community Activities
- **Weekly Tech Sharing**: Regular sharing of AI + CloudBase best practices in the group
- **Project Showcase**: Show off your amazing AI-developed projects
- **Q&A Sessions**: Tencent CloudBase team members answer questions online
- **Feature Preview**: First access to latest features
## ๐ ๏ธ CloudBase MCP Tools Overview
Currently includes **35 tools** covering environment management, database operations, cloud function management, static hosting, and other core functions.
๐ **Complete Tool Documentation**: [View MCP Tools Detailed Documentation](doc/mcp-tools.md) | [View Tool Specifications JSON](scripts/tools.json)
### ๐ง Tool Categories Overview
| Category | Tool Count | Main Functions |
|------|----------|----------|
| ๐ **Environment Management** | 4 | Login authentication, environment info query, domain management |
| ๐๏ธ **Database Operations** | 11 | Collection management, document CRUD, index operations, data models |
| โก **Cloud Functions** | 9 | Function creation, updates, invocation, logs, triggers |
| ๐ **Static Hosting** | 5 | File upload management, domain configuration, website deployment |
| ๐ **File Operations** | 2 | Remote file download, cloud storage upload |
| ๐ ๏ธ **Tool Support** | 3 | Project templates, knowledge base search, interactive dialog |
| ๐ **HTTP Access** | 1 | HTTP function access configuration |
### ๐ Core Tool Highlights
| Tool Type | Tool Name | Feature Highlights |
|----------|----------|----------|
| ๐ **Authentication** | `login` / `logout` | One-click CloudBase login, auto environment selection |
| ๐ **Environment Query** | `envQuery` | **๐ Merged Tool** - Environment list, info, domains unified query |
| ๐๏ธ **Database** | `collectionQuery` | **๐ Merged Tool** - Collection existence, details, list unified management |
| โก **Cloud Functions** | `createFunction` | Supports complete configuration, auto dependency installation, trigger setup |
| ๐ **Static Hosting** | `uploadFiles` | Batch file upload, smart ignore rules, CDN acceleration |
| ๐ง **AI Enhancement** | `searchKnowledgeBase` | Vector search CloudBase knowledge base, intelligent Q&A support |
### ๐ก Tool Optimization Notes
We optimized from 40 tools to 35 by merging related functions for better user experience.
๐ **Want to learn about each tool's detailed functions?** Please check [Complete MCP Tools Documentation](doc/mcp-tools.md)
## ๐๏ธ Architecture Principles
```mermaid
graph TD
A[Developer] --> B[AI IDE]
B -->|Uses| C[CloudBase AI Rules]
C --> D[Generate Code]
B -->|Calls| E[CloudBase MCP]
E --> F{Detect Deployment}
F -->|Success| G[CloudBase Platform]
F -->|Fail| H[Return Logs]
H --> I[AI Fix]
I --> E
G --> J[Online Application]
J --> K[Web/Mini-Program/API]
```
## ๐ Data Statistics Notice
To improve product experience, CloudBase AI ToolKit collects anonymous usage statistics:
- **Collection Content**: Tool usage, basic environment info (OS, Node.js version, etc.)
- **Privacy Protection**: No code content, file paths, or sensitive info collected, only for product improvement
You can disable data statistics by setting environment variable `CLOUDBASE_MCP_TELEMETRY_DISABLED` to `true`
## ๐ค Contributing
Welcome to submit Issues and Pull Requests! Please check our [Contributing Guide](CONTRIBUTING.md) to learn how to participate in project development.
## ๐ License
[MIT](LICENSE) ยฉ TencentCloudBase
---
โญ If this project helps you, please give us a Star!
[](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit)
