TencentCloudBase/CloudBase-AI-ToolKit

TencentCloudBase/CloudBase-AI-ToolKit

от tencentcloudbase
MCP-сервер CloudBase соединяет AI IDE с облачной инфраструктурой Tencent Cloud, позволяя разработчикам развёртывать приложения одной командой. Он заполняет разрыв между генерацией кода и деплоем, автоматизируя настройку функций, баз данных и хостинга. Полезен для AI-программистов, которые хотят у...

banner

CloudBase MCP

🪐 AI 编程,一键上线
连接 AI IDE 与腾讯云 CloudBase 的部署桥梁,让你的 AI 应用即刻上线
💡 像 Vercel + Supabase,但全程 AI 驱动——从提示词直达生产环境

English · 简体中文 · [文档][docs] · [更新日志][changelog] · [反馈问题][github-issues-link]

[![][npm-version-shield]][npm-link] [![][npm-downloads-shield]][npm-link] [![][github-stars-shield]][github-stars-link] [![][github-forks-shield]][github-forks-link] [![][github-issues-shield]][github-issues-link] ![][github-license-shield] ![][github-contributors-shield] [![][cnb-shield]][cnb-link] [![][deepwiki-shield]][deepwiki-link]

⭐ 喜欢这个项目?点个 Star,新版本发布时你会收到通知~

发现了一个让 AI 编程一键上线的神器,推荐给正在用 AI 编程的朋友

[![][share-x-shield]][share-x-link] [![][share-telegram-shield]][share-telegram-link] [![][share-weibo-shield]][share-weibo-link]

从 AI 提示词到应用上线的最短路径

Clipboard_Screenshot_1764660604

![][github-trending-shield]

Clipboard_Screenshot_1763724670

为什么你需要 CloudBase MCP?

AI 编程工具(如 OpenClaw、Cursor、CodeBuddy)解决了代码生成的难题。

但是,从"生成代码"到"应用上线"(部署、配置数据库、CDN、域名),依然存在一条鸿沟。

CloudBase MCP(原 CloudBase AI ToolKit)填补了这条鸿沟。

你不再需要:

  • ❌ 繁琐的 DevOps 配置和 YAML 文件
  • ❌ 手动设置云函数和数据库
  • ❌ 在 IDE 和云控制台之间反复横跳

你只需要在 AI IDE 中,用自然语言完成从"想法"到"上线"的全过程。

目录
  • 🚀 快速开始
  • ✨ 核心特性
  • 📦 安装配置
  • 🎯 使用案例
  • 🧩 MCP 工具
  • 📚 更多资源

🚀 快速开始

一行配置,立即使用

在支持 MCP 的 AI IDE 中(Cursor、WindSurf、CodeBuddy 等)添加下方任一配置即可。连接方式有两种:


方式一:本地模式(推荐)

含义:MCP 服务在你本机通过 npx 启动,与 IDE 同机运行。 优点:功能最全(包含上传/下载、模板安装等依赖本地文件系统的能力)。 要求:本机已安装 Node.js,且能执行 npx

{
  "mcpServers": {
    "cloudbase": {
      "command": "npx",
      "args": ["@cloudbase/cloudbase-mcp@latest"]
    }
  }
}

方式二:托管模式

含义:MCP 服务运行在腾讯云上,IDE 通过 HTTP 连接云端服务,无需在本地安装或运行 Node。 优点:不依赖本机环境,配置好密钥即可使用。 限制:部分依赖本地文件系统的能力不可用(如本地文件上传、模板下载到本机等)。

activateInviteCodeвнешний мир

云开发 AI编程激励计划, через пригласительный код активирует поощрение пользователей.

激活邀请码

云开发 AI编程激励计划, через пригласительный код активирует поощрение пользователей.

Параметры

  • InviteCodestringобязательный

    待激活的邀请码

authвнешний мир

CloudBase (Tencent Cloud Development) — логин и привязка окружения на этапе разработки. После входа вы получаете доступ к облачным ресурсам; окружение (env) — это изолированная единица для облачных функций, баз данных, статического хостинга и других ресурсов. Только после привязки окружения остальные MCP-инструменты смогут с ним работать. Поддерживается: проверка статуса, вход в систему, вход по API Key, привязка окружения (set_env), выход из системы.

CloudBase 开发阶段登录与环境

CloudBase (Tencent Cloud Development) — логин и привязка окружения на этапе разработки. После входа вы получаете доступ к облачным ресурсам; окружение (env) — это изолированная единица для облачных функций, баз данных, статического хостинга и других ресурсов. Только после привязки окружения остальные MCP-инструменты смогут с ним работать. Поддерживается: проверка статуса, вход в систему, вход по API Key, привязка окружения (set_env), выход из системы.

Параметры

  • actionenum

    动作:status=查询状态,start_auth=发起登录,login_by_api_key=API Key登录,set_env=绑定环境(传envId),logout=退出登录

    statusstart_authset_envlogoutget_temp_credentialslogin_by_api_key
  • authModeenum

    认证模式:device=设备码授权,web=浏览器回调授权

    deviceweb
  • oauthEndpointstring

    高级可选:自定义 device-code 登录 endpoint。配置后 oauthCustom 默认按 true 处理

  • clientIdstring

    高级可选:自定义 device-code 登录 client_id,不传则使用默认值

  • oauthCustomboolean

    高级可选:自定义 endpoint 返回格式开关。未配置 endpoint 时默认 false;配置 endpoint 后默认 true,且不能设为 false

  • envIdstring

    环境ID(CloudBase 环境唯一标识),绑定后工具将操作该环境。action=set_env 时必填

  • apiKeystring

    CloudBase API Key,action=login_by_api_key 时必填

  • apiKeyEnvIdstring

    CloudBase 环境ID(EnvId),action=login_by_api_key 时必填,用于指定 API Key 所属环境

  • confirmstring

    action=logout 时确认操作,传 yes

  • revealboolean

    action=get_temp_credentials 时可选。true=返回明文临时密钥;默认 false 仅返回脱敏结果

callCloudApiвнешний мир

Универсальный инструмент для вызова облачных API, в основном используется для вызова API управляющей плоскости CloudBase / Tencent Cloud и связанных с зависимыми ресурсами. Перед вызовом сначала убедитесь в корректности service, Action и Param, чтобы избежать угадывания имени Action. Если ваша цель — напрямую интегрировать бизнес-API CloudBase (auth/functions/cloudrun/storage/mysqldb и т.д.) через протокол HTTP, не используйте в первую очередь callCloudApi, а сначала просмотрите соответствующий OpenAPI/Swagger. Существующие возможности OpenAPI/Swagger не являются универсальным набором Action для управляющей плоскости; для API управляющей плоскости сначала обращайтесь к CloudBase API Overview https://cloud.tencent.com/document/product/876/34809 и руководству по интерфейсам зависимых ресурсов облачной разработки https://cloud.tencent.com/document/product/876/34808. Для сервиса tcb часто используемые Action делятся на следующие категории: **Управление окружениями**: `CreateEnv`, `ModifyEnv`, `DescribeEnvs`, `DestroyEnv` **Управление пользователями**: `CreateUser`, `ModifyUser`, `DescribeUserList`, `DeleteUsers` **Конфигурация аутентификации**: `EditAuthConfig`, `DescribeAuthDomains` **Облачные функции**: `DescribeFunctions`, `CreateFunction`, `UpdateFunctionCode`, `DeleteFunction` **Базы данных**: `CreateMySQLInstance`, `DescribeMySQLInstances`, `DestroyMySQLInstance` При уничтожении окружения стандартная практика — обязательно передавать как минимум `EnvId` и `BypassCheck: true`, а если окружение уже находится в периоде изоляции, то по документации дополнительно указать `IsForce: true`.

调用云API

Универсальный инструмент для вызова облачных API, в основном используется для вызова API управляющей плоскости CloudBase / Tencent Cloud и связанных с зависимыми ресурсами. Перед вызовом сначала убедитесь в корректности service, Action и Param, чтобы избежать угадывания имени Action. Если ваша цель — напрямую интегрировать бизнес-API CloudBase (auth/functions/cloudrun/storage/mysqldb и т.д.) через протокол HTTP, не используйте в первую очередь callCloudApi, а сначала просмотрите соответствующий OpenAPI/Swagger. Существующие возможности OpenAPI/Swagger не являются универсальным набором Action для управляющей плоскости; для API управляющей плоскости сначала обращайтесь к CloudBase API Overview https://cloud.tencent.com/document/product/876/34809 и руководству по интерфейсам зависимых ресурсов облачной разработки https://cloud.tencent.com/document/product/876/34808. Для сервиса tcb часто используемые Action делятся на следующие категории: **Управление окружениями**: `CreateEnv`, `ModifyEnv`, `DescribeEnvs`, `DestroyEnv` **Управление пользователями**: `CreateUser`, `ModifyUser`, `DescribeUserList`, `DeleteUsers` **Конфигурация аутентификации**: `EditAuthConfig`, `DescribeAuthDomains` **Облачные функции**: `DescribeFunctions`, `CreateFunction`, `UpdateFunctionCode`, `DeleteFunction` **Базы данных**: `CreateMySQLInstance`, `DescribeMySQLInstances`, `DestroyMySQLInstance` При уничтожении окружения стандартная практика — обязательно передавать как минимум `EnvId` и `BypassCheck: true`, а если окружение уже находится в периоде изоляции, то по документации дополнительно указать `IsForce: true`.

Параметры

  • serviceenumобязательный

    选择要访问的服务。可选:tcb、scf、sts、cam、lowcode、cdn、vpc。对于 tcb / scf / lowcode 等 CloudBase 管控面 Action,请优先查官方文档,不要直接猜测 Action。

    tcbscfstscamlowcodecdnvpc
  • actionstringобязательный

    具体 Action 名称,需符合对应服务的官方 API 定义。若不确定正确 Action,请先查官方文档;不要用近义词或历史命名进行猜测。tcb 常用 Action:环境管理 CreateEnv/ModifyEnv/DescribeEnvs/DestroyEnv、用户管理 CreateUser/ModifyUser/DescribeUserList/DeleteUsers、认证配置 EditAuthConfig、云函数 DescribeFunctions/CreateFunction、数据库 CreateMySQLInstance 等。

  • paramsobject

    Action 对应的参数对象,键名需与官方 API 定义一致。某些 Action 需要携带 EnvId 等信息;如不确定参数结构,请先查官方文档。tcb 示例:`{ "service": "tcb", "action": "DestroyEnv", "params": { "EnvId": "env-xxx", "BypassCheck": true } }`,如果环境已经处于隔离期,可再补 `IsForce: true`;更新环境别名则可用 `{ "service": "tcb", "action": "ModifyEnv", "params": { "EnvId": "env-xxx", "Alias": "demo" } }`。若你的场景是通过 HTTP 协议直接集成 auth/functions/cloudrun/storage/mysqldb 等 CloudBase 业务 API,请优先使用 OpenAPI / Swagger 或 searchKnowledgeBase(mode="openapi"),而不是优先使用 callCloudApi。

downloadRemoteFileвнешний мир

Скачивает удалённые файлы в указанный относительный путь в корне проекта. Например: изображения для Tabbar мини-программ, которые обязательно должны быть в формате **png**, можно загрузить из Unsplash, Wikimedia (обычно выбирают размер 500), Pexels, официальных ресурсов Apple UI и других источников.

下载远程文件到指定路径

Скачивает удалённые файлы в указанный относительный путь в корне проекта. Например: изображения для Tabbar мини-программ, которые обязательно должны быть в формате **png**, можно загрузить из Unsplash, Wikimedia (обычно выбирают размер 500), Pexels, официальных ресурсов Apple UI и других источников.

Параметры

  • urlstringобязательный

    远程文件的 URL 地址

  • relativePathstringобязательный

    相对于项目根目录的路径,例如:'assets/images/logo.png' 或 'docs/api.md'。不允许使用 ../ 等路径遍历操作。

downloadTemplateвнешний мир

自动下载并部署 CloudBase 项目模板。 **注意**:当用户请求使用 CloudBase 模板创建新项目时,请调用此工具。 支持的模板: - react: React + CloudBase 全栈应用模板 - vue: Vue + CloudBase 全栈应用模板 - miniprogram: 微信小程序 + 云开发模板 - uniapp: UniApp + CloudBase 跨端应用模板 - rules: 只包含 AI 编辑器配置文件(包含 Cursor、WindSurf、CodeBuddy 等所有主流编辑器配置),适合在已有项目中补充 AI 编辑器配置 支持的 IDE 类型: - all: 下载所有 IDE 配置 - cursor: Cursor AI 编辑器 - 其他 IDE 类型见下方列表 注意:如果未传入 ide 参数且无法从环境变量检测到 IDE,将提示错误并要求传入 ide 参数 - windsurf: WindSurf AI 编辑器 - codebuddy: CodeBuddy AI 编辑器 - claude-code: Claude Code AI 编辑器 - cline: Cline AI 编辑器 - gemini-cli: Gemini CLI - opencode: OpenCode AI 编辑器 - qwen-code: 通义灵码 - baidu-comate: 百度 Comate - openai-codex-cli: OpenAI Codex CLI - augment-code: Augment Code - github-copilot: GitHub Copilot - roocode: RooCode AI 编辑器 - tongyi-lingma: 通义灵码 - trae: Trae AI 编辑器 - qoder: Qoder AI 编辑器 - antigravity: Google Antigravity AI 编辑器 - vscode: Visual Studio Code - kiro: Kiro AI 编辑器 - aider: Aider AI 编辑器 特别说明: - rules 模板会自动包含当前 mcp 版本号信息(版本号:2.23.10),便于后续维护和版本追踪 - 下载 rules 模板时,如果项目中已存在 README.md 文件,系统会自动保护该文件不被覆盖(除非设置 overwrite=true)

下载项目模板

自动下载并部署 CloudBase 项目模板。 **注意**:当用户请求使用 CloudBase 模板创建新项目时,请调用此工具。 支持的模板: - react: React + CloudBase 全栈应用模板 - vue: Vue + CloudBase 全栈应用模板 - miniprogram: 微信小程序 + 云开发模板 - uniapp: UniApp + CloudBase 跨端应用模板 - rules: 只包含 AI 编辑器配置文件(包含 Cursor、WindSurf、CodeBuddy 等所有主流编辑器配置),适合在已有项目中补充 AI 编辑器配置 支持的 IDE 类型: - all: 下载所有 IDE 配置 - cursor: Cursor AI 编辑器 - 其他 IDE 类型见下方列表 注意:如果未传入 ide 参数且无法从环境变量检测到 IDE,将提示错误并要求传入 ide 参数 - windsurf: WindSurf AI 编辑器 - codebuddy: CodeBuddy AI 编辑器 - claude-code: Claude Code AI 编辑器 - cline: Cline AI 编辑器 - gemini-cli: Gemini CLI - opencode: OpenCode AI 编辑器 - qwen-code: 通义灵码 - baidu-comate: 百度 Comate - openai-codex-cli: OpenAI Codex CLI - augment-code: Augment Code - github-copilot: GitHub Copilot - roocode: RooCode AI 编辑器 - tongyi-lingma: 通义灵码 - trae: Trae AI 编辑器 - qoder: Qoder AI 编辑器 - antigravity: Google Antigravity AI 编辑器 - vscode: Visual Studio Code - kiro: Kiro AI 编辑器 - aider: Aider AI 编辑器 特别说明: - rules 模板会自动包含当前 mcp 版本号信息(版本号:2.23.10),便于后续维护和版本追踪 - 下载 rules 模板时,如果项目中已存在 README.md 文件,系统会自动保护该文件不被覆盖(除非设置 overwrite=true)

Параметры

  • templateenumобязательный

    要下载的模板类型

    reactvueminiprogramuniapprules
  • ideenumобязательный

    指定要下载的IDE类型。

    allcursorwindsurfcodebuddyclaude-codeclinegemini-cliopencodeqwen-codebaidu-comateopenai-codex-cliaugment-codegithub-copilotroocodetongyi-lingmatraeqoderantigravityvscodekiroaideriflow-cli
  • overwriteboolean

    是否覆盖已存在的文件,默认为false(不覆盖)

envDomainManagementвнешний мир

Управляет безопасными доменами CloudBase (безопасные домены / CORS-белый список), поддерживает добавление и удаление (исходные имена инструментов: createEnvDomain/deleteEnvDomain, можно продолжать использовать их для совместимости со старыми AI-правилами). Когда веб-приложение в браузере должно обращаться к ресурсам CloudBase напрямую из локального Vite / dev server, сначала проверь через queryEnv(action=domains), есть ли в белом списке host:port, соответствующий текущему origin браузера, затем добавь именно это значение. После добавления или удаления обычно нужно продолжать опрашивать queryEnv(action=domains), чтобы убедиться, что состояние сходится; безопасные домены обычно вступают в силу примерно через 10 минут. ⚠️ Важно: этот инструмент используется только для проверки CORS/источника запросов и не имеет отношения к SSL-сертификатам. Для привязки пользовательского домена для HTTPS-доступа из публичной сети используй manageGateway(action="bindCustomDomain").

CloudBase 环境域名管理(安全域名 / CORS 白名单)

Управляет безопасными доменами CloudBase (безопасные домены / CORS-белый список), поддерживает добавление и удаление (исходные имена инструментов: createEnvDomain/deleteEnvDomain, можно продолжать использовать их для совместимости со старыми AI-правилами). Когда веб-приложение в браузере должно обращаться к ресурсам CloudBase напрямую из локального Vite / dev server, сначала проверь через queryEnv(action=domains), есть ли в белом списке host:port, соответствующий текущему origin браузера, затем добавь именно это значение. После добавления или удаления обычно нужно продолжать опрашивать queryEnv(action=domains), чтобы убедиться, что состояние сходится; безопасные домены обычно вступают в силу примерно через 10 минут. ⚠️ Важно: этот инструмент используется только для проверки CORS/источника запросов и не имеет отношения к SSL-сертификатам. Для привязки пользовательского домена для HTTPS-доступа из публичной сети используй manageGateway(action="bindCustomDomain").

Параметры

  • actionenumобязательный

    操作类型:create=添加安全域名,delete=删除安全域名

    createdelete
  • domainsstring[]обязательный

    安全域名数组(格式:host:port,例如 localhost:5173 或 127.0.0.1:4173)。注意:不是自定义域名,不需要证书。

envQueryтолько чтениевнешний мир

Запрашивает информацию о среде CloudBase. Поддерживает список сред, детали указанной среды и домены безопасности. (Прежние названия: envQuery, listEnvs, getEnvInfo, getEnvAuthDomains). Если action=list, то выполняется список/фильтрация по семантике DescribeEnvs. Стандартные поля возврата: EnvId, Alias, Status, EnvType, Region, PackageId, PackageName, IsDefault. Допускается обрезка этих полей через белый список fields. При aliasExact=true выполняется точный поиск по псевдониму, чтобы среды с похожим префиксом не ошибочно попадали в кандидаты. Даже если передан envId, при action=list возвращается только сводка, без полного списка ресурсов или expiry. Для получения подробной информации (включая поля ресурсов и данные о тарификации) об известной среде по EnvId необходимо использовать action=info и передать параметр envId целевой среды. При action=info, когда это возможно, дополняется BillingInfo (поля тарификации: ExpireTime, PayMode, IsAutoRenew и т.д.). 🔍 action=info также выводит три производных поля для выбора бэкенда: - `EnvInfo.RuntimeMode`: 'postgresql' или 'nosql' — указывает, какой бэкенд рекомендуется использовать по умолчанию для новых проектов (postgresql, если PostgreSQL уже подключён, иначе nosql). - `EnvInfo.RuntimeBackends`: три булевых значения `{postgresql, nosql, mysql}` — описывает, какие бэкенды фактически сосуществуют в текущей среде. - `EnvInfo.RuntimeModeHints`: подсказки по API/инструментам/skill для каждого бэкенда. Перед написанием кода для бизнес-логики, управления доступом или хранения данных AI обязан сначала просмотреть эти три поля: в PG-режиме для новых проектов рекомендуется использовать `app.rdb()` + RLS (выполнить `CREATE POLICY` через `managePgDatabase action=execute`) + pgstore; существующие коллекции NoSQL / старое storage / `managePermissions(resourceType="noSqlDatabase")` в PG-среде по-прежнему работают. Действительно неприменим только MySQL: когда `RuntimeBackends.mysql === false`, не следует использовать `manageMysqlDatabase`, `queryMysqlDatabase` и навык `relational-database-tool`.

CloudBase 环境查询

Запрашивает информацию о среде CloudBase. Поддерживает список сред, детали указанной среды и домены безопасности. (Прежние названия: envQuery, listEnvs, getEnvInfo, getEnvAuthDomains). Если action=list, то выполняется список/фильтрация по семантике DescribeEnvs. Стандартные поля возврата: EnvId, Alias, Status, EnvType, Region, PackageId, PackageName, IsDefault. Допускается обрезка этих полей через белый список fields. При aliasExact=true выполняется точный поиск по псевдониму, чтобы среды с похожим префиксом не ошибочно попадали в кандидаты. Даже если передан envId, при action=list возвращается только сводка, без полного списка ресурсов или expiry. Для получения подробной информации (включая поля ресурсов и данные о тарификации) об известной среде по EnvId необходимо использовать action=info и передать параметр envId целевой среды. При action=info, когда это возможно, дополняется BillingInfo (поля тарификации: ExpireTime, PayMode, IsAutoRenew и т.д.). 🔍 action=info также выводит три производных поля для выбора бэкенда: - `EnvInfo.RuntimeMode`: 'postgresql' или 'nosql' — указывает, какой бэкенд рекомендуется использовать по умолчанию для новых проектов (postgresql, если PostgreSQL уже подключён, иначе nosql). - `EnvInfo.RuntimeBackends`: три булевых значения `{postgresql, nosql, mysql}` — описывает, какие бэкенды фактически сосуществуют в текущей среде. - `EnvInfo.RuntimeModeHints`: подсказки по API/инструментам/skill для каждого бэкенда. Перед написанием кода для бизнес-логики, управления доступом или хранения данных AI обязан сначала просмотреть эти три поля: в PG-режиме для новых проектов рекомендуется использовать `app.rdb()` + RLS (выполнить `CREATE POLICY` через `managePgDatabase action=execute`) + pgstore; существующие коллекции NoSQL / старое storage / `managePermissions(resourceType="noSqlDatabase")` в PG-среде по-прежнему работают. Действительно неприменим только MySQL: когда `RuntimeBackends.mysql === false`, не следует использовать `manageMysqlDatabase`, `queryMysqlDatabase` и навык `relational-database-tool`.

Параметры

  • actionenumобязательный

    查询类型:list=环境列表/摘要筛选(按 DescribeEnvs 语义筛选,支持通过 envId 筛选,返回 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault,不支持 expiry),info=指定环境的详细信息(必须传入 envId,返回资源字段和计费信息),domains=安全域名列表

    listinfodomains
  • aliasstring

    按环境别名筛选。action=list 时可选

  • aliasExactboolean

    按环境别名精确筛选。action=list 时可选;与 alias 配合使用

  • envIdstring

    按环境 ID 筛选。action=list 时可选(仅按 DescribeEnvs 语义做筛选,仍返回摘要);action=info 时必填(返回该环境的详细信息,包含资源字段和计费信息)。如果任务已经给出了明确的 EnvId 并要求查询详情,请直接使用 action=info + envId,而不是 action=list

  • limitinteger

    返回数量上限。action=list 时可选

  • offsetinteger

    分页偏移。action=list 时可选

  • fieldsstring[]

    返回字段白名单。仅支持 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault。action=list 时可选

manageAgentsвнешний мир

Единая точка входа для записи в домен CloudBase Agent. Поддерживает создание, обновление и удаление удаленных агентов.

管理 CloudBase Agent

Единая точка входа для записи в домен CloudBase Agent. Поддерживает создание, обновление и удаление удаленных агентов.

Параметры

  • actionenumобязательный
    createAgentupdateAgentdeleteAgent
  • agentIdstring
  • namestring
  • descriptionstring
  • runtimestring
  • timeoutnumber
  • memorySizenumber
  • installDependencyboolean
  • zipFilestring
  • cosBucketRegionstring
  • tempCosObjectNamestring
  • sessionConfigobject
  • cwdstring
  • paramsobject
manageAppAuthвнешний мир

CloudBase - точка входа для настройки аутентификации на стороне приложения. Используется для изменения способа входа, provider, конфигурации client, обеспечения publishable key, а также создания или удаления API key и пользовательских ключей входа. ⚠️ Этот инструмент предназначен для администрирования и не выполняет вход пользователя. Если задача требует написать клиентский код входа (например, «войти с помощью JS SDK»), сначала выполните настройку через этот инструмент (например, включите usernamePassword, получите publishable key), а затем напишите клиентский код входа из @cloudbase/js-sdk (например, auth.signInWithPassword()) в проекте, а не используйте этот инструмент для выполнения входа. Если фронтенд должен принимать идентификаторы в стиле обычного имени пользователя, сначала выполните action=patchLoginStrategy с параметром patch={ usernamePassword: true }, а затем реализуйте соответствующую логику входа на фронтенде.

管理 CloudBase 应用认证配置

CloudBase - точка входа для настройки аутентификации на стороне приложения. Используется для изменения способа входа, provider, конфигурации client, обеспечения publishable key, а также создания или удаления API key и пользовательских ключей входа. ⚠️ Этот инструмент предназначен для администрирования и не выполняет вход пользователя. Если задача требует написать клиентский код входа (например, «войти с помощью JS SDK»), сначала выполните настройку через этот инструмент (например, включите usernamePassword, получите publishable key), а затем напишите клиентский код входа из @cloudbase/js-sdk (например, auth.signInWithPassword()) в проекте, а не используйте этот инструмент для выполнения входа. Если фронтенд должен принимать идентификаторы в стиле обычного имени пользователя, сначала выполните action=patchLoginStrategy с параметром patch={ usernamePassword: true }, а затем реализуйте соответствующую логику входа на фронтенде.

Параметры

  • actionenumобязательный
    patchLoginStrategyaddProviderupdateProviderdeleteProviderupdateClientConfigensurePublishableKeycreateApiKeydeleteApiKeycreateCustomLoginKeys
  • patchobject

    patchLoginStrategy 使用的简化登录策略 patch,如 { usernamePassword: true }

  • providerIdstring

    provider 标识,如 email、google;addProvider 时也可作为自定义 provider Id

  • providerTypeenum

    addProvider 时的 provider 协议类型

    OAUTHOIDCSAMLWX_MICRO_APPWX_QRCODE_MICRO_APPWX_CLOUDBASE_MICRO_APPWX_MPWX_OPENWX_WORK_INTERNALWX_WORK_AGENTWX_WORK_THIRD_PARTYWX_WORK_THIRD_PARTY_ASSOCIATIONCUSTOMEMAIL
  • displayNameany

    addProvider 时的展示名称,可传字符串或多语言对象

  • clientIdstring

    updateClientConfig 时的客户端 Id;省略时默认使用当前环境 ID

  • configobject

    provider / client 的配置对象

  • keyTypeenum

    createApiKey 时的 API key 类型,默认 publish_key

    publish_keyapi_key
  • keyNamestring

    createApiKey 时的 API key 名称

  • expireIninteger

    createApiKey 时的有效期,单位秒;0 表示不过期

  • keyIdstring

    deleteApiKey 时的 API key 唯一标识

manageAppsвнешний мир

部署 Web 应用到 CloudBase(构建前后端,部署到独立子域名)。 action=getUploadUrl 获取预签名上传 URL(cloud mode 下使用),返回上传地址和 cosTimestamp。 action=deployApp 上传源码 ZIP 并触发远端构建部署管道: 1. 远端 npm install(可通过 installCmd="" 跳过) 2. 远端 npm run build(可通过 buildCmd="" 跳过) 3. 远端 tcb hosting deploy 域名格式:`<serviceName>-<envId>.webapps.tcloudbase.com`(每个 serviceName 一个独立子域名) ✅ 推荐用法(新项目/需要独立域名的 Web 应用,首选此工具): 新建项目首次部署时,传 framework=static, installCmd="", buildCmd="" 跳过远端构建, 只执行 tcb hosting deploy。部署后获得独立子域名,支持版本管理。 ⚠️ 兼容性说明: - 已有项目若之前用 manageHosting 部署过(域名格式:`<envId>-<appId>.tcloudbaseapp.com`), 切换到 manageApps 会产生全新的 URL,老链接失效。请保持原部署方式不变。 - 如需判断:调用 queryHosting 检查是否已有托管文件。 与 manageHosting 对比: - manageApps(本工具,新项目首选):域名 `<serviceName>-<envId>.webapps.tcloudbase.com`,独立子域名,支持版本管理 - manageHosting(已有项目或 fallback):域名 `<envId>-<appId>.tcloudbaseapp.com/<path>`,共享环境域名 两者均可绑定自定义域名。 ⚠️ 如果 manageApps 构建失败,先用 queryApps(action="getBuildLog") 查日志;仍不行再 fallback 到 manageHosting。

部署应用到 CloudBase(独立子域名)

部署 Web 应用到 CloudBase(构建前后端,部署到独立子域名)。 action=getUploadUrl 获取预签名上传 URL(cloud mode 下使用),返回上传地址和 cosTimestamp。 action=deployApp 上传源码 ZIP 并触发远端构建部署管道: 1. 远端 npm install(可通过 installCmd="" 跳过) 2. 远端 npm run build(可通过 buildCmd="" 跳过) 3. 远端 tcb hosting deploy 域名格式:`<serviceName>-<envId>.webapps.tcloudbase.com`(每个 serviceName 一个独立子域名) ✅ 推荐用法(新项目/需要独立域名的 Web 应用,首选此工具): 新建项目首次部署时,传 framework=static, installCmd="", buildCmd="" 跳过远端构建, 只执行 tcb hosting deploy。部署后获得独立子域名,支持版本管理。 ⚠️ 兼容性说明: - 已有项目若之前用 manageHosting 部署过(域名格式:`<envId>-<appId>.tcloudbaseapp.com`), 切换到 manageApps 会产生全新的 URL,老链接失效。请保持原部署方式不变。 - 如需判断:调用 queryHosting 检查是否已有托管文件。 与 manageHosting 对比: - manageApps(本工具,新项目首选):域名 `<serviceName>-<envId>.webapps.tcloudbase.com`,独立子域名,支持版本管理 - manageHosting(已有项目或 fallback):域名 `<envId>-<appId>.tcloudbaseapp.com/<path>`,共享环境域名 两者均可绑定自定义域名。 ⚠️ 如果 manageApps 构建失败,先用 queryApps(action="getBuildLog") 查日志;仍不行再 fallback 到 manageHosting。

Параметры

  • actionenumобязательный
    deployAppgetUploadUrldeleteAppdeleteAppVersion
  • serviceNamestringобязательный

    CloudBase 应用服务名,会体现在域名中:`<serviceName>-<envId>.webapps.tcloudbase.com`。deployApp 时复用现有 serviceName 会新增一个部署版本并触发重新部署,而不是删除重建。首次部署请用新名称。

  • filePathstring

    要上传并部署的本地项目根目录绝对路径。本地模式下 deployApp 时必填;通常传源码所在目录(含 package.json 和源码),不是 dist 目录。构建产物目录请用 buildPath 指定。cloud mode 下无需传此参数,改用 cosTimestamp。

  • cosTimestampstring

    可选 COS 时间戳。传入此值则直接使用已上传的代码创建应用,跳过本地文件上传。需先调用 getUploadUrl 获取预签名 URL,上传 ZIP 包后再传此时间戳。cloud mode 下为必填;本地模式也可传此值代替 filePath。两个路径二选一:filePath(本地打包上传)或 cosTimestamp(预签名 URL 上传)。

  • appPathstring

    应用线上访问路径(hosting mount path),例如 /my-web-app。不是本地目录路径;CloudApp 已有独立子域名,省略时默认为 /(根路径)。

  • buildPathstring

    构建产物目录,相对于 filePath,例如 dist 或 build。 ⚠️ 传此值后远端构建系统会 cd 到此目录再执行 tcb hosting deploy,因此 deployCmd 会自动使用 .(当前目录)而非目录名,避免路径重复(如 dist/dist 错误)。 纯静态 HTML 如果在项目根目录可省略,但注意 deployCmd 默认用 dist。

  • frameworkenum

    前端框架类型。可选值:vue、react、next、nuxt、vite、angular、static。 即使传 static,仍会经过远端构建管道。如果本地已构建好,建议改用 manageHosting 直接上传,可完全跳过远端构建。

    vuereactnextnuxtviteangularstatic
  • nodeJsVersionstring

    构建时使用的 Node.js 版本;不传时由 CloudBase 使用默认值。

  • installCmdstring

    依赖安装命令,例如 npm install。不传时默认 npm install。本地已安装或无需安装可传空字符串 '' 跳过,但远端仍会执行 tcb hosting deploy。

  • buildCmdstring

    构建命令,例如 npm run build。不传时默认 npm run build。本地已构建好可传空字符串 '' 跳过构建步骤。若希望完全跳过远端管道,请改用 manageHosting。

  • deployCmdstring

    自定义部署命令。通常无需填写,默认自动生成 tcb hosting deploy 命令。有 buildPath 时远端已 cd 到该目录,默认用 . 作为源码路径;无 buildPath 时默认用 dist。

  • ignorestring[]

    上传时忽略的文件/目录 glob 模式,例如 **/node_modules/**。

  • versionNamestring

    要删除的历史版本名,仅 action=deleteAppVersion 时必填。

manageCloudRunвнешний мир

Управляет облачными сервисами хостинга, поддерживает в порядке разработки: инициализацию проекта (можно начать с шаблона, список шаблонов доступен через запрос queryCloudRun), загрузку кода сервиса, локальный запуск (только для сервисов на функциях), развертывание кода, удаление сервиса. При развертывании можно настроить CPU, память, количество экземпляров, тип доступа и другие параметры. Операция удаления требует подтверждения, рекомендуется установить force=true.

管理 CloudRun 服务

Управляет облачными сервисами хостинга, поддерживает в порядке разработки: инициализацию проекта (можно начать с шаблона, список шаблонов доступен через запрос queryCloudRun), загрузку кода сервиса, локальный запуск (только для сервисов на функциях), развертывание кода, удаление сервиса. При развертывании можно настроить CPU, память, количество экземпляров, тип доступа и другие параметры. Операция удаления требует подтверждения, рекомендуется установить force=true.

Параметры

  • actionenumобязательный

    云托管服务管理操作类型:init=从模板初始化新的云托管项目代码(在targetPath目录下创建以serverName命名的子目录,支持多种语言和框架模板),download=从云端下载现有服务的代码到本地进行开发,run=在本地运行函数型云托管服务(用于开发和调试,仅支持函数型服务),deploy=将本地代码部署到云端云托管服务(支持函数型和容器型),delete=删除指定的云托管服务(不可恢复,需要确认),createAgent=创建函数型Agent(基于函数型云托管开发AI智能体)

    initdownloadrundeploydeletecreateAgent
  • serverNamestringобязательный

    云托管服务名称,用于标识和管理服务。命名规则:支持大小写字母、数字、连字符和下划线,必须以字母开头,长度3-45个字符。在init操作中会作为在targetPath下创建的子目录名,在其他操作中作为目标服务名

  • targetPathstring

    本地代码路径,必须是绝对路径。在deploy操作中指定要部署的代码目录,在download操作中指定下载目标目录,在init操作中指定云托管服务的上级目录(会在该目录下创建以serverName命名的子目录)。建议约定:项目根目录下的cloudrun/目录,例如:/Users/username/projects/my-project/cloudrun

  • serverConfigobject

    服务配置项,用于部署时设置服务的运行参数。包括资源规格、访问权限、环境变量、日志、网络等配置。不提供时使用默认配置

  • templatestring

    项目模板标识符,用于指定初始化项目时使用的模板。可通过queryCloudRun的templates操作获取可用模板列表。常用模板:helloworld=Hello World示例,nodejs=Node.js项目模板,python=Python项目模板等

  • runOptionsobject

    本地运行参数配置,仅函数型云托管服务支持。用于配置本地开发环境的运行参数,不影响云端部署

  • agentConfigobject

    Agent配置项,仅在createAgent操作时使用

  • forceboolean

    强制操作开关,用于跳过确认提示。默认false(需要确认),设置为true时跳过所有确认步骤。删除操作时强烈建议设置为true以避免误操作

  • serverTypeenum

    服务类型配置:function=函数型云托管(仅支持Node.js,有特殊的开发要求和限制,适合简单的API服务),container=容器型服务(推荐使用,支持任意语言和框架如Java/Go/Python/PHP/.NET等,适合大多数应用场景)。不提供时自动检测:1)现有服务类型 2)有Dockerfile→container 3)有@cloudbase/aiagent-framework依赖→function 4)其他情况→container

    functioncontainer
manageDataModelтолько чтениевнешний мир

Инструмент для запросов к моделям данных, поддерживает получение списка и детальный запрос (только чтение). Тип операции задаётся параметром action: list — получить список моделей (без схемы, можно отфильтровать через параметр names), get — получить детали одной модели (содержит список полей схемы, форматы, связи и другое, требуется name), docs — сгенерировать SDK-документацию (требуется name).

数据模型管理

Инструмент для запросов к моделям данных, поддерживает получение списка и детальный запрос (только чтение). Тип операции задаётся параметром action: list — получить список моделей (без схемы, можно отфильтровать через параметр names), get — получить детали одной модели (содержит список полей схемы, форматы, связи и другое, требуется name), docs — сгенерировать SDK-документацию (требуется name).

Параметры

  • actionenumобязательный

    操作类型:get=查询单个模型(含Schema字段列表、格式、关联关系,需要提供 name 参数),list=获取模型列表(不含Schema,可选 names 参数过滤),docs=生成SDK使用文档(需要提供 name 参数)

    getlistdocs
  • namestring

    要查询的数据模型名称。当 action='get' 或 action='docs' 时,此参数为必填项,必须提供已存在的数据模型名称。可通过 action='list' 操作获取可用的模型名称列表

  • namesstring[]

    模型名称数组(list操作时可选,用于过滤)

manageEnvвнешний мир

Управляет окружениями CloudBase. Поддерживает: listPackages — запрос списка доступных тарифов, create — создание нового окружения (нужно подтверждение), modifyPlan — смена тарифа (апгрейд/даунгрейд, нужно подтверждение), renew — продление окружения (нужно подтверждение). ⚠️ Все платные операции (create/modifyPlan/renew) перед выполнением обязательно показывают сводку по конфигурации и ждут, пока пользователь подтвердит командой confirm="yes".

CloudBase 环境管理(创建/变配/续费)

Управляет окружениями CloudBase. Поддерживает: listPackages — запрос списка доступных тарифов, create — создание нового окружения (нужно подтверждение), modifyPlan — смена тарифа (апгрейд/даунгрейд, нужно подтверждение), renew — продление окружения (нужно подтверждение). ⚠️ Все платные операции (create/modifyPlan/renew) перед выполнением обязательно показывают сводку по конфигурации и ждут, пока пользователь подтвердит командой confirm="yes".

Параметры

  • actionenumобязательный

    操作类型:listPackages=查询可选套餐,create=创建环境,modifyPlan=变更套餐,renew=续费

    listPackagescreatemodifyPlanrenew
  • aliasstring

    环境别名(action=create 时必填)。要求:小写字母/数字/减号,不能以减号开头或结尾,最长 20 位

  • packageIdstring

    套餐 ID(action=create/modifyPlan 时必填)。可选值如 baas_personal(个人版)、baas_pf_standard(标准版)、baas_pf_enterprise(企业版)

  • regionstring

    环境地域(action=create 时可选)。默认 ap-shanghai,可选 ap-guangzhou、ap-beijing 等

  • resourcesstring[]

    启用的资源类型(action=create 时可选)。默认启用全部四项:flexdb(文档数据库)、storage(存储)、function(云函数)、postgresql(PostgreSQL 数据库)

  • durationinteger

    购买或续费时长(月),action=create/renew 时可选,默认 1

  • envIdstring

    环境 ID(action=modifyPlan/renew 时必填)

  • confirmstring

    确认操作。所有付费操作(create/modifyPlan/renew)必须传 "yes" 确认

manageFunctionsвнешний мир

CloudBase 云函数 единая точка входа для записи. Поддерживает создание функций, обновление кода, обновление конфигурации, вызов функций, управление таймерными триггерами для запланированных задач / cron-задач / scheduled job, а также привязку слоёв. Чтобы создать cron-задачу, сначала создайте функцию с помощью createFunction, затем создайте таймерный триггер с помощью createFunctionTrigger (поддерживается 7-сегментное cron-выражение), а для удаления триггера используйте deleteFunctionTrigger. Развёртывание образов (Runtime=CustomImage): сначала упакуйте код через zip → COS → custom-сборка CloudApp → отправка образа в TCR (этот этап выполняется через чистые Tencent Cloud API, данный инструмент их не покрывает), затем создайте HTTP-функцию на основе образа TCR с помощью createFunction(func.runtime="CustomImage", imageConfig); для последующих итераций используйте updateFunctionCode + imageConfig, чтобы сменить тег образа. Опасные операции требуют явного confirm=true.

管理 CloudBase 云函数

CloudBase 云函数 единая точка входа для записи. Поддерживает создание функций, обновление кода, обновление конфигурации, вызов функций, управление таймерными триггерами для запланированных задач / cron-задач / scheduled job, а также привязку слоёв. Чтобы создать cron-задачу, сначала создайте функцию с помощью createFunction, затем создайте таймерный триггер с помощью createFunctionTrigger (поддерживается 7-сегментное cron-выражение), а для удаления триггера используйте deleteFunctionTrigger. Развёртывание образов (Runtime=CustomImage): сначала упакуйте код через zip → COS → custom-сборка CloudApp → отправка образа в TCR (этот этап выполняется через чистые Tencent Cloud API, данный инструмент их не покрывает), затем создайте HTTP-функцию на основе образа TCR с помощью createFunction(func.runtime="CustomImage", imageConfig); для последующих итераций используйте updateFunctionCode + imageConfig, чтобы сменить тег образа. Опасные операции требуют явного confirm=true.

Параметры

  • actionenumобязательный

    写操作类型,例如 createFunction、updateFunctionCode、incrementalDeployFunction、invokeFunction、deleteFunction、createFunctionTrigger(定时任务 / cron / timer)、deleteFunctionTrigger、attachLayer、detachLayer

    createFunctionupdateFunctionCodeupdateFunctionConfiginvokeFunctiondeleteFunctioncreateFunctionTriggerdeleteFunctionTriggercreateLayerVersiondeleteLayerVersionattachLayerdetachLayerupdateFunctionLayersincrementalDeployFunction
  • funcobject

    createFunction 操作的函数配置

  • functionRootPathstring

    创建或更新函数代码时默认推荐的本地目录方式。必须是直接包含函数文件夹的目录绝对路径(如 /abs/path/cloudfunctions 或 /abs/path/functions),不要传项目根目录(如 /abs/path),也不要传到函数名子目录(如 /abs/path/cloudfunctions/hello)。本地应按 cloudfunctions/<functionName>/index.js 或 functions/<functionName>/index.js 布局,此参数传 cloudfunctions 或 functions 目录的绝对路径。SDK 会自动拼接函数名子目录,无需预先压缩 zip 或 base64 编码。

  • forceboolean

    createFunction 时是否覆盖

  • functionNamestring

    函数名称。大多数 action 使用该字段作为统一目标

  • zipFilestring

    仅兼容特殊场景:预先准备好的代码包 base64 编码。普通 createFunction/updateFunctionCode 默认不要先压缩 zip,优先使用 functionRootPath。

  • handlerstring

    函数入口

  • timeoutnumber

    配置更新时的超时时间

  • envVariablesobject

    配置更新时要合并的环境变量

  • vpcany

    配置更新时的 VPC 信息

  • paramsobject

    invokeFunction 的调用参数

  • triggersarray

    createFunctionTrigger 的触发器列表,用于定时跑 / 定时任务 / scheduled job。timer 触发器使用7段 cron 表达式(秒 分 时 日 月 星期 年),如 "0 */5 * * * * *" 表示每5分钟执行一次

  • triggerNamestring

    deleteFunctionTrigger 的目标触发器名称

  • layerNamestring

    层名称

  • layerVersionnumber

    层版本号

  • contentPathstring

    层内容路径,可为目录或 ZIP 文件

  • base64Contentstring

    层内容的 base64 编码

  • runtimesstring[]

    层适用的运行时列表

  • descriptionstring

    层版本描述

  • licenseInfostring

    层许可证信息

  • layersobject[]

    updateFunctionLayers 的目标层列表,顺序即最终顺序

  • codeSecretstring

    层绑定时的代码保护密钥

  • imageConfigany

    镜像部署配置(Runtime=CustomImage)。createFunction 时基于 TCR 镜像创建 HTTP 函数,updateFunctionCode 时仅更换镜像 tag。需提供 imageUri(含 tag),企业版 TCR 还需 registryId。也可在 func.imageConfig 中提供;两处都传时以顶层 imageConfig 优先。

  • confirmboolean

    危险操作确认开关。deleteFunction、deleteFunctionTrigger、deleteLayerVersion、detachLayer 等删除类操作需要显式传入 confirm=true

  • incrementalFilestring

    incrementalDeployFunction 增量部署时的变更文件路径

manageGatewayвнешний мир

CloudBase 网关统一写入口。通过 action 创建目标访问入口,后续承接更通用的网关配置能力。为已存在的 HTTP 云函数补默认域名访问时,通常使用 createAccess 并提供 targetType="function"、targetName、type="HTTP" 与期望 path。注意 createAccess 只创建网关入口,不会自动修改函数资源权限。⚠️ 如需绑定带 SSL 证书的自定义域名供公网 HTTPS 访问,使用 action="bindCustomDomain"(需要 domain 和 certificateId 参数);如需配置 CORS/安全域名(无证书),请使用 envDomainManagement 工具。

管理 CloudBase 网关

CloudBase 网关统一写入口。通过 action 创建目标访问入口,后续承接更通用的网关配置能力。为已存在的 HTTP 云函数补默认域名访问时,通常使用 createAccess 并提供 targetType="function"、targetName、type="HTTP" 与期望 path。注意 createAccess 只创建网关入口,不会自动修改函数资源权限。⚠️ 如需绑定带 SSL 证书的自定义域名供公网 HTTPS 访问,使用 action="bindCustomDomain"(需要 domain 和 certificateId 参数);如需配置 CORS/安全域名(无证书),请使用 envDomainManagement 工具。

Параметры

  • actionenumобязательный

    写操作类型,例如 createAccess。为已有函数补默认域名访问入口时使用 createAccess;若 action=createAccess 且 targetType=function,必须显式提供 type。

    createAccesscreateRouteupdateRoutedeleteRoutebindCustomDomaindeleteCustomDomaindeleteAccessupdatePathAuth
  • targetTypeenum

    目标资源类型。当前支持 function,后续可扩展

    function
  • targetNamestring

    目标资源名称。createAccess 到云函数时填写函数名

  • pathstring

    访问路径,默认 /{targetName}。例如为 HTTP 函数暴露 /api/hello 时传 /api/hello。该参数只创建网关入口,不会自动放开函数资源权限。

  • typeenum

    目标函数的运行时类型,不是接入协议。createAccess 到已创建的 HTTP 云函数时传 HTTP;给 Event 函数补网关访问时传 Event 或省略。省略会默认按 Event 路由处理,可能让 HTTP 云函数访问后返回 FUNCTION_PARAM_INVALID。

    EventHTTP
  • authboolean

    是否开启网关路径鉴权。若要走默认域名做匿名或浏览器访问,通常设为 false;该开关仅控制网关入口本身,不会修改函数资源权限,仍需检查并按需调整函数安全规则。

  • routeobject

    HTTP 路由配置对象

  • domainstring

    自定义域名

  • certificateIdstring

    证书 ID

  • accessNamestring

    访问入口名称,保留字段

  • accessIdstring

    访问入口 ID。deleteAccess 时可直接传入,避免参数歧义

manageHostingвнешний мир

Управляет изменениями статического хостинга CloudBase. `action=upload` — загрузить собранные локально артефакты на общий домен (формат домена: `<envId>-<appId>.tcloudbaseapp.com/<cloudPath>`). `action=delete` — удалить файл или каталог хостинга (обязательно `confirm=true`). `action=setWebsiteDocument` — задать индексную страницу, страницу ошибки или правила маршрутизации. `action=enableService` — включить статический хостинг. `action=bindDomain / unbindDomain / updateDomain` — управлять кастомными доменами. `action=downloadFile / downloadDirectory` — скачать содержимое хостинга локально. ⚠️ Для новых проектов в первую очередь используйте `manageApps` (развёртывание на отдельный поддомен). Этот инструмент подходит для продолжения работы со старыми проектами или как fallback для `manageApps`. Домены `manageApps` и `manageHosting` различаются — переход приведёт к тому, что старые ссылки перестанут работать. Если задача — просто посмотреть конфигурацию, файлы или статус домена, используйте `queryHosting`.

管理 CloudBase 静态托管

Управляет изменениями статического хостинга CloudBase. `action=upload` — загрузить собранные локально артефакты на общий домен (формат домена: `<envId>-<appId>.tcloudbaseapp.com/<cloudPath>`). `action=delete` — удалить файл или каталог хостинга (обязательно `confirm=true`). `action=setWebsiteDocument` — задать индексную страницу, страницу ошибки или правила маршрутизации. `action=enableService` — включить статический хостинг. `action=bindDomain / unbindDomain / updateDomain` — управлять кастомными доменами. `action=downloadFile / downloadDirectory` — скачать содержимое хостинга локально. ⚠️ Для новых проектов в первую очередь используйте `manageApps` (развёртывание на отдельный поддомен). Этот инструмент подходит для продолжения работы со старыми проектами или как fallback для `manageApps`. Домены `manageApps` и `manageHosting` различаются — переход приведёт к тому, что старые ссылки перестанут работать. Если задача — просто посмотреть конфигурацию, файлы или статус домена, используйте `queryHosting`.

Параметры

  • actionenumобязательный

    管理类型:upload=上传本地构建产物到静态托管,delete=删除静态托管文件或目录,setWebsiteDocument=设置首页/错误页/路由规则,enableService=开通静态托管服务,bindDomain=绑定自定义域名,unbindDomain=解绑自定义域名,updateDomain=更新域名缓存/防盗链/IP 规则,downloadFile=下载单个托管文件到本地,downloadDirectory=下载托管目录到本地。

    uploaddeletesetWebsiteDocumentenableServicebindDomainunbindDomainupdateDomaindownloadFiledownloadDirectory
  • localPathstring

    本地路径。action=upload 时表示要上传的本地文件/目录路径;action=downloadFile 或 downloadDirectory 时表示下载到本地的目标路径。建议传绝对路径。

  • cloudPathstring

    静态托管中的目标路径。action=upload 时表示上传后的托管路径;action=delete/downloadFile/downloadDirectory 时表示托管侧文件或目录路径。

  • filesobject[]

    多文件上传配置。仅 action=upload 时可选;传入后会逐项上传,不再依赖单个 localPath/cloudPath。

  • ignoreany

    上传时忽略的文件模式。仅 action=upload 时可选,例如 node_modules 或 ["**/*.map", "**/.DS_Store"]。

  • isDirboolean

    是否把 cloudPath 视为目录。仅 action=delete 时使用;true=删除目录,false=删除单个文件。

  • confirmboolean

    高风险操作确认开关。action=delete 和 action=unbindDomain 时必须显式传 true,避免误删文件或误解绑域名。

  • indexDocumentstring

    网站首页文档名称。仅 action=setWebsiteDocument 时必填,例如 index.html。

  • errorDocumentstring

    错误页文档名称。仅 action=setWebsiteDocument 时可选,例如 404.html。

  • routingRulesobject[]

    网站路由规则列表。仅 action=setWebsiteDocument 时可选。SPA 常见配置是将 404 重写到 index.html。

  • domainstring

    自定义域名。action=bindDomain / unbindDomain / updateDomain 时使用,例如 www.example.com。

  • certIdstring

    证书 ID。仅 action=bindDomain 时必填。

  • domainIdnumber

    域名 ID。仅 action=updateDomain 时必填,用于精确更新指定域名配置。

  • domainConfigobject

    域名配置。仅 action=updateDomain 时必填,支持缓存、Referer、防盗链、IP 规则与频控。

manageMysqlDatabaseвнешний мир

Управляет ресурсами базы данных CloudBase MySQL. Поддерживает создание MySQL, удаление MySQL, выполнение запросов SQL/DDL на запись, а также инициализацию схемы базы данных. Примечание: сначала необходимо создать MySQL (action=provisionMySQL, confirm=true), прежде чем выполнять runStatement или initializeSchema. Если MySQL ещё не создан, инструмент вернёт MYSQL_NOT_CREATED и подсказку с nextAction для создания.

管理 CloudBase MySQL 数据库生命周期或执行写入 SQL

Управляет ресурсами базы данных CloudBase MySQL. Поддерживает создание MySQL, удаление MySQL, выполнение запросов SQL/DDL на запись, а также инициализацию схемы базы данных. Примечание: сначала необходимо создать MySQL (action=provisionMySQL, confirm=true), прежде чем выполнять runStatement или initializeSchema. Если MySQL ещё не создан, инструмент вернёт MYSQL_NOT_CREATED и подсказку с nextAction для создания.

Параметры

  • actionenumобязательный

    provisionMySQL=create MySQL instance; destroyMySQL=destroy MySQL instance; runStatement=execute write SQL or DDL; initializeSchema=run ordered schema initialization statements

    provisionMySQLdestroyMySQLrunStatementinitializeSchema
  • confirmboolean

    Explicit confirmation required for action=provisionMySQL or action=destroyMySQL

  • sqlstring

    SQL statement used by action=runStatement

  • requestobject

    Official request payload used by action=provisionMySQL or action=destroyMySQL

  • statementsstring[]

    Ordered schema initialization SQL statements used by action=initializeSchema

  • requireReadyboolean

    Whether initializeSchema should block until MySQL is confirmed ready. Defaults to true.

  • statusContextobject

    Optional provisioning status requests used to confirm readiness before initializeSchema

  • dbInstanceobject

    Optional SQL database instance context for runStatement/initializeSchema

managePermissionsвнешний мир

Управляет правами и пользовательскими конфигурациями CloudBase, поддерживает изменение разрешений ресурсов (базы данных/облачные функции/хранилища и т.д.), управление ролями, добавление/удаление участников и политик, CRUD пользователей приложений. Примеры: - Сделать корзину приватной: `action="updateResourcePermission", resourceType="storage", resourceId="bucket-name", permission="PRIVATE"` - Создать роль: `action="createRole", roleName="admin", roleIdentity="admin"` Внимание: `createUser` / `updateUser` — это управление пользователями приложения на стороне окружения, подходит для тестовых учётных записей, администраторов или предустановленных пользователей. Не заменяет форму регистрации Web SDK в браузере. Для регистрации с логином и паролем на клиенте используйте `auth.signUp({ username, password })`, для входа — `auth.signInWithPassword({ username, password })`. Создание пользователей с логином и паролем напрямую в браузере через `auth.signUp` зависит от поддержки SDK/провайдера — перед использованием обязательно проверьте. Если не поддерживается, используйте бэкенд или административную границу, не раскрывайте ключи в браузере. Семантика `securityRule` зависит от `resourceType`: `doc._openid`, `auth.openid`, проверка подмножества условий запроса, а шаблоны JSON для `create`/`update`/`delete` применимы только к правилам безопасности документной базы данных с `resourceType="noSqlDatabase"`. При настройке `function` или `storage` обращайтесь к официальной документации по правилам безопасности соответствующего ресурса, не копируйте шаблоны NoSQL. 📌 Подсказка для границ между бэкендами: перед вызовом используйте `envQuery(action="info", envId=...)`, чтобы проверить `EnvInfo.RuntimeBackends`: - `resourceType="noSqlDatabase"` действует только на коллекции CloudBase NoSQL документной базы данных. Права на уровне строк таблиц CloudBase PostgreSQL (PG) **не** управляются этим — для таблиц PG используйте RLS: `managePgDatabase(action="execute", confirm=true)` для выполнения `ALTER TABLE ... ENABLE ROW LEVEL SECURITY` и `CREATE POLICY ...`. Если в том же PG-окружении есть коллекции NoSQL, для них по-прежнему используйте правила `noSqlDatabase` — это корректно. (Не "PG-окружение отключает этот инструмент".) - `resourceType="storage"` управляет ACL корзин NoSQL/COS; корзина `pgstore` в PG не попадает под этот `resourceType`. - Данный инструмент не затрагивает MySQL; права доступа к MySQL задавайте через собственные операторы GRANT/REVOKE (через `manageMysqlDatabase`).

管理 CloudBase 权限与用户配置

Управляет правами и пользовательскими конфигурациями CloudBase, поддерживает изменение разрешений ресурсов (базы данных/облачные функции/хранилища и т.д.), управление ролями, добавление/удаление участников и политик, CRUD пользователей приложений. Примеры: - Сделать корзину приватной: `action="updateResourcePermission", resourceType="storage", resourceId="bucket-name", permission="PRIVATE"` - Создать роль: `action="createRole", roleName="admin", roleIdentity="admin"` Внимание: `createUser` / `updateUser` — это управление пользователями приложения на стороне окружения, подходит для тестовых учётных записей, администраторов или предустановленных пользователей. Не заменяет форму регистрации Web SDK в браузере. Для регистрации с логином и паролем на клиенте используйте `auth.signUp({ username, password })`, для входа — `auth.signInWithPassword({ username, password })`. Создание пользователей с логином и паролем напрямую в браузере через `auth.signUp` зависит от поддержки SDK/провайдера — перед использованием обязательно проверьте. Если не поддерживается, используйте бэкенд или административную границу, не раскрывайте ключи в браузере. Семантика `securityRule` зависит от `resourceType`: `doc._openid`, `auth.openid`, проверка подмножества условий запроса, а шаблоны JSON для `create`/`update`/`delete` применимы только к правилам безопасности документной базы данных с `resourceType="noSqlDatabase"`. При настройке `function` или `storage` обращайтесь к официальной документации по правилам безопасности соответствующего ресурса, не копируйте шаблоны NoSQL. 📌 Подсказка для границ между бэкендами: перед вызовом используйте `envQuery(action="info", envId=...)`, чтобы проверить `EnvInfo.RuntimeBackends`: - `resourceType="noSqlDatabase"` действует только на коллекции CloudBase NoSQL документной базы данных. Права на уровне строк таблиц CloudBase PostgreSQL (PG) **не** управляются этим — для таблиц PG используйте RLS: `managePgDatabase(action="execute", confirm=true)` для выполнения `ALTER TABLE ... ENABLE ROW LEVEL SECURITY` и `CREATE POLICY ...`. Если в том же PG-окружении есть коллекции NoSQL, для них по-прежнему используйте правила `noSqlDatabase` — это корректно. (Не "PG-окружение отключает этот инструмент".) - `resourceType="storage"` управляет ACL корзин NoSQL/COS; корзина `pgstore` в PG не попадает под этот `resourceType`. - Данный инструмент не затрагивает MySQL; права доступа к MySQL задавайте через собственные операторы GRANT/REVOKE (через `manageMysqlDatabase`).

Параметры

  • actionenumобязательный
    updateResourcePermissioncreateRoleupdateRoledeleteRolesaddRoleMembersremoveRoleMembersaddRolePoliciesremoveRolePoliciescreateUserupdateUserdeleteUsers
  • resourceTypeenum

    目标资源类型。`securityRule` 的具体语义依赖这个值;`noSqlDatabase` 使用集合安全规则,`function` 与 `storage` 也有各自独立的安全规则语义,不要套用 NoSQL 规则语法。

    noSqlDatabasesqlDatabasefunctionstorage
  • resourceIdstring
  • permissionenum
    READONLYPRIVATEADMINWRITEADMINONLYCUSTOM
  • securityRulestring

    资源类型特定的规则内容,详细语义依赖 `resourceType`。当 `resourceType="noSqlDatabase"` 且 `permission="CUSTOM"` 时,应传文档数据库安全规则 JSON(文档型数据库规则:`https://docs.cloudbase.net/database/security-rules`);键通常为 `read` / `create` / `update` / `delete`,值为表达式。重要:`create` 规则验证写入数据,此时文档尚不存在,不能使用 `doc.*`;`read` / `update` / `delete` 规则可使用 `doc.*` 引用已有文档字段。不要把 `doc._openid`、`auth.openid`、查询条件子集校验或 `create` / `update` / `delete` 模板误用于 `function`、`storage` 或 `sqlDatabase`。如需配置 `function` 或 `storage`,请改查官方安全规则文档:云函数 `https://docs.cloudbase.net/cloud-function/security-rules`,云存储 `https://docs.cloudbase.net/storage/security-rules`。示例:{"read":"auth.uid != null","create":"auth.uid != null && auth.loginType != "ANONYMOUS"","update":"auth.uid != null && doc._openid == auth.openid","delete":"auth.uid != null && doc._openid == auth.openid"}

  • roleIdstring
  • roleIdsstring[]
  • roleNamestring
  • roleIdentitystring

    角色标识符(字母/数字/_-:@.),action=createRole 时必填,用于程序化引用角色

  • descriptionstring
  • memberUidsstring[]
  • policiesobject[]
  • policyIdsstring[]

    策略 ID 列表(当前不支持直接按 ID 绑定,请改传 policies 详情对象)

  • uidstring
  • uidsstring[]
  • usernamestring
  • passwordstring
  • userStatusenum
    ACTIVEBLOCKED
managePgDatabaseвнешний мир

Управление CloudBase PostgreSQL: выполнение подтверждённых SQL-запросов на запись или DDL, предварительная проверка рисков SQL, планирование миграции. Контекст автоматически выводится из текущей среды MCP, инициализация не требуется. Поддерживается только путь выполнения встроенного в CloudBase облачного Manager SDK для PostgreSQL.

管理 PostgreSQL 上下文或执行写入 SQL

Управление CloudBase PostgreSQL: выполнение подтверждённых SQL-запросов на запись или DDL, предварительная проверка рисков SQL, планирование миграции. Контекст автоматически выводится из текущей среды MCP, инициализация не требуется. Поддерживается только путь выполнения встроенного в CloudBase облачного Manager SDK для PostgreSQL.

Параметры

  • actionenumобязательный

    操作类型:execute=执行已确认的写入 SQL 或 DDL;dryRun=只分析 SQL 风险不执行;planMigration=预览迁移计划(需 migrationName + sql);applyMigration=应用迁移,建表/改 schema 首选(需 migrationName + sql + confirm=true);listMigrations=查询已应用的 Migration 列表(可传 limit/offset 分页);migrationDetail=查看单条 Migration 详情(需 migrationVersion);rollbackMigration=回滚最近 N 条 Migration(需 lastN + confirm=true);repairMigration=修复 Migration 历史记录(需 migrationVersion + migrationName + repairStatus + repairReason)

    executedryRunplanMigrationapplyMigrationlistMigrationsmigrationDetailrollbackMigrationrepairMigration
  • sqlstring

    action=execute、dryRun、planMigration、applyMigration 或 repairMigration(applied) 使用的 SQL 语句

  • confirmboolean

    执行任何写入 SQL 前都需要显式设置为 true。

  • envIdstring

    可选的 CloudBase 环境 ID,不传时使用当前 MCP 环境。

  • instanceIdstring

    可选的 PostgreSQL 逻辑实例标识,默认 cloudbase-pg。

  • defaultSchemastring

    可选的默认 schema,默认 public。

  • rolestring

    可选的 PostgreSQL role,会传给 Manager SDK executePGSql;例如需要管理策略时可传 postgres。

  • objectNamestring

    可选的对象名,当前仅用于非 migration 场景。migration 相关操作请使用 migrationName / migrationVersion / lastN。

  • migrationNamestring

    plan/apply/repair 必填:migration 名称,小写字母开头,仅允许小写字母、数字和下划线。

  • migrationVersionstring

    14 位时间戳 YYYYMMDDHHMMSS。detail/repair 必填;plan/apply 不传时自动生成。

  • rollbackSqlstring

    plan/apply 可选:回滚 SQL 语句。

  • lastNinteger

    rollback 必填:回滚最近 N 条已应用的 Migration,正整数。

  • limitinteger

    list 可选:返回数量上限,1-500,默认 100。

  • offsetinteger

    list 可选:分页偏移,默认 0。

  • lockTimeoutMsinteger

    apply 可选:获取数据库锁的最长时间(毫秒),默认 5000。

  • statementTimeoutMsinteger

    apply 可选:单条 SQL 执行最长时间(毫秒),默认 300000。

  • repairStatusenum

    repair 必填:applied=标记为已应用(可补录 Query),reverted=删除 history 记录。

    appliedreverted
  • repairReasonstring

    repair 必填:修复原因。

manageStorageвнешний мир

管理 CloudBase 云存储文件,只对 COS/Storage 对象操作,不涉及静态网站托管。支持上传文件/目录、下载文件/目录、删除文件/目录等操作。删除时必须设置 `force=true` 确认,防止误删重要文件。注意:上传后返回的 `temporaryUrl` 是临时签名链接,1小时后过期,不要当作永久公网地址写入配置或持久化存储。工具还会基于 `DescribeEnvs` 返回的 `Storages[0].CdnDomain` 推导出 `publicUrl`,⚠️ 警告:`publicUrl` 仅在存储桶 ACL 为公有读(所有用户可读)时才能被匿名访问;默认私有读写存储桶返回的 `publicUrl` 会返回 403,此时请继续使用 `temporaryUrl`,或先通过控制台/SDK 将目标路径设置为公有读。 💡 存储桶 ACL 权限管理请使用 `permissions` 工具:`queryPermissions(action="getResourcePermission", resourceType="storage", resourceId="bucket-name")` 查询,`managePermissions(action="updateResourcePermission", resourceType="storage", resourceId="bucket-name", permission="READONLY")` 设置。 📦 CloudBase PG / pgstore 桶必须先创建后使用(与 Supabase Storage 一致:upload 前 bucket 必须存在)。浏览器 SDK `app.storage.from().upload(path, file)` 不会自动建桶,且 `path` 的第一段就是 bucket 名(例如 `covers/foo.png` → bucket=`covers`);`from('covers')` 这个参数当前不会被拼到 path 里。如果上传时浏览器看到 `STORAGE_BUCKET_NOT_FOUND` 或 `PUT https://undefined/`(DevTools 表现为 `net::ERR_NAME_NOT_RESOLVED`),先用本工具或控制台确认/创建对应的 pgstore bucket,再让前端重试上传,不要让前端静默吞掉上传失败。`DescribeEnvs.Storages[]` 返回的旧 NoSQL bucket(形如 `<hash>-<envId>-<appId>`)不是可用的 pgstore bucket,切勿当作默认目标使用。

管理 CloudBase 存储文件

管理 CloudBase 云存储文件,只对 COS/Storage 对象操作,不涉及静态网站托管。支持上传文件/目录、下载文件/目录、删除文件/目录等操作。删除时必须设置 `force=true` 确认,防止误删重要文件。注意:上传后返回的 `temporaryUrl` 是临时签名链接,1小时后过期,不要当作永久公网地址写入配置或持久化存储。工具还会基于 `DescribeEnvs` 返回的 `Storages[0].CdnDomain` 推导出 `publicUrl`,⚠️ 警告:`publicUrl` 仅在存储桶 ACL 为公有读(所有用户可读)时才能被匿名访问;默认私有读写存储桶返回的 `publicUrl` 会返回 403,此时请继续使用 `temporaryUrl`,或先通过控制台/SDK 将目标路径设置为公有读。 💡 存储桶 ACL 权限管理请使用 `permissions` 工具:`queryPermissions(action="getResourcePermission", resourceType="storage", resourceId="bucket-name")` 查询,`managePermissions(action="updateResourcePermission", resourceType="storage", resourceId="bucket-name", permission="READONLY")` 设置。 📦 CloudBase PG / pgstore 桶必须先创建后使用(与 Supabase Storage 一致:upload 前 bucket 必须存在)。浏览器 SDK `app.storage.from().upload(path, file)` 不会自动建桶,且 `path` 的第一段就是 bucket 名(例如 `covers/foo.png` → bucket=`covers`);`from('covers')` 这个参数当前不会被拼到 path 里。如果上传时浏览器看到 `STORAGE_BUCKET_NOT_FOUND` 或 `PUT https://undefined/`(DevTools 表现为 `net::ERR_NAME_NOT_RESOLVED`),先用本工具或控制台确认/创建对应的 pgstore bucket,再让前端重试上传,不要让前端静默吞掉上传失败。`DescribeEnvs.Storages[]` 返回的旧 NoSQL bucket(形如 `<hash>-<envId>-<appId>`)不是可用的 pgstore bucket,切勿当作默认目标使用。

Параметры

  • actionenumобязательный

    管理操作类型:upload=上传文件或目录,download=下载文件或目录,delete=删除文件或目录

    uploaddownloaddelete
  • localPathstring

    本地文件路径,建议传入绝对路径,例如 /tmp/files/data.txt;upload/download 操作时必填,delete 操作时不需要传该参数

  • cloudPathstringобязательный

    云端文件路径,例如 files/data.txt

  • forceboolean

    强制操作开关,删除操作时建议设置为true以确认删除,默认false

  • isDirectoryboolean

    是否为目录操作,true=目录操作,false=文件操作,默认false

modifyDataModelвнешний мир

Создаёт модель данных на основе Mermaid classDiagram. Для совместимости имя инструмента остаётся modifyDataModel; сейчас поддерживается только создание новых моделей — обновлять существующую структуру нельзя. Встроен мониторинг асинхронных задач: автоматический опрос до завершения или таймаута.

修改数据模型(当前仅支持创建)

Создаёт модель данных на основе Mermaid classDiagram. Для совместимости имя инструмента остаётся modifyDataModel; сейчас поддерживается только создание новых моделей — обновлять существующую структуру нельзя. Встроен мониторинг асинхронных задач: автоматический опрос до завершения или таймаута.

Параметры

  • mermaidDiagramstringобязательный

    Mermaid classDiagram代码,描述数据模型结构。 示例: classDiagram class Student { name: string <<姓名>> age: number = 18 <<年龄>> gender: x-enum = "男" <<性别>> classId: string <<班级ID>> identityId: string <<身份ID>> course: Course[] <<课程>> required() ["name"] unique() ["name"] enum_gender() ["男", "女"] display_field() "name" } class Class { className: string <<班级名称>> display_field() "className" } class Course { name: string <<课程名称>> students: Student[] <<学生>> display_field() "name" } class Identity { number: string <<证件号码>> display_field() "number" } %% 关联关系 Student "1" --> "1" Identity : studentId Student "n" --> "1" Class : student2class Student "n" --> "m" Course : course Student "n" <-- "m" Course : students %% 类的命名 note for Student "学生模型" note for Class "班级模型" note for Course "课程模型" note for Identity "身份模型"

  • actionenum

    操作类型:create=创建新模型

    create
  • publishboolean

    是否立即发布模型

  • dbInstanceTypeenum

    数据库实例类型,可选值:MYSQL=MySQL 数据库,FLEXDB=文档型数据库(NoSQL)

    MYSQLFLEXDB
queryAgentsтолько чтениевнешний мир

CloudBase Agent домен, единый вход только для чтения. Поддерживает запрос списка, деталей и логов.

查询 CloudBase Agent

CloudBase Agent домен, единый вход только для чтения. Поддерживает запрос списка, деталей и логов.

Параметры

  • actionenumобязательный
    listAgentsgetAgentgetAgentLogs
  • agentIdstring
  • pageNumbernumber
  • pageSizenumber
  • paramsobject
queryAppAuthтолько чтениевнешний мир

CloudBase — точка чтения конфигурации аутентификации на стороне приложения. Используется для проверки готовности аутентификации: способ входа, provider, publishable key, API key, конфигурация client, статические домены и т.д. ⚠️ Этот инструмент предназначен только для просмотра конфигурации со стороны администратора, он не выполняет вход пользователя. Если задача требует написать клиентский код для входа (например, «войти через JS SDK»), сначала проверьте конфигурацию через этот инструмент, затем в коде проекта напишите клиентский код @cloudbase/js-sdk (например, `auth.signInWithPassword()`), а не используйте этот инструмент для самого входа. Если бизнес-логика должна принимать обычные строковые идентификаторы (типа имени пользователя), сначала выполните запрос `action=getLoginConfig`; если `usernamePassword=false`, сразу вызовите `manageAppAuth(action=patchLoginStrategy, patch={ usernamePassword: true })`, не пишите прямо API входа через email.

查询 CloudBase 应用认证配置

CloudBase — точка чтения конфигурации аутентификации на стороне приложения. Используется для проверки готовности аутентификации: способ входа, provider, publishable key, API key, конфигурация client, статические домены и т.д. ⚠️ Этот инструмент предназначен только для просмотра конфигурации со стороны администратора, он не выполняет вход пользователя. Если задача требует написать клиентский код для входа (например, «войти через JS SDK»), сначала проверьте конфигурацию через этот инструмент, затем в коде проекта напишите клиентский код @cloudbase/js-sdk (например, `auth.signInWithPassword()`), а не используйте этот инструмент для самого входа. Если бизнес-логика должна принимать обычные строковые идентификаторы (типа имени пользователя), сначала выполните запрос `action=getLoginConfig`; если `usernamePassword=false`, сразу вызовите `manageAppAuth(action=patchLoginStrategy, patch={ usernamePassword: true })`, не пишите прямо API входа через email.

Параметры

  • actionenumобязательный
    getLoginConfiglistProvidersgetProvidergetClientConfiggetPublishableKeygetStaticDomainlistApiKeys
  • providerIdstring

    provider 标识,如 email、google

  • clientIdstring

    OAuth client_id / DescribeClient 的 Id;省略时默认使用当前环境 ID(默认客户端)

  • keyTypeenum

    API key 类型过滤,可选 publish_key 或 api_key

    publish_keyapi_key
  • pageNumberinteger

    API key 列表页码,从 1 开始

  • pageSizeinteger

    API key 列表每页条数

queryAppsтолько чтениевнешний мир

Запрашивает приложения и версии развёртывания CloudBase. Можно получить список/детали приложений и список/детали версий; после развёртывания используй getAppVersion с buildId для опроса статуса сборки; getBuildLog позволяет запросить логи сборки для диагностики причин сбоя.

查询 CloudBase 应用部署状态

Запрашивает приложения и версии развёртывания CloudBase. Можно получить список/детали приложений и список/детали версий; после развёртывания используй getAppVersion с buildId для опроса статуса сборки; getBuildLog позволяет запросить логи сборки для диагностики причин сбоя.

Параметры

  • actionenumобязательный
    listAppsgetApplistAppVersionsgetAppVersiongetBuildLog
  • serviceNamestring

    CloudBase 应用服务名。getApp / listAppVersions / getAppVersion / getBuildLog 时必填;重新部署后复用同一个 serviceName 查询版本历史。

  • searchKeystring

    按应用服务名模糊搜索关键词,仅 action=listApps 时使用。

  • pageNonumber

    分页页码,从 1 开始。

  • pageSizenumber

    分页大小。

  • versionNamestring

    版本名称。getAppVersion 时可与 buildId 二选一;已知版本号时优先传该值。

  • buildIdstring

    构建 ID。getAppVersion 时可与 versionName 二选一;部署返回 BuildId 后可直接用它轮询状态。getBuildLog 时必填。

  • startnumber

    构建日志偏移量,用于分页拉取后续日志。仅 action=getBuildLog 时使用,不传时从开头返回。

queryCloudRunтолько чтениевнешний мир

Запрос информации об услугах облачного хостинга: поддерживает получение списка услуг, запрос деталей услуги, получение списка доступных шаблонов и логов развертывания. Возвращаемая информация об услуге включает название услуги, статус, тип доступа, детали конфигурации и контекст последнего развертывания.

查询 CloudRun 服务信息

Запрос информации об услугах облачного хостинга: поддерживает получение списка услуг, запрос деталей услуги, получение списка доступных шаблонов и логов развертывания. Возвращаемая информация об услуге включает название услуги, статус, тип доступа, детали конфигурации и контекст последнего развертывания.

Параметры

  • actionenumобязательный

    查询操作类型:list=获取云托管服务列表(支持分页和筛选),detail=查询指定服务的详细信息(包含服务配置和最新部署状态),templates=获取可用的项目模板列表(用于初始化新项目),getDeployLog=获取指定服务最近一次或指定构建的部署日志

    listdetailtemplatesgetDeployLog
  • pageSizenumber

    分页大小,控制每页返回的服务数量。取值范围:1-100,默认值:10。建议根据网络性能和显示需求调整

  • pageNumnumber

    页码,用于分页查询。从1开始,默认值:1。配合pageSize使用可实现分页浏览

  • serverNamestring

    服务名称筛选条件,支持模糊匹配。例如:输入"test"可匹配"test-service"、"my-test-app"等服务名称。留空则查询所有服务

  • serverTypeenum

    服务类型筛选条件:function=函数型云托管(仅支持Node.js,有特殊的开发要求和限制,适合简单的API服务),container=容器型服务(推荐使用,支持任意语言和框架如Java/Go/Python/PHP/.NET等,适合大多数应用场景)

    functioncontainer
  • detailServerNamestring

    要查询详细信息或部署日志的服务名称。当action为detail或getDeployLog时建议提供,必须是已存在的服务名称。可通过list操作获取可用的服务名称列表

  • buildIdnumber

    构建ID,仅在action=getDeployLog时使用。不传时默认返回最近一次部署的构建日志

queryEnvтолько чтениевнешний мир

Запрашивает информацию, связанную с окружением CloudBase: поддерживается список окружений, детали конкретного окружения и домены безопасности (ранее называлось: envQuery, listEnvs, getEnvInfo, getEnvAuthDomains). Когда action=list, работает в семантике DescribeEnvs — вывод списка/фильтрация, стандартные поля возврата: EnvId, Alias, Status, EnvType, Region, PackageId, PackageName, IsDefault. Поддерживается обрезка этих полей через белый список fields. При aliasExact=true выполняется точная фильтрация по псевдониму, чтобы не подхватить окружения с похожим префиксом. Даже если передан envId, action=list возвращает только краткую сводку, без полных ресурсов или expiry. Чтобы получить подробную информацию об окружении по известному EnvId (включая ресурсы и платёжные данные), необходимо использовать action=info и передать параметр envId целевого окружения. При action=info, если доступно, добавляется BillingInfo (поля оплаты: ExpireTime, PayMode, IsAutoRenew и т.д.). 🔍 action=info также вычисляет три поля для выбора бэкенда: - `EnvInfo.RuntimeMode`: 'postgresql' или 'nosql' — рекомендованный бэкенд для новых проектов (postgresql, если PG уже включён, иначе nosql). - `EnvInfo.RuntimeBackends`: `{postgresql, nosql, mysql}` — три булевых значения, описывающие реально сосуществующие бэкенды текущего окружения. - `EnvInfo.RuntimeModeHints`: подсказки по API/инструментам/skills для каждого бэкенда. Перед написанием кода для бизнес-логики, прав доступа или хранения AI обязан сначала посмотреть эти три поля: в режиме PG новые проекты рекомендуется через `app.rdb()` + RLS (команда `managePgDatabase action=execute` с `CREATE POLICY`) + pgstore; уже существующие коллекции NoSQL / старый storage / `managePermissions(resourceType="noSqlDatabase")` в окружении PG всё ещё работают. Реально неприменим только MySQL: когда `RuntimeBackends.mysql === false`, нельзя использовать `manageMysqlDatabase` / `queryMysqlDatabase` / skill `relational-database-tool`.

CloudBase 环境查询

Запрашивает информацию, связанную с окружением CloudBase: поддерживается список окружений, детали конкретного окружения и домены безопасности (ранее называлось: envQuery, listEnvs, getEnvInfo, getEnvAuthDomains). Когда action=list, работает в семантике DescribeEnvs — вывод списка/фильтрация, стандартные поля возврата: EnvId, Alias, Status, EnvType, Region, PackageId, PackageName, IsDefault. Поддерживается обрезка этих полей через белый список fields. При aliasExact=true выполняется точная фильтрация по псевдониму, чтобы не подхватить окружения с похожим префиксом. Даже если передан envId, action=list возвращает только краткую сводку, без полных ресурсов или expiry. Чтобы получить подробную информацию об окружении по известному EnvId (включая ресурсы и платёжные данные), необходимо использовать action=info и передать параметр envId целевого окружения. При action=info, если доступно, добавляется BillingInfo (поля оплаты: ExpireTime, PayMode, IsAutoRenew и т.д.). 🔍 action=info также вычисляет три поля для выбора бэкенда: - `EnvInfo.RuntimeMode`: 'postgresql' или 'nosql' — рекомендованный бэкенд для новых проектов (postgresql, если PG уже включён, иначе nosql). - `EnvInfo.RuntimeBackends`: `{postgresql, nosql, mysql}` — три булевых значения, описывающие реально сосуществующие бэкенды текущего окружения. - `EnvInfo.RuntimeModeHints`: подсказки по API/инструментам/skills для каждого бэкенда. Перед написанием кода для бизнес-логики, прав доступа или хранения AI обязан сначала посмотреть эти три поля: в режиме PG новые проекты рекомендуется через `app.rdb()` + RLS (команда `managePgDatabase action=execute` с `CREATE POLICY`) + pgstore; уже существующие коллекции NoSQL / старый storage / `managePermissions(resourceType="noSqlDatabase")` в окружении PG всё ещё работают. Реально неприменим только MySQL: когда `RuntimeBackends.mysql === false`, нельзя использовать `manageMysqlDatabase` / `queryMysqlDatabase` / skill `relational-database-tool`.

Параметры

  • actionenumобязательный

    查询类型:list=环境列表/摘要筛选(按 DescribeEnvs 语义筛选,支持通过 envId 筛选,返回 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault,不支持 expiry),info=指定环境的详细信息(必须传入 envId,返回资源字段和计费信息),domains=安全域名列表

    listinfodomains
  • aliasstring

    按环境别名筛选。action=list 时可选

  • aliasExactboolean

    按环境别名精确筛选。action=list 时可选;与 alias 配合使用

  • envIdstring

    按环境 ID 筛选。action=list 时可选(仅按 DescribeEnvs 语义做筛选,仍返回摘要);action=info 时必填(返回该环境的详细信息,包含资源字段和计费信息)。如果任务已经给出了明确的 EnvId 并要求查询详情,请直接使用 action=info + envId,而不是 action=list

  • limitinteger

    返回数量上限。action=list 时可选

  • offsetinteger

    分页偏移。action=list 时可选

  • fieldsstring[]

    返回字段白名单。仅支持 EnvId、Alias、Status、EnvType、Region、PackageId、PackageName、IsDefault。action=list 时可选

queryFunctionsтолько чтениевнешний мир

CloudBase: единая точка входа только для чтения для облачных функций. Через более самоочевидный action можно запросить список облачных функций CloudBase, детали функций, логи выполнения, слои, триггеры и адреса загрузки кода. **Описание пагинации**: `listFunctions`, `listLayers` поддерживают параметры `limit` и `offset`. - `limit`: количество элементов на странице, значение по умолчанию задаётся бэкендом - `offset`: смещение страницы, начиная с 0 - Пример: `queryFunctions(action="listFunctions", offset=10, limit=10)` **Запрос логов облачных функций CloudBase**: используйте `action="listFunctionLogs"`, требуется параметр `functionName`. - Пример: `queryFunctions(action="listFunctionLogs", functionName="my-function")` - Чтобы посмотреть детали лога: `queryFunctions(action="getFunctionLogDetail", requestId="xxx")` **Плановые задачи / cron / запланированные запуски**: используйте `listFunctionTriggers` для запроса конфигурации timer-триггера функции. **Отличие от инструмента `queryLogs`**: - Этот инструмент предназначен для запроса логов выполнения конкретной облачной функции CloudBase - Инструмент `queryLogs` используется для поиска в сервисе логов CLS (агрегация логов между сервисами)

查询 CloudBase 云函数

CloudBase: единая точка входа только для чтения для облачных функций. Через более самоочевидный action можно запросить список облачных функций CloudBase, детали функций, логи выполнения, слои, триггеры и адреса загрузки кода. **Описание пагинации**: `listFunctions`, `listLayers` поддерживают параметры `limit` и `offset`. - `limit`: количество элементов на странице, значение по умолчанию задаётся бэкендом - `offset`: смещение страницы, начиная с 0 - Пример: `queryFunctions(action="listFunctions", offset=10, limit=10)` **Запрос логов облачных функций CloudBase**: используйте `action="listFunctionLogs"`, требуется параметр `functionName`. - Пример: `queryFunctions(action="listFunctionLogs", functionName="my-function")` - Чтобы посмотреть детали лога: `queryFunctions(action="getFunctionLogDetail", requestId="xxx")` **Плановые задачи / cron / запланированные запуски**: используйте `listFunctionTriggers` для запроса конфигурации timer-триггера функции. **Отличие от инструмента `queryLogs`**: - Этот инструмент предназначен для запроса логов выполнения конкретной облачной функции CloudBase - Инструмент `queryLogs` используется для поиска в сервисе логов CLS (агрегация логов между сервисами)

Параметры

  • actionenumобязательный

    只读操作类型: - `listFunctions`: 列出所有 CloudBase 云函数 - `getFunctionDetail`: 获取 CloudBase 云函数详情(需要 functionName) - `listFunctionLogs`: 查询 CloudBase 云函数执行日志(需要 functionName) - `getFunctionLogDetail`: 获取日志详情(需要 requestId) - `listFunctionLayers`: 列出函数绑定的层 - `listLayers`: 列出所有层 - `listLayerVersions`: 列出层的版本(注意:是 Versions 不是 Version) - `getLayerVersionDetail`: 获取层版本详情 - `listFunctionTriggers`: 列出函数触发器(用于查看定时任务 / cron / timer 配置) - `getFunctionDownloadUrl`: 获取函数代码下载地址

    listFunctionsgetFunctionDetaillistFunctionLogsgetFunctionLogDetaillistFunctionLayerslistLayerslistLayerVersionsgetLayerVersionDetaillistFunctionTriggersgetFunctionDownloadUrl
  • functionNamestring

    CloudBase 云函数名称。`getFunctionDetail`、`listFunctionLogs`、`listFunctionLayers`、`listFunctionTriggers`、`getFunctionDownloadUrl` 时必填

  • limitnumber

    分页数量(limit)。列表类 action 可选,默认值由后端决定

  • offsetnumber

    分页偏移(offset)。列表类 action 可选,默认 0

  • codeSecretstring

    代码保护密钥,用于解密函数代码

  • startTimestring

    日志查询开始时间,格式必须为 YYYY-MM-DD HH:mm:ss(如 2024-01-01 00:00:00)。与 endTime 间隔不能超过一天。不传时默认查询最近一天

  • endTimestring

    日志查询结束时间,格式必须为 YYYY-MM-DD HH:mm:ss(如 2024-01-01 23:59:59)。与 startTime 间隔不能超过一天。不传时默认为当前时间

  • requestIdstring

    日志请求 ID。`getFunctionLogDetail` 操作必填,可从 `listFunctionLogs` 结果中获取

  • qualifierstring

    函数版本别名,如 $LATEST、$DEFAULT。日志查询时可选

  • runtimestring

    层查询的运行时筛选,如 Nodejs18.15

  • searchKeystring

    层名称搜索关键字

  • layerNamestring

    层名称。`listLayerVersions`、`getLayerVersionDetail` 操作必填

  • layerVersionnumber

    层版本号。`getLayerVersionDetail` 操作必填

queryGatewayтолько чтениевнешний мир

CloudBase — унифицированная точка входа шлюза только для чтения. Через action запрашивает доменное имя шлюза, точку входа и статус открытости целевых ресурсов.

查询 CloudBase 网关

CloudBase — унифицированная точка входа шлюза только для чтения. Через action запрашивает доменное имя шлюза, точку входа и статус открытости целевых ресурсов.

Параметры

  • actionenumобязательный

    只读操作类型,例如 getAccess、listDomains

    getAccesslistDomainslistRoutesgetRoutelistCustomDomains
  • targetTypeenum

    目标资源类型。当前支持 function,后续可扩展

    function
  • targetNamestring

    目标资源名称。getAccess 时必填

  • routeIdstring

    路由 ID。getRoute 时可选

queryHostingтолько чтениевнешний мир

Запрашивает информацию только для чтения о статическом хостинге CloudBase. Подходит для AI: сначала обнаружить, затем решить, что делать дальше: action=websiteConfig запрашивает информацию о домашней странице, странице ошибок, правилах маршрутизации и доменном имени сайта; action=status запрашивает статус службы хостинга; action=findFiles ищет файлы по префиксу; action=listFiles выводит список всех файлов хостинга; action=domainStatus запрашивает текущий статус и конфигурацию пользовательского домена. Этот инструмент не вызывает никаких побочных эффектов.

查询 CloudBase 静态托管

Запрашивает информацию только для чтения о статическом хостинге CloudBase. Подходит для AI: сначала обнаружить, затем решить, что делать дальше: action=websiteConfig запрашивает информацию о домашней странице, странице ошибок, правилах маршрутизации и доменном имени сайта; action=status запрашивает статус службы хостинга; action=findFiles ищет файлы по префиксу; action=listFiles выводит список всех файлов хостинга; action=domainStatus запрашивает текущий статус и конфигурацию пользовательского домена. Этот инструмент не вызывает никаких побочных эффектов.

Параметры

  • actionenumобязательный

    查询类型:websiteConfig=查询静态托管网站文档配置与站点域名信息,status=查询静态托管服务状态,findFiles=按前缀查找托管文件,listFiles=列出静态托管中的全部文件,domainStatus=查询自定义域名配置与生效状态。该工具严格只读,不会修改任何资源。

    websiteConfigstatusfindFileslistFilesdomainStatus
  • prefixstring

    文件前缀过滤条件。仅 action=findFiles 时使用,例如 app/ 或 assets/logo。

  • markerstring

    分页起始标记。仅 action=findFiles 时使用,用于续查上一页之后的结果。

  • maxKeysinteger

    单次返回的最大文件条数。仅 action=findFiles 时使用。

  • domainsstring[]

    要查询的自定义域名列表。仅 action=domainStatus 时使用,例如 ["www.example.com"]。

queryLogsтолько чтениевнешний мир

CloudBase — единая точка входа для чтения логов. Позволяет проверить состояние сервиса логов и выполнять поиск по логам CLS. **Важное различие**: - Поиск логов облачных функций: используйте `queryFunctions(action="listFunctionLogs", functionName="xxx")` - Поиск логов CLS (агрегированные логи разных сервисов): используйте этот инструмент `queryLogs(action="searchLogs")` **Сценарии использования**: - Проверка, включён ли сервис логов CLS: `action="checkLogService"` - Поиск по логам разных сервисов (например, поиск всех ERROR-логов): `action="searchLogs"` - Поиск логов конкретного сервиса по синтаксису CLS: `action="searchLogs", service="tcb|tcbr"`

查询 CloudBase 日志服务

CloudBase — единая точка входа для чтения логов. Позволяет проверить состояние сервиса логов и выполнять поиск по логам CLS. **Важное различие**: - Поиск логов облачных функций: используйте `queryFunctions(action="listFunctionLogs", functionName="xxx")` - Поиск логов CLS (агрегированные логи разных сервисов): используйте этот инструмент `queryLogs(action="searchLogs")` **Сценарии использования**: - Проверка, включён ли сервис логов CLS: `action="checkLogService"` - Поиск по логам разных сервисов (например, поиск всех ERROR-логов): `action="searchLogs"` - Поиск логов конкретного сервиса по синтаксису CLS: `action="searchLogs", service="tcb|tcbr"`

Параметры

  • actionenumобязательный

    操作类型: - `checkLogService`: 检查 CLS 日志服务是否开通 - `searchLogs`: 搜索 CLS 日志(需要提供 queryString)

    checkLogServicesearchLogs
  • queryStringstring

    CLS 查询语句,**action="searchLogs" 时必填**,需严格遵循 CLS(Cloud Log Service)语法规范,详见 https://cloud.tencent.com/document/api/876/128127 **云函数相关查询**: - 云函数日志:`(src:app OR src:system) AND log:"START RequestId"` - 聚合云函数请求状态:`| select request_id, max(status_code) as status where ((request_id='44738f94-16dd-11f1-****' AND retry_num=0) AND retry_num=0) AND status_code!=202 group by request_id, retry_num` **云数据库 / 文档型**: - 云数据库(文档型):`module:database` - 云数据库(文档型)事件:`module:database AND eventType:(MongoSlowQuery)`(MongoSlowQuery 为文档型数据库慢查询事件) **云数据库 / SQL 型**: - 云数据库(SQL 型):`module:rdb` - 云数据库(SQL 型)事件:`module:rdb AND eventType:(MysqlFreeze OR MysqlRecover OR MysqlSlowQuery)`(MysqlFreeze 冻结、MysqlRecover 恢复、MysqlSlowQuery 慢查询) **其它服务**: - 审批流:`module:workflow` - 模型:`module:model` - 用户权限:`module:auth` - 大模型:`module:llm AND logType:llm-tracelog` - 网关服务调用:`logType:accesslog` - 应用发布/删除事件:`module:app AND eventType:(AppProdPub OR AppProdDel)`(AppProdPub 发布事件、AppProdDel 删除事件) 以上仅为示例,实际使用时请根据具体日志内容调整。 **注意**:查询特定云函数的执行日志时,优先使用 `queryFunctions(action="listFunctionLogs", functionName="xxx")`。

  • serviceenum

    日志来源服务: - `tcb`: 云函数、数据库、存储等基础服务日志 - `tcbr`: CloudRun 容器服务日志

    tcbtcbr
  • startTimestring

    查询开始时间,格式:`YYYY-MM-DD HH:mm:ss`,如 `2024-01-01 00:00:00`

  • endTimestring

    查询结束时间,格式:`YYYY-MM-DD HH:mm:ss`,如 `2024-01-01 23:59:59`

  • limitnumber

    返回日志条数限制,默认 20

  • contextstring

    翻页上下文,用于继续上一次查询

  • sortenum

    按时间排序:`asc` 升序,`desc` 降序

    ascdesc
queryMysqlDatabaseтолько чтениевнешний мир

Запрашивает информацию о базе данных CloudBase MySQL. Поддерживает выполнение только SQL запросов на чтение, проверку результата открытия MySQL, проверку статуса задач MySQL, а также получение контекстной информации текущего экземпляра.

查询 CloudBase MySQL 数据库状态或执行只读 SQL

Запрашивает информацию о базе данных CloudBase MySQL. Поддерживает выполнение только SQL запросов на чтение, проверку результата открытия MySQL, проверку статуса задач MySQL, а также получение контекстной информации текущего экземпляра.

Параметры

  • actionenumобязательный

    runQuery=execute read-only SQL; describeCreateResult=query CreateMySQL result; describeTaskStatus=query MySQL task status; getInstanceInfo=get current SQL instance context; describeInstance=alias of getInstanceInfo

    runQuerydescribeCreateResultdescribeTaskStatusgetInstanceInfodescribeInstance
  • sqlstring

    Read-only SQL used by action=runQuery

  • requestobject

    Official request payload used by describeCreateResult/describeTaskStatus

  • dbInstanceobject

    Optional SQL database instance context for runQuery

queryPermissionsтолько чтениевнешний мир

Запрос прав пользователей и конфигурации CloudBase, поддерживает запрос прав доступа к ресурсам (базы данных, облачные функции, хранилища и т.д.), список/детали ролей, список/детали пользователей приложения. Пример: - Запрос прав доступа к хранилищу: `action="getResourcePermission", resourceType="storage", resourceId="bucket-name"` 📌 Примечание на границе между бэкендами: перед вызовом используйте `envQuery(action="info", envId=...)`, чтобы посмотреть `EnvInfo.RuntimeBackends`. `resourceType="noSqlDatabase"` запрашивает правила коллекций CloudBase NoSQL, это независимый механизм от Row-Level Security (RLS) таблиц CloudBase PostgreSQL (PG) — если в одном окружении PG всё ещё используются коллекции NoSQL, результаты запроса для этих коллекций через данный инструмент **остаются действительными**. Для запроса RLS таблиц PG используйте `queryPgDatabase(action="sql", sql="SELECT * FROM pg_policies WHERE tablename=...")`. Данный инструмент не затрагивает права MySQL.

查询 CloudBase 权限与用户配置

Запрос прав пользователей и конфигурации CloudBase, поддерживает запрос прав доступа к ресурсам (базы данных, облачные функции, хранилища и т.д.), список/детали ролей, список/детали пользователей приложения. Пример: - Запрос прав доступа к хранилищу: `action="getResourcePermission", resourceType="storage", resourceId="bucket-name"` 📌 Примечание на границе между бэкендами: перед вызовом используйте `envQuery(action="info", envId=...)`, чтобы посмотреть `EnvInfo.RuntimeBackends`. `resourceType="noSqlDatabase"` запрашивает правила коллекций CloudBase NoSQL, это независимый механизм от Row-Level Security (RLS) таблиц CloudBase PostgreSQL (PG) — если в одном окружении PG всё ещё используются коллекции NoSQL, результаты запроса для этих коллекций через данный инструмент **остаются действительными**. Для запроса RLS таблиц PG используйте `queryPgDatabase(action="sql", sql="SELECT * FROM pg_policies WHERE tablename=...")`. Данный инструмент не затрагивает права MySQL.

Параметры

  • actionenumобязательный
    getResourcePermissionlistResourcePermissionslistRolesgetRolelistUsersgetUser
  • resourceTypeenum
    noSqlDatabasesqlDatabasefunctionstorage
  • resourceIdstring
  • resourceIdsstring[]
  • roleIdstring
  • roleIdentitystring
  • roleNamestring
  • uidstring
  • usernamestring
  • pageNonumber
  • pageSizenumber
queryPgDatabaseтолько чтениевнешний мир

Запрос к базе данных CloudBase PostgreSQL. Поддерживает: получение текущего контекста PG, перечисление объектов базы данных со схемами, чтение облегченных метаданных, проверку структуры отдельного объекта и выполнение SQL только для чтения.

查询 PostgreSQL 上下文、对象、元数据或执行只读 SQL

Запрос к базе данных CloudBase PostgreSQL. Поддерживает: получение текущего контекста PG, перечисление объектов базы данных со схемами, чтение облегченных метаданных, проверку структуры отдельного объекта и выполнение SQL только для чтения.

Параметры

  • actionenumобязательный

    操作类型:context=获取当前 PostgreSQL 上下文;objects=列出带 schema 的数据库对象;metadata=获取轻量表元数据;schema=检查单个带 schema 的对象结构;sql=执行只读 SQL

    contextobjectsmetadataschemasql
  • sqlstring

    action=sql 时使用的只读 SQL

  • objectNamestring

    action=schema 时使用的带 schema 的 PostgreSQL 对象名,例如 public.users

  • schemastring

    可选的 schema 过滤条件,用于 action=objects 或 action=metadata

  • limitinteger

    可选的摘要数量上限,用于对象、元数据或 SQL 返回行数,默认 20,最大 200。

queryPgStorageтолько чтениевнешний мир

Выполните запрос к возможностям облачного хранения в среде CloudBase PostgreSQL. Верните сводку возможностей bucket/config, схему запроса информации об объектах, а также реализацию загрузки через HTTP API или SDK; локальные файлы не считываются, большое количество подписанных URL по умолчанию не выводится.

查询 PostgreSQL 环境云存储能力和上传方案

Выполните запрос к возможностям облачного хранения в среде CloudBase PostgreSQL. Верните сводку возможностей bucket/config, схему запроса информации об объектах, а также реализацию загрузки через HTTP API или SDK; локальные файлы не считываются, большое количество подписанных URL по умолчанию не выводится.

Параметры

  • actionenumобязательный

    操作类型:buckets/config=查询存储能力摘要;createBucket=生成 bucket 创建方案(SQL/HTTP API/CLI);uploadPlan=生成 HTTP API/SDK 上传方案;objectInfo=生成对象元信息查询方案;signUpload/signDownload=显式的一次性签名 URL 请求占位

    bucketsconfiguploadPlanobjectInfosignUploadsignDownloadcreateBucket
  • bucketstring

    云存储 bucket 名称

  • objectKeystring

    单个对象 key

  • objectKeysstring[]

    多个对象 key,用于对象元信息查询规划

  • objectsobject[]

    待上传对象的元信息。文件字节内容不会通过 MCP 传递。

  • expiresIninteger

    签名 URL 有效期,单位秒,范围 60 到 86400。

queryStorageтолько чтениевнешний мир

Запрашивает информацию о CloudBase облачном хранилище: поддерживает просмотр файлов в каталоге, получение информации о файле, получение временной ссылки для скачивания и другие операции только на чтение. Возвращаемая информация о файле включает имя, размер, время изменения, ссылку для скачивания и т.д. Важно: `temporaryUrl` из `action=url` — это временная подписанная ссылка, срок действия определяется параметром `maxAge` (по умолчанию 1 час), не используйте её как постоянный публичный адрес. Инструмент также выводит `publicUrl` на основе `Storages[0].CdnDomain` из `DescribeEnvs`. ⚠️ Предупреждение: `publicUrl` доступен анонимно, только если ACL бакета настроен на публичное чтение (доступно всем пользователям); для бакета с приватным чтением/записью по умолчанию `publicUrl` вернёт 403 — в этом случае продолжайте использовать `temporaryUrl` или сначала через консоль/SDK сделайте целевой путь публично читаемым. 💡 Управление ACL бакета — используйте инструмент permissions: `queryPermissions(action="getResourcePermission", resourceType="storage", resourceId="bucket-name")` для запроса, `managePermissions(action="updateResourcePermission", resourceType="storage", resourceId="bucket-name", permission="READONLY")` для настройки. 📦 Окружение CloudBase PG / pgstore: бакеты, перечисленные в `DescribeEnvs.Storages[]`, относятся к старому NoSQL-бэкенду и НЕ равны бакету pgstore. Данный инструмент предназначен для просмотра обычного хранилища; при подготовке бакета для загрузки через PG-браузер убедитесь, что целевой бакет доступен для бэкенда pgstore, иначе вызов `app.storage.from().upload(...)` в браузере вернёт `STORAGE_BUCKET_NOT_FOUND` с ошибкой `PUT https://undefined/`.

查询 CloudBase 存储信息

Запрашивает информацию о CloudBase облачном хранилище: поддерживает просмотр файлов в каталоге, получение информации о файле, получение временной ссылки для скачивания и другие операции только на чтение. Возвращаемая информация о файле включает имя, размер, время изменения, ссылку для скачивания и т.д. Важно: `temporaryUrl` из `action=url` — это временная подписанная ссылка, срок действия определяется параметром `maxAge` (по умолчанию 1 час), не используйте её как постоянный публичный адрес. Инструмент также выводит `publicUrl` на основе `Storages[0].CdnDomain` из `DescribeEnvs`. ⚠️ Предупреждение: `publicUrl` доступен анонимно, только если ACL бакета настроен на публичное чтение (доступно всем пользователям); для бакета с приватным чтением/записью по умолчанию `publicUrl` вернёт 403 — в этом случае продолжайте использовать `temporaryUrl` или сначала через консоль/SDK сделайте целевой путь публично читаемым. 💡 Управление ACL бакета — используйте инструмент permissions: `queryPermissions(action="getResourcePermission", resourceType="storage", resourceId="bucket-name")` для запроса, `managePermissions(action="updateResourcePermission", resourceType="storage", resourceId="bucket-name", permission="READONLY")` для настройки. 📦 Окружение CloudBase PG / pgstore: бакеты, перечисленные в `DescribeEnvs.Storages[]`, относятся к старому NoSQL-бэкенду и НЕ равны бакету pgstore. Данный инструмент предназначен для просмотра обычного хранилища; при подготовке бакета для загрузки через PG-браузер убедитесь, что целевой бакет доступен для бэкенда pgstore, иначе вызов `app.storage.from().upload(...)` в браузере вернёт `STORAGE_BUCKET_NOT_FOUND` с ошибкой `PUT https://undefined/`.

Параметры

  • actionenumобязательный

    查询操作类型:list=列出目录下的所有文件,info=获取指定文件的详细信息,url=获取文件的临时下载链接,read=读取文本文件内容

    listinfourlread
  • cloudPathstringобязательный

    云端文件路径,例如 files/data.txt 或 files/(目录)

  • maxAgenumber

    临时链接有效期,单位为秒,取值范围:1-86400,默认值:3600(1小时)

readNoSqlDatabaseContentтолько чтениевнешний мир

Запрашивает записи данных в NoSQL-базе CloudBase. Поддерживает фильтрацию по условиям, пагинацию, сортировку. Подходит для запросов данных и администрирования на стороне управления.

查询并获取 CloudBase NoSQL 数据库数据记录

Запрашивает записи данных в NoSQL-базе CloudBase. Поддерживает фильтрацию по условиям, пагинацию, сортировку. Подходит для запросов данных и администрирования на стороне управления.

Параметры

  • collectionNamestringобязательный

    集合名称

  • instanceIdstring

    可选:显式指定数据库实例ID;未传时会自动解析并缓存

  • queryany

    查询条件(对象或字符串,推荐对象)

  • projectionany

    返回字段投影(对象或字符串,推荐对象)

  • sortany

    排序条件,仅支持数组 [{"key":"createdAt","direction":-1}] 或对应 JSON 字符串。

  • limitnumber

    返回数量限制

  • offsetnumber

    跳过的记录数

readNoSqlDatabaseStructureтолько чтениевнешний мир

读取 CloudBase NoSQL 数据库集合与索引结构,支持列出集合、查看集合详情、列出索引以及检查索引是否存在。这个工具属于服务端管理工具,用于管理端查询数据库结构,不用于编写客户端代码。

读取 CloudBase NoSQL 数据库结构

读取 CloudBase NoSQL 数据库集合与索引结构,支持列出集合、查看集合详情、列出索引以及检查索引是否存在。这个工具属于服务端管理工具,用于管理端查询数据库结构,不用于编写客户端代码。

Параметры

  • actionenumобязательный

    listCollections: 列出集合列表 describeCollection: 描述集合详情(会返回索引摘要) checkCollection: 检查集合是否存在 listIndexes: 列出指定集合的索引列表 checkIndex: 检查指定索引是否存在

    listCollectionsdescribeCollectioncheckCollectionlistIndexescheckIndex
  • limitnumber

    返回数量限制(listCollections 操作时可选)

  • offsetnumber

    偏移量(listCollections 操作时可选)

  • collectionNamestring

    集合名称(describeCollection、listIndexes、checkIndex 操作时必填)

  • indexNamestring

    索引名称(checkIndex 操作时必填)

searchKnowledgeBaseтолько чтениевнешний мир

云开发知识库智能检索工具,支持向量查询 (vector)、固定技能文档 (skill)、OpenAPI 文档 (openapi) 和 CloudBase 官方文档 (docs) 查询。 强烈推荐始终优先使用固定技能文档 (skill)、OpenAPI 文档 (openapi) 或 CloudBase 官方文档 (docs) 模式进行检索,仅当固定文档无法覆盖你的问题时,再使用向量查询 (vector) 模式。 ⚠️ 重要:当 CloudBase skills 处于禁用状态或当前 IDE 不支持 skill 文件读取时,必须使用 searchKnowledgeBase(mode=skill, skillName=...) 来获取 CloudBase 技能文档内容,而不是尝试直接读取 skill 文件。直接读取可能返回 400 错误。示例: - 需要 auth-tool 指南时:searchKnowledgeBase(mode=skill, skillName=auth-tool) - 需要 auth-web 指南时:searchKnowledgeBase(mode=skill, skillName=auth-web) - 需要 cloudbase-agent 指南时:searchKnowledgeBase(mode=skill, skillName=cloudbase-agent) 固定技能文档 (skill) 查询当前支持 23 个固定文档,分别是: 文档名:ai-model-nodejs 文档介绍:Use this skill when developing Node.js backend services or CloudBase cloud functions (Express/Koa/NestJS, serverless, backend APIs) that need AI capabilities. Features text generation (generateText), streaming (streamText), AND image generation (generateImage) via @cloudbase/node-sdk ≥3.16.0. Built-in models include Hunyuan (hunyuan-2.0-instruct-20251111 recommended), DeepSeek (deepseek-v3.2 recommended), and hunyuan-image for images. This is the ONLY SDK that supports image generation. NOT for browser/Web apps (use ai-model-web) or WeChat Mini Program (use ai-model-wechat). 文档名:ai-model-web 文档介绍:Use this skill when developing browser/Web applications (React/Vue/Angular, static websites, SPAs) that need AI capabilities. Features text generation (generateText) and streaming (streamText) via @cloudbase/js-sdk. Built-in models include Hunyuan (hunyuan-2.0-instruct-20251111 recommended) and DeepSeek (deepseek-v3.2 recommended). NOT for Node.js backend (use ai-model-nodejs), WeChat Mini Program (use ai-model-wechat), or image generation (Node SDK only). 文档名:ai-model-wechat 文档介绍:Use this skill when developing WeChat Mini Programs (小程序, 企业微信小程序, wx.cloud-based apps) that need AI capabilities. Features text generation (generateText) and streaming (streamText) with callback support…

云开发知识库检索

云开发知识库智能检索工具,支持向量查询 (vector)、固定技能文档 (skill)、OpenAPI 文档 (openapi) 和 CloudBase 官方文档 (docs) 查询。 强烈推荐始终优先使用固定技能文档 (skill)、OpenAPI 文档 (openapi) 或 CloudBase 官方文档 (docs) 模式进行检索,仅当固定文档无法覆盖你的问题时,再使用向量查询 (vector) 模式。 ⚠️ 重要:当 CloudBase skills 处于禁用状态或当前 IDE 不支持 skill 文件读取时,必须使用 searchKnowledgeBase(mode=skill, skillName=...) 来获取 CloudBase 技能文档内容,而不是尝试直接读取 skill 文件。直接读取可能返回 400 错误。示例: - 需要 auth-tool 指南时:searchKnowledgeBase(mode=skill, skillName=auth-tool) - 需要 auth-web 指南时:searchKnowledgeBase(mode=skill, skillName=auth-web) - 需要 cloudbase-agent 指南时:searchKnowledgeBase(mode=skill, skillName=cloudbase-agent) 固定技能文档 (skill) 查询当前支持 23 个固定文档,分别是: 文档名:ai-model-nodejs 文档介绍:Use this skill when developing Node.js backend services or CloudBase cloud functions (Express/Koa/NestJS, serverless, backend APIs) that need AI capabilities. Features text generation (generateText), streaming (streamText), AND image generation (generateImage) via @cloudbase/node-sdk ≥3.16.0. Built-in models include Hunyuan (hunyuan-2.0-instruct-20251111 recommended), DeepSeek (deepseek-v3.2 recommended), and hunyuan-image for images. This is the ONLY SDK that supports image generation. NOT for browser/Web apps (use ai-model-web) or WeChat Mini Program (use ai-model-wechat). 文档名:ai-model-web 文档介绍:Use this skill when developing browser/Web applications (React/Vue/Angular, static websites, SPAs) that need AI capabilities. Features text generation (generateText) and streaming (streamText) via @cloudbase/js-sdk. Built-in models include Hunyuan (hunyuan-2.0-instruct-20251111 recommended) and DeepSeek (deepseek-v3.2 recommended). NOT for Node.js backend (use ai-model-nodejs), WeChat Mini Program (use ai-model-wechat), or image generation (Node SDK only). 文档名:ai-model-wechat 文档介绍:Use this skill when developing WeChat Mini Programs (小程序, 企业微信小程序, wx.cloud-based apps) that need AI capabilities. Features text generation (generateText) and streaming (streamText) with callback support…

Параметры

  • modeenumобязательный
    vectorskillopenapidocs
  • skillNameenum

    mode=skill 时指定。技能名称。

    ai-model-nodejsai-model-webai-model-wechatauth-http-apiauth-nodejsauth-toolauth-webauth-wechatcloud-functionscloud-storage-webcloudbase-agent-tscloudbase-platformcloudrun-developmentdata-model-creationhttp-apiminiprogram-developmentno-sql-web-sdkno-sql-wx-mp-sdkrelational-database-toolrelational-database-webspec-workflowui-designweb-development
  • apiNameenum

    mode=openapi 时指定。API 名称。

    functionsnosqlmysqldbstoragecloudrunai_modelauth
  • actionenum

    仅 mode=docs 时指定;mode=openapi 不要传 action。CloudBase 文档操作类型:listModules=列出所有文档模块,listModuleDocs=获取指定模块的目录结构,findByName=按名称/路径/URL 智能查找,readDoc=读取指定文档 Markdown,searchDocs=全文搜索官方文档。

    listModuleslistModuleDocsfindByNamereadDocsearchDocs
  • moduleNamestring

    mode=docs 且 action=listModuleDocs 时指定。模块名称。

  • inputstring

    mode=docs 且 action=findByName 时指定。支持模块名、文档标题、层级路径或 URL。

  • docPathstring

    mode=docs 且 action=readDoc 时指定。文档相对路径或完整 URL。

  • querystring

    mode=docs 且 action=searchDocs 时指定。全文检索关键词。

  • thresholdnumber

    mode=vector 时指定。相似性检索阈值

  • idenum

    mode=vector 时指定。知识库范围,默认 cloudbase。cloudbase=云开发全量知识,scf=云开发的云函数知识, miniprogram=小程序知识(不包含云开发与云函数知识)

    cloudbasescfminiprogram
  • contentstring

    mode=vector 时指定。检索内容

  • optionsobject

    mode=vector 时指定。其他选项

  • limitnumber

    mode=vector 时指定。指定返回最相似的 Top K 的 K 的值

writeNoSqlDatabaseContentвнешний мир

Изменить записи данных в базе данных CloudBase NoSQL. Поддерживает вставку, обновление (с операторами $set/$inc/$push и другими), удаление, upsert и другие операции. Подходит для записи данных и администрирования на стороне сервера. ⚠️ Запись на сервере не содержит _openid: если коллекция использует правила безопасности на уровне строк из клиентского SDK (@cloudbase/js-sdk или wx.cloud.database() из WeChat Mini Program), например doc._openid == auth.openid, при записи на сервере необходимо вручную добавить поле _openid, иначе клиент не сможет прочитать эти данные. ⚠️ Для частичного обновления вложенных полей используйте точечную нотацию, например `$set: {"shipping.city": "guangzhou"}`. Прямая передача вложенного объекта приведёт к перезаписи всего поля.

修改 CloudBase NoSQL 数据库数据记录

Изменить записи данных в базе данных CloudBase NoSQL. Поддерживает вставку, обновление (с операторами $set/$inc/$push и другими), удаление, upsert и другие операции. Подходит для записи данных и администрирования на стороне сервера. ⚠️ Запись на сервере не содержит _openid: если коллекция использует правила безопасности на уровне строк из клиентского SDK (@cloudbase/js-sdk или wx.cloud.database() из WeChat Mini Program), например doc._openid == auth.openid, при записи на сервере необходимо вручную добавить поле _openid, иначе клиент не сможет прочитать эти данные. ⚠️ Для частичного обновления вложенных полей используйте точечную нотацию, например `$set: {"shipping.city": "guangzhou"}`. Прямая передача вложенного объекта приведёт к перезаписи всего поля.

Параметры

  • actionenumобязательный

    insert: 插入数据(新增文档) update: 更新数据 delete: 删除数据

    insertupdatedelete
  • collectionNamestringобязательный

    集合名称

  • instanceIdstring

    可选:显式指定数据库实例ID;未传时会自动解析并缓存

  • documentsobject[]

    要插入的文档对象数组,每个文档都是对象(insert 操作必填)

  • queryany

    查询条件(对象或字符串,推荐对象)(update/delete 操作必填)

  • updateany

    更新内容(对象或字符串,推荐对象)(update 操作必填)。按 MongoDB 更新语义传入 MgoUpdate:部分更新请使用 `$set`、`$inc`、`$unset`、`$push` 等操作符,例如使用 `$set` 更新 `status`;不要直接传"字段到值的普通对象",否则可能替换整条文档。 ⚠️ 嵌套字段必须用点号路径(如 `shipping.city`),禁止整对象替换: - ❌ 错误:{ "$set": { "shipping": { "city": "guangzhou" } } } — shipping 被整块替换,原有 address/province 等字段全部丢失 - ✅ 正确:{ "$set": { "shipping.city": "guangzhou" } } — 仅更新 city,shipping 下其他字段保留

  • isMultiboolean

    是否更新多条记录(update/delete 操作可选)

  • upsertboolean

    是否在不存在时插入(update 操作可选)

writeNoSqlDatabaseStructureвнешний мир

Создаёт, удаляет и управляет коллекциями (collection) базы данных CloudBase NoSQL. Поддерживает создание новых коллекций, удаление существующих коллекций, а также добавление и удаление индексов через updateOptions.CreateIndexes / updateOptions.DropIndexes при вызове updateCollection. Если нужно создать новую коллекцию, используйте action=createCollection. Этот инструмент предназначен для серверного администрирования — для управления коллекциями и структурой индексов на стороне администратора, а не для написания клиентского кода.

创建并管理 CloudBase NoSQL 数据库集合

Создаёт, удаляет и управляет коллекциями (collection) базы данных CloudBase NoSQL. Поддерживает создание новых коллекций, удаление существующих коллекций, а также добавление и удаление индексов через updateOptions.CreateIndexes / updateOptions.DropIndexes при вызове updateCollection. Если нужно создать новую коллекцию, используйте action=createCollection. Этот инструмент предназначен для серверного администрирования — для управления коллекциями и структурой индексов на стороне администратора, а не для написания клиентского кода.

Параметры

  • actionenumобязательный

    createCollection: 创建集合 updateCollection: 更新集合配置;添加索引请传 updateOptions.CreateIndexes,删除索引请传 updateOptions.DropIndexes deleteCollection: 删除集合

    createCollectionupdateCollectiondeleteCollection
  • collectionNamestringобязательный

    集合名称

  • updateOptionsobject

    更新选项(updateCollection 时使用)。CreateIndexes 用于添加索引,DropIndexes 用于删除索引。

Другие проверенные MCP-сервера

growthbook/growthbook-mcp

growthbook/growthbook-mcp

официальный

MCP сервер для GrowthBook — управляйте A/B-тестами и фича-флагами прямо из AI-ассистента. Просматривайте эксперименты, добавляйте флаги и автоматизируйте работу с GrowthBook без переключения в веб-...

TypeScript24
ref-tools/ref-tools-mcp

ref-tools/ref-tools-mcp

MCP сервер для AI-агентов: быстрый доступ к документации API и библиотек. Оснащён поиском с фильтрацией результатов и чтением только релевантных разделов страниц - экономит токены. Подходит для Claude Code и других AI-кодинговых ассистентов.

TypeScript1140
antv/mcp-server-chart

antv/mcp-server-chart

официальный

MCP-сервер на базе AntV, который через инструменты модели создаёт более 26 видов графиков и карт. Интегрируется с Claude, VSCode и другими AI-клиентами, полезен для визуализации данных и анализа пр...

TypeScript4243
mrkrsl/web-search-mcp

mrkrsl/web-search-mcp

MCP сервер для веб-поиска локальных LLM без API-ключей. Использует Bing, Brave и DuckDuckGo для поиска и извлечения содержимого страниц. Включает три инструмента: глубокий поиск с контентом, быстрые выдержки и загрузку одной страницы. Совместим с LM Studio и LibreChat.

TypeScript1034
rinadelph/Agent-MCP

rinadelph/Agent-MCP

MCP сервер для координации нескольких AI-агентов при разработке. Агенты работают параллельно, используют общую память и граф знаний, что исключает потерю контекста и конфликты. Подходит для крупных...

TypeScript1270
steipete/peekaboo

steipete/peekaboo

MCP сервер для macOS с захватом экрана, AI-анализом и автоматизацией GUI: клики, ввод, скроллинг, горячие клавиши. Требует разрешений на запись экрана и доступность. Полезен разработчикам и тестировщикам.

Swift4879
© Каталог MCP, 2026. Все права защищены.
Проект не аффилирован с Anthropic и любыми упомянутыми продуктами.
Все названия и торговые марки принадлежат их владельцам.
Контакты для связи: hi@mcp-katalog.ru

Лука Никитин