Skip to content

Commit d6ca53f

Browse files
committed
docs: update FAQ and Augment Code setup guide 📝
1 parent 3181ef7 commit d6ca53f

2 files changed

Lines changed: 21 additions & 40 deletions

File tree

doc/faq.md

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -107,28 +107,6 @@ AI 会自动下载并更新最新的规则配置到你的项目目录。
107107

108108
如果你希望全局安装 CloudBase AI ToolKit 以避免每次使用 npx 下载,推荐使用 `npm-global-exec` 方式,这种方式更稳定且自动处理依赖:
109109

110-
**推荐配置方式:**
111-
112-
```json
113-
{
114-
"mcpServers": {
115-
"cloudbase": {
116-
"command": "npx",
117-
"args": ["npm-global-exec@latest", "@cloudbase/cloudbase-mcp@latest"]
118-
}
119-
}
120-
}
121-
```
122-
123-
**优势:**
124-
- 启动速度更快,无需每次下载
125-
- 避免网络问题导致的启动失败
126-
- 减少 npx 缓存相关问题
127-
- 自动安装和管理依赖
128-
- 避免全局安装可能遇到的权限和环境问题
129-
- 自动获取最新版本
130-
131-
132110
**1. 检查环境配置**
133111
- 确保 Node.js 版本为 v18.15.0 及以上,macOS 用户且使用 nvm 管理 Node.js 的,请务必设置默认 Node 版本为 v18.15.0 及以上,避免不同终端版本不一致导致的问题。
134112
- 检查网络连接,建议设置 npm 源为腾讯镜像源:
@@ -152,7 +130,7 @@ npx -y npm-global-exec@latest @cloudbase/cloudbase-mcp@latest
152130

153131
3.1 重启 IDE
154132

155-
3.2 删除原有的 CloudBase MCP Server 配置,并使用新的 MCP Server 配置如下
133+
3.2 确保 MCP Server 的配置如下
156134

157135
```json
158136
{
@@ -194,6 +172,12 @@ Safari 浏览器在某些情况下可能存在兼容性问题,影响授权流
194172

195173
如果你在远程开发环境中工作,或者需要在没有浏览器的服务端环境中直接调用 MCP,无法通过浏览器完成授权登录,可以使用环境变量来配置腾讯云密钥和环境信息。
196174

175+
全局安装安装脚本
176+
177+
```
178+
npm i @cloudbase/cloudbase-mcp@latest -g
179+
```
180+
197181
**配置方法:**
198182

199183
在 MCP 配置中使用 `env` 环境变量来设置认证信息:
@@ -202,9 +186,9 @@ Safari 浏览器在某些情况下可能存在兼容性问题,影响授权流
202186
{
203187
"mcpServers": {
204188
"cloudbase-mcp": {
205-
"command": "npx",
206-
"args": ["npm-global-exec@latest", "@cloudbase/cloudbase-mcp@latest"],
207-
"env": {
189+
"command": "cloudbase-mcp",
190+
"args": ["--integration-ide", "YOUR_IDE"]
191+
"env": {
208192
"TENCENTCLOUD_SECRETID": "腾讯云 SecretId",
209193
"TENCENTCLOUD_SECRETKEY": "腾讯云 SecretKey",
210194
"TENCENTCLOUD_SESSIONTOKEN": "腾讯云临时密钥Token,如果使用临时密钥才需要传入",

doc/ide-setup/augment-code.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -55,25 +55,22 @@
5555
> 如果安装以后工具数量一直为 0,请参考[常见问题](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-%E6%98%BE%E7%A4%BA%E5%B7%A5%E5%85%B7%E6%95%B0%E9%87%8F%E4%B8%BA-0-%E6%80%8E%E4%B9%88%E5%8A%9E)
5656
5757

58+
参考 [Augment Code 的 MCP 配置文](https://docs.augmentcode.com/setup-augment/mcp#advanced-mcp-configuration),选择 **Import from JSON** 方式,填写如下内容:
59+
60+
5861
`.vscode/settings.json` 中添加:
5962

6063
```json
6164
{
62-
"augment.advanced": {
63-
"mcpServers": [
64-
{
65-
"name": "cloudbase",
66-
"command": "npx",
67-
"args": [
68-
"npm-global-exec@latest",
69-
"@cloudbase/cloudbase-mcp@latest"
70-
],
71-
"env": {
72-
"INTEGRATION_IDE": "Augment"
73-
}
74-
}
75-
]
65+
"mcpServers": {
66+
"cloudbase": {
67+
"command": "npx",
68+
"args": ["npm-global-exec@latest", "@cloudbase/cloudbase-mcp@latest"],
69+
"env": {
70+
"INTEGRATION_IDE": "Augment"
71+
}
7672
}
73+
}
7774
}
7875
```
7976

0 commit comments

Comments
 (0)