You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README-EN.md
+111-6Lines changed: 111 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
# 🌟 CloudBase AI ToolKit
6
6
7
-
**Smarter, faster development with AI prompts, MCP protocol, and CloudBase.**
7
+
**🪐 Generate, deploy, and host your full-stack Web applications, mini-programs, databases, and backend services with AI IDE in one click—no DevOps required, launch your ideas at lightning speed 💫**
8
8
9
9
**🌍 Languages:**[中文](README.md) | **English**
10
10
@@ -23,6 +23,8 @@
23
23
24
24
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.
@@ -149,7 +151,10 @@ Template includes `.cursor/rules/` directory, AI will automatically recognize Cl
149
151
150
152
#### Step 2: Configure MCP
151
153
152
-
If using template project, MCP configuration is pre-configured. If not starting from template, click the button below to install in Cursor:
154
+
> [!TIP]
155
+
> If the tool count remains 0 after installation, please refer to [FAQ](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-displays-0-tools-what-to-do)
156
+
157
+
If using template project, MCP configuration is pre-configured. Please click the popup window at the bottom left to enable MCP. If not starting from template, click the button below to install in Cursor:
> If the tool count remains 0 after installation, please refer to [FAQ](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-displays-0-tools-what-to-do)
193
+
186
194
If using template project, MCP configuration is pre-configured. If not starting from template, add in WindSurf's Plugins configuration:
187
195
188
196
```json
@@ -211,7 +219,12 @@ Template includes `.rules/` directory, CodeBuddy will automatically recognize Cl
211
219
212
220
#### Step 2: Configure MCP
213
221
214
-
Click the MCP button in the top-right corner of CodeBuddy, click add on the right, and add CloudBase MCP in the MCP configuration:
222
+
> [!TIP]
223
+
> If the tool count remains 0 after installation, please refer to [FAQ](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-displays-0-tools-what-to-do)
224
+
225
+
1. You can click the MCP button in the top-right corner of CodeBuddy, search for CloudBase in the MCP marketplace, and click install.
226
+
227
+
2. Or manually add: click the MCP button in the top-right corner of CodeBuddy, click add on the right, and add CloudBase MCP in the MCP configuration:
215
228
216
229
```json
217
230
{
@@ -239,6 +252,9 @@ Template includes `.clinerules/` directory, AI will automatically recognize Clou
239
252
240
253
#### Step 2: Configure MCP
241
254
255
+
> [!TIP]
256
+
> If the tool count remains 0 after installation, please refer to [FAQ](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-displays-0-tools-what-to-do)
257
+
242
258
If using template project, MCP configuration is pre-configured. If not starting from template, add in MCP Server configuration:
243
259
244
260
```json
@@ -273,6 +289,9 @@ Template's `.github/` directory contains Copilot optimized configurations. If no
273
289
274
290
#### Step 2: Configure MCP
275
291
292
+
> [!TIP]
293
+
> If the tool count remains 0 after installation, please refer to [FAQ](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-displays-0-tools-what-to-do)
294
+
276
295
If using template project, MCP configuration is pre-configured. If not starting from template, add in `.vscode/mcp.json`:
If using template project, MCP configuration is pre-configured. If not starting from template, add in MCP configuration:
327
+
> [!TIP]
328
+
> If the tool count remains 0 after installation, please refer to [FAQ](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-displays-0-tools-what-to-do)
329
+
330
+
Add in Trae's MCP configuration:
309
331
310
332
```json
311
333
{
@@ -333,6 +355,9 @@ Template includes `.lingma/` directory, Tongyi Lingma will automatically recogni
333
355
334
356
#### Step 2: Configure MCP
335
357
358
+
> [!TIP]
359
+
> If the tool count remains 0 after installation, please refer to [FAQ](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-displays-0-tools-what-to-do)
360
+
336
361
If using template project, MCP configuration is pre-configured. If not starting from template, add in MCP configuration:
337
362
338
363
```json
@@ -361,6 +386,9 @@ Template includes `.roo/rules` directory, RooCode will automatically recognize C
361
386
362
387
#### Step 2: Configure MCP
363
388
389
+
> [!TIP]
390
+
> If the tool count remains 0 after installation, please refer to [FAQ](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-displays-0-tools-what-to-do)
391
+
364
392
If using template project, MCP configuration is pre-configured. If not starting from template, add in MCP configuration:
365
393
366
394
```json
@@ -392,6 +420,9 @@ Template includes `.comate/rules` directory, Baidu Comate will automatically rec
392
420
393
421
#### Step 2: Configure MCP
394
422
423
+
> [!TIP]
424
+
> If the tool count remains 0 after installation, please refer to [FAQ](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-displays-0-tools-what-to-do)
425
+
395
426
If using template project, MCP configuration is pre-configured. If not starting from template, add in MCP configuration:
396
427
397
428
```json
@@ -408,9 +439,9 @@ If using template project, MCP configuration is pre-configured. If not starting
408
439
}
409
440
```
410
441
411
-
#### Step 3: Use AI Chat
442
+
#### Step 3: Use Agent Mode
412
443
413
-
Switch to Zulu mode in the chat window for operations.
444
+
Use Agent mode in the chat window for intelligent code generation and automation.
414
445
415
446
</details>
416
447
@@ -455,6 +486,9 @@ Template includes `CLAUDE.md` file, Claude Code will automatically recognize Clo
455
486
456
487
#### Step 2: Configure MCP
457
488
489
+
> [!TIP]
490
+
> If the tool count remains 0 after installation, please refer to [FAQ](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-displays-0-tools-what-to-do)
491
+
458
492
If using template project, MCP configuration is pre-configured. If not starting from template, create `.mcp.json` file in project root:
459
493
460
494
```json
@@ -477,6 +511,77 @@ Chat directly with AI in Claude Code for intelligent code generation and automat
Make sure Node.js 18+ is installed, then install Gemini CLI globally:
520
+
521
+
```bash
522
+
npm install -g @google/gemini-cli
523
+
```
524
+
525
+
Or run directly:
526
+
527
+
```bash
528
+
npx @google/gemini-cli
529
+
```
530
+
531
+
On first run, log in with your personal Google account to get free quota (60 requests per minute, 1000 requests per day).
532
+
533
+
#### Step 2: Configure MCP
534
+
535
+
> [!TIP]
536
+
> If the tool count remains 0 after installation, please refer to [FAQ](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-displays-0-tools-what-to-do)
537
+
538
+
If using template project, MCP configuration is pre-configured.
539
+
540
+
If not starting from template, create `.gemini/settings.json` file in user home directory (`~`) or project directory:
541
+
542
+
```json
543
+
{
544
+
"mcpServers": {
545
+
"cloudbase-mcp": {
546
+
"command": "npx",
547
+
"args": ["-y", "@cloudbase/cloudbase-mcp@latest"]
548
+
}
549
+
}
550
+
}
551
+
```
552
+
553
+
#### Step 3: Enable AI Rules
554
+
555
+
Template project root already includes `GEMINI.md` file with CloudBase development rules.
556
+
557
+
If it's an existing project, tell the AI in Gemini CLI:
558
+
559
+
```
560
+
Download CloudBase AI rules in current project
561
+
```
562
+
563
+
#### Step 4: Start Development
564
+
565
+
Launch Gemini CLI:
566
+
567
+
```bash
568
+
gemini
569
+
```
570
+
571
+
Then tell the AI:
572
+
573
+
```
574
+
Login to CloudBase
575
+
```
576
+
577
+
**Common Commands:**
578
+
-`/tools` - View available tools
579
+
-`/mcp` - View MCP server status
580
+
-`/memory show` - View current rules
581
+
-`!command` - Execute Shell command
582
+
583
+
</details>
584
+
480
585
<details>
481
586
<summary><strong>🔄 Update CloudBase AI ToolKit</strong></summary>
0 commit comments