MCP Tool

Currently includes 39 tools.

Source data: tools.json

---

Tools Overview

Name	Description
login	Logs in to the CloudBase environment and selects the environment to use
logout	Logs out of the CloudBase environment
envQuery	Queries CloudBase environment related information, supports querying environment list, current environment information, auth domains, and static website hosting configuration. (Original tool names: listEnvs/getEnvInfo/getEnvAuthDomains/getWebsiteConfig; for compatibility with old AI rules, these names can still be used.)
envDomainManagement	Manages the auth domains of the CloudBase environment, supports add and delete operations. (Original tool names: createEnvDomain/deleteEnvDomain; for compatibility with old AI rules, these names can still be used.)
createCollection	Manages CloudBase database collections: creates by default. Can specify update via action.
collectionQuery	Query operations for database collections, supports existence checking, detail viewing, list querying; and supports index listing and checking. (Compatible with old names)
updateCollection	Updates CloudBase database collection configuration (create or delete indexes)
checkIndexExists	Check index existence
insertDocuments	Inserts one or multiple documents into the CloudBase database collection (supports array of objects)
queryDocuments	Queries documents in the CloudBase database collection (supports object parameters)
updateDocuments	Updates documents in the CloudBase database collection (supports object parameters)
deleteDocuments	Deletes documents in the CloudBase database collection (supports object parameters)
manageDataModel	Data model query tool, supports querying and listing data models (read-only operations). The list operation returns basic information (without Schema), the get operation returns detailed information (with simplified Schema, including field list, format, relationships, etc.), and the docs operation generates SDK usage documentation.
modifyDataModel	Creates or updates data models based on Mermaid classDiagram. Supports creating new models and updating existing model structures. Features built-in asynchronous task monitoring with automatic polling until completion or timeout.
getFunctionList	Obtains cloud function list or individual function details, with operation type distinguished by the action parameter
createFunction	Create cloud function
updateFunctionCode	Update function code
updateFunctionConfig	Update cloud function configuration
invokeFunction	Invoke cloud function
getFunctionLogs	Get basic cloud function log information (LogList). To obtain log details, call the getFunctionLogDetail tool with the RequestId. This API is based on the getFunctionLogsV2 implementation in manger-node 4.4.0+ and does not return specific log content. offset+limit must not exceed 10000, and startTime/endTime interval must not exceed one day.
getFunctionLogDetail	Query log details based on the RequestId returned by getFunctionLogs. Parameters: startTime, endTime, requestId; returns log content (LogJson, etc.). Only supported on manger-node 4.4.0+.
manageFunctionTriggers	Manage cloud function triggers, with operation type distinguished by the action parameter
uploadFiles	Upload files to Static Hosting
deleteFiles	Delete files or folders in Static Hosting
findFiles	Search files in Static Hosting
domainManagement	Unified domain management tool that supports binding, unbinding, querying, and modifying domain configurations
queryStorage	Queries cloud storage information, supporting read-only operations such as listing directory files, obtaining file details, and generating temporary download URLs. Returned file information includes file name, size, last modified time, download URL, etc.
manageStorage	Manages cloud storage files, supporting operations such as uploading files/directories, downloading files/directories, and deleting files/directories. Delete operations require setting force=true for confirmation to prevent accidental deletion of important files.
downloadTemplate	Automatically downloads and deploys CloudBase project templates.<br/>Supported templates:<br/>- react: React + CloudBase full-stack application template<br/>- vue: Vue + CloudBase full-stack application template<br/>- miniprogram: WeChat Mini Program + Cloud Development template<br/>- uniapp: UniApp + CloudBase cross-platform application template<br/>- rules: Contains only AI editor configuration files (including configurations for all mainstream editors such as Cursor, WindSurf, CodeBuddy, etc.), suitable for supplementing AI editor configurations in existing projects<br/>Supported IDE types:<br/>- all: Downloads all IDE configurations (default)<br/>- cursor: Cursor AI editor<br/>- windsurf: WindSurf AI editor<br/>- codebuddy: CodeBuddy AI editor<br/>- claude-code: Claude Code AI editor<br/>- cline: Cline AI editor<br/>- gemini-cli: Gemini CLI<br/>- opencode: OpenCode AI editor<br/>- qwen-code: Tongyi Lingma<br/>- baidu-comate: Baidu Comate<br/>- openai-codex-cli: OpenAI Codex CLI<br/>- augment-code: Augment Code<br/>- github-copilot: GitHub Copilot<br/>- roocode: RooCode AI editor<br/>- tongyi-lingma: Tongyi Lingma<br/>- trae: Trae AI editor<br/>- vscode: Visual Studio Code<br/>Special notes:<br/>- The rules template automatically includes the current mcp version information (version: 1.8.41) to facilitate subsequent maintenance and version tracking<br/>- When downloading the rules template, if a README.md file already exists in the project, the system will automatically protect this file from being overwritten (unless overwrite=true is set)
interactiveDialog	Unified interactive dialog tool supporting requirement clarification and task confirmation. When needing to confirm next steps with users, call this tool's clarify method; for sensitive operations requiring user confirmation, call this tool's confirm method.
searchWeb	Performs information retrieval using web search, such as querying the latest news, articles, stock prices, weather, etc. Supports natural language queries and can also directly enter URLs to retrieve webpage content.
searchKnowledgeBase	Cloud Development knowledge base intelligent search tool supporting vector-based queries for Cloud Development and Cloud Function knowledge
queryCloudRun	Queries Cloud Run services information, supporting operations such as obtaining service lists, querying service details, and acquiring available template lists. Returned service information includes service name, status, access type, configuration details, etc.
manageCloudRun	Manages Cloud Run services, supporting the following operations in development workflow sequence: initialize projects (starting from templates, template lists can be queried via queryCloudRun), download service code, local execution (function-based services only), deploy code, and delete services. Deployment supports configurable parameters such as CPU, memory, instance count, and access type. Delete operations require confirmation; setting force=true is recommended.
createFunctionHTTPAccess	Create HTTP access for cloud function
downloadRemoteFile	Downloads remote files to a specified relative path under the project root directory. For example: resource images such as the Mini Program's Tabbar must be in **png** format and can be chosen from resources like Unsplash, wikimedia (generally choose the 500 size), Pexels, Apple's official UI, etc. to download.
readSecurityRule	Reads security rules and permission types for specified resources (database collections, cloud functions, buckets).<br/>Parameter description:<br/>- resourceType: Resource type (database/function/storage)<br/>- resourceId: Resource unique identifier (collection name/function name/bucket name)
writeSecurityRule	Sets security rules for specified resources (database collections, cloud functions, buckets).<br/>Parameter description:<br/>- resourceType: Resource type (database/function/storage)<br/>- resourceId: Resource unique identifier (collection name/function name/bucket name)<br/>- aclTag: Permission type (READONLY/PRIVATE/ADMINWRITE/ADMINONLY/CUSTOM)<br/>- rule: Custom security rule content, required only when aclTag is CUSTOM
activateInviteCode	CloudBase AI programming incentive program, activating user incentives through invitation codes.

---

Detailed Specifications

login

Log in to the CloudBase environment and select the environment to use

Parameters

Parameter Name	Type	Required	Description
forceUpdate	boolean		Whether to forcefully reselect the environment

---

logout

Exit the CloudBase environment

Parameters

Parameter Name	Type	Required	Description
confirm	string	Required	Confirmation action. Default value: 'yes'. Allowed value: const "yes"

---

envQuery

Querying CloudBase environment related information, supports querying environment list, current environment information, auth domains, and static website hosting configuration. (Original tool names: listEnvs/getEnvInfo/getEnvAuthDomains/getWebsiteConfig; for compatibility with old AI rules, these names can still be used.)

Parameters

Parameter Name	Type	Required	Description
action	string	Required	Query type: list=Environment list, info=Current environment information, domains=Security domain list, hosting=Static website hosting configuration. Allowed values: "list", "info", "domains", "hosting"

---

envDomainManagement

Managing the auth domains of the CloudBase environment, supports add and delete operations. (Original tool names: createEnvDomain/deleteEnvDomain; for compatibility with old AI rules, these names can still be used.)

Parameters

Parameter Name	Type	Required	Description
action	string	Required	Operation type: create=Add domain, delete=Delete domain. Allowed values: "create", "delete"
domains	array of string	Required	Security domain array

---

createCollection

Manages CloudBase database collections: creates by default. Can specify update via action.

Parameters

Parameter Name	Type	Required	Description
action	string	Optional	Operation type: create=Create (default), update=Update collection configuration. Allowed values: "create", "update"
collectionName	string	Required	CloudBase database collection name
options	object	Optional	Update options (used when action=update)
options.CreateIndexes	array of object
options.CreateIndexes[].IndexName	string	Required
options.CreateIndexes[].MgoKeySchema	object	Required
options.CreateIndexes[].MgoKeySchema.MgoIsUnique	boolean	Required
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys	array of object	Required
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Name	string	Required
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Direction	string	Required
options.DropIndexes	array of object
options.DropIndexes[].IndexName	string	Required

---

collectionQuery

Query operations for database collections, supporting existence checking, detail viewing, and list querying; also supports index listing and checking. (Compatible with old names)

Parameters

Parameter Name	Type	Required	Description
action	string	Required	Operation type: check=Check existence, describe=View details, list=List query, index_list=Index list, index_check=Check index existence. Allowed values: "check", "describe", "list", "index_list", "index_check"
collectionName	string		Collection name (required for check, describe, index_list, index_check operations)
indexName	string		Index name (required for index_check operation)
limit	number		Result limit (optional for list operations)
offset	number		Offset (optional for list operations)

---

updateCollection

Update CloudBase database collection configuration (create or delete indexes)

Parameters

Parameter Name	Type	Required	Description
collectionName	string	Required	CloudBase database collection name
options	object	Required	Update options supporting creating and deleting indexes
options.CreateIndexes	array of object
options.CreateIndexes[].IndexName	string	Required
options.CreateIndexes[].MgoKeySchema	object	Required
options.CreateIndexes[].MgoKeySchema.MgoIsUnique	boolean	Required
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys	array of object	Required
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Name	string	Required
options.CreateIndexes[].MgoKeySchema.MgoIndexKeys[].Direction	string	Required
options.DropIndexes	array of object
options.DropIndexes[].IndexName	string	Required

---

checkIndexExists

Check if the index exists

Parameters

Parameter Name	Type	Required	Description
collectionName	string	Required	CloudBase database collection name
indexName	string	Required	Index name

---

insertDocuments

Inserts one or multiple documents into the CloudBase database collection (supports array of objects)

Parameters

Parameter Name	Type	Required	Description
collectionName	string	Required	CloudBase database collection name
documents	array of object	Required	Array of document objects to be inserted, each document is an object.

---

queryDocuments

Queries documents in the CloudBase database collection (object parameters are supported)

Parameters

Parameter Name	Type	Required	Description
collectionName	string	Required	CloudBase database collection name
query	object \| string		Query conditions (object or string, object recommended)
projection	object \| string		Field projection (object or string, object recommended)
sort	object \| string		Sort conditions (object or string, object recommended)
limit	number		Result limit
offset	number		Number of records to skip

---

updateDocuments

Updates documents in the CloudBase database collection (object parameters are supported)

Parameters

Parameter Name	Type	Required	Description
collectionName	string	Required	CloudBase database collection name
query	object \| string	Required	Query conditions (object or string, object recommended)
update	object \| string	Required	Update data (object or string, object recommended)
isMulti	boolean		Whether to update multiple records
upsert	boolean		Whether to insert when not exist

---

deleteDocuments

Deletes documents in the CloudBase database collection (supports object parameters)

Parameters

Parameter Name	Type	Required	Description
collectionName	string	Required	CloudBase database collection name
query	object \| string	Required	Query conditions (object or string, object recommended)
isMulti	boolean		Whether to delete multiple records

---

manageDataModel

Data model query tool that supports querying and listing data models (read-only operations). The list operation returns basic information (without Schema), the get operation returns detailed information (with simplified Schema including field list, format, relationships, etc.), and the docs operation generates SDK usage documentation.

Parameters

Parameter Name	Type	Required	Description
action	string	Required	Operation type: get=Query a single model (including Schema field list, format, relationships), list=Obtain model list (without Schema), docs=Generate SDK usage documentation. Allowed values: "get", "list", "docs"
name	string		Model name (required for get operation)
names	array of string		Model name array (optional for list operation, used for filtering)

---

modifyDataModel

Creates or updates data models based on Mermaid classDiagram. Supports creating new models and updating existing model structures. Features built-in asynchronous task monitoring with automatic polling until completion or timeout.

Parameters

Parameter Name	Type	Required	Description
mermaidDiagram	string	Required	Mermaid classDiagram code describing the data model structure.
action	string	Optional	Operation type: create=Create new model. Allowed values: "create", "update"; Default value: "create"
publish	boolean		Whether to publish the model immediately. Default value: false
dbInstanceType	string		Database instance type. Default value: "MYSQL"

Example

classDiagram
    class Student {
        name: name: string <<Name>>
        age: age: number = 18 <<Age>>
        gender: gender: x-enum = "Male" <<Gender>>
        classId: classId: string <<Class ID>>
        identityId: identityId: string <<Identity ID>>
        course: course: Course[] <<Course>>
        required() ["name"]
        unique() ["name"]
        enum_gender() ["Male", "Female"]
        display_field() "name"
    }
    class Class {
        className: className: string <<Class Name>>
        display_field() "className"
    }
    class Course {
        name: name: string <<Course Name>>
        students: students: Student[] <<Student>>
        display_field() "name"
    }
    class Identity {
        number: number: string <<ID Number>>
        display_field() "number"
    }

    %% Relationship
    Student "1" --> "1" Identity : studentId
    Student "n" --> "1" Class : student2class
    Student "n" --> "m" Course : course
    Student "n" <-- "m" Course : students
    %% Class Naming
    note for Student "student model"
    note for Class "class model"
    note for Course "course model"
    note for Identity "identity model"

---

getFunctionList

Obtains cloud function list or individual function details, with operation type distinguished by the action parameter

Parameters

Parameter Name	Type	Required	Description
action	string	Optional	Operation type: list=Obtain function list (default), detail=Obtain function details. Allowed values: "list", "detail"
limit	number		Range (used in list operations)
offset	number		Offset (used in list operations)
name	string		Function name (Required for detail operations)
codeSecret	string		Code protection secret key (used in detail operations)

---

createFunction

Create cloud function

Parameters

Parameter Name	Type	Required	Description
func	object	Required	Function configuration
func.name	string	Required	Function name
func.timeout	number		Function timeout period
func.envVariables	object		Environment variables
func.vpc	object		VPC configuration
func.vpc.vpcId	string	Required
func.vpc.subnetId	string	Required
func.runtime	string		Runtime environment. Recommended value: 'Nodejs18.15'. Other options: Nodejs18.15, Nodejs16.13, Nodejs14.18, Nodejs12.16, Nodejs10.15, Nodejs8.9
func.triggers	array of object		Trigger configuration array
func.triggers[].name	string	Required	Trigger name
func.triggers[].type	string	Required	Trigger type, currently only supports 'timer'. Allowed values: "timer"
func.triggers[].config	string	Required	Trigger configuration. For timer triggers, use cron expression format: second minute hour day month week year. IMPORTANT: Must include exactly 7 fields (second minute hour day month week year). Examples: '0 0 2 1 * * *' (monthly), '0 30 9 * * * *' (daily at 9:30 AM)
func.handler	string		Function entry point
func.ignore	string \| array of string		Files to ignore
func.isWaitInstall	boolean		Whether to wait for dependency installation
func.layers	array of object		Layer configuration
func.layers[].name	string	Required
func.layers[].version	number	Required
functionRootPath	string		Function root directory (parent directory of the cloud function directory). Provide the absolute path of the file in the operating system. Note: Do not include the function name itself. For example, if the function name is 'hello', pass '/path/to/cloudfunctions' instead of '/path/to/cloudfunctions/hello'
force	boolean	Required	Whether to overwrite

---

updateFunctionCode

Update function code

Parameters

Parameter Name	Type	Required	Description
name	string	Required	Function name
functionRootPath	string	Required	Function root directory (parent directory of the cloud function directory). Provide the absolute path of the file in the operating system

---

updateFunctionConfig

Update cloud function configuration

Parameters

Parameter Name	Type	Required	Description
funcParam	object	Required	Function configuration
funcParam.name	string	Required	Function name
funcParam.timeout	number		Timeout period
funcParam.envVariables	object		Environment variables
funcParam.vpc	object		VPC configuration
funcParam.vpc.vpcId	string	Required
funcParam.vpc.subnetId	string	Required

---

invokeFunction

Invoke cloud function

Parameters

Parameter Name	Type	Required	Description
name	string	Required	Function name
params	object		Invocation parameters

---

getFunctionLogs

Obtain basic cloud function log information (LogList). To obtain log details, call the getFunctionLogDetail tool with the RequestId. This API is based on the getFunctionLogsV2 implementation in manger-node 4.4.0+ and does not return specific log content. offset+limit must not exceed 10000, and startTime/endTime interval must not exceed one day.

Parameters

Parameter Name	Type	Required	Description
name	string	Required	Function name
offset	number		Offset, Offset + Limit must not exceed 10000
limit	number		Length of returned data. Offset + Limit must not exceed 10000.
startTime	string		The specific date of the query, e.g., 2017-05-16 20:00:00. The time difference from EndTime must not exceed one day.
endTime	string		The specific date of the query, e.g., 2017-05-16 20:59:59. The time difference from StartTime must not exceed one day.
requestId	string		The request ID corresponding to the function execution
qualifier	string		Function version, defaults to $LATEST

---

getFunctionLogDetail

Query log details based on the RequestId returned by getFunctionLogs. Parameters: startTime, endTime, requestId; returns log content (LogJson, etc.). Only supported on manger-node 4.4.0+.

Parameters

Parameter Name	Type	Required	Description
startTime	string		The specific date of the query, e.g., 2017-05-16 20:00:00. The time difference from EndTime must not exceed one day.
endTime	string		The specific date of the query, e.g., 2017-05-16 20:59:59. The time difference from StartTime must not exceed one day.
requestId	string	Yes	The request ID corresponding to the function execution

---

manageFunctionTriggers

Creates or deletes a cloud function trigger, with operation type distinguished by the action parameter

Parameters

Parameter Name	Type	Required	Description
action	string	Required	Operation type: create=Create trigger, delete=Delete trigger. Allowed values: "create", "delete"
name	string	Required	Function name
triggers	array of object		Trigger configuration array (required when creating)
triggers[].name	string	Required	Trigger name
triggers[].type	string	Required	Trigger type, currently only supports 'timer'. Allowed values: "timer"
triggers[].config	string	Required	Trigger configuration. For timer triggers, use cron expression format: second minute hour day month week year. IMPORTANT: Must include exactly 7 fields (second minute hour day month week year). Examples: '0 0 2 1 * * *' (monthly), '0 30 9 * * * *' (daily at 9:30 AM)
triggerName	string		Trigger name (required when deleting)

---

uploadFiles

Upload files to static website hosting

Parameters

Parameter Name	Type	Required	Description
localPath	string		Local file or folder path, must be an absolute path, e.g. /tmp/files/data.txt
cloudPath	string		Cloud file or folder path, e.g. files/data.txt
files	array of object		Multi-file upload configuration. Default value: []
files[].localPath	string	Required
files[].cloudPath	string	Required
ignore	string \| array of string		File ignore pattern

---

deleteFiles

Delete files or folders in Static Hosting

Parameters

Parameter Name	Type	Required	Description
cloudPath	string	Required	Cloud file or folder path
isDir	boolean		Whether it is a folder. Default value: false

---

findFiles

Search files in static website hosting

Parameters

Parameter Name	Type	Required	Description
prefix	string	Required	Matching prefix
marker	string		Starting object key marker
maxKeys	number		Maximum number of entries returned per request

---

domainManagement

Unified domain management tool that supports binding, unbinding, querying, and modifying domain configurations

Parameters

Parameter Name	Type	Required	Description
action	string	Required	Operation type: create=Bind domain, delete=Unbind domain, check=Query domain configuration, modify=Modify domain configuration. Allowed values: "create", "delete", "check", "modify"
domain	string		Domain
certId	string		Certificate ID (required when binding a domain)
domains	array of string		Domain list (used when querying configurations)
domainId	number		Domain ID (required when modifying configurations)
domainConfig	object		Domain configuration (used when modifying configurations)
domainConfig.Refer	object
domainConfig.Refer.Switch	string	Required
domainConfig.Refer.RefererRules	array of object
domainConfig.Refer.RefererRules[].RefererType	string	Required
domainConfig.Refer.RefererRules[].Referers	array of string	Required
domainConfig.Refer.RefererRules[].AllowEmpty	boolean	Required
domainConfig.Cache	array of object
domainConfig.Cache[].RuleType	string	Required
domainConfig.Cache[].RuleValue	string	Required
domainConfig.Cache[].CacheTtl	number	Required
domainConfig.IpFilter	object
domainConfig.IpFilter.Switch	string	Required
domainConfig.IpFilter.FilterType	string
domainConfig.IpFilter.Filters	array of string
domainConfig.IpFreqLimit	object
domainConfig.IpFreqLimit.Switch	string	Required
domainConfig.IpFreqLimit.Qps	number

---

queryStorage

Queries cloud storage information, supporting read-only operations such as listing directory files, obtaining file details, and generating temporary download URLs. Returned file information includes file name, size, last modified time, download URL, etc.

Parameters

Parameter Name	Type	Required	Description
action	string	Required	Query operation type: list=List all files in the directory, info=Retrieve detailed information of specified files, url=Obtain temporary download URLs for files. Allowed values: "list", "info", "url"
cloudPath	string	Required	Cloud file path, e.g. files/data.txt or files/ (directory)
maxAge	number		Validity period of temporary links in seconds. Value range: 1-86400. Default: 3600 (1 hour)

---

manageStorage

Manages cloud storage files, supporting operations such as uploading files/directories, downloading files/directories, and deleting files/directories. Delete operations require setting force=true for confirmation to prevent accidental deletion of important files.

Parameters

Parameter Name	Type	Required	Description
action	string	Required	Management operation type: upload=Upload files or directories, download=Download files or directories, delete=Delete files or directories. Allowed values: "upload", "download", "delete"
localPath	string	Required	Local file path. It is recommended to provide an absolute path, e.g. /tmp/files/data.txt
cloudPath	string	Required	Cloud file path, e.g. files/data.txt
force	boolean		Force operation switch. For delete operations, it is recommended to set this to true to confirm deletion. Default: false
isDirectory	boolean		Whether the operation is for a directory. true=directory operation, false=file operation. Default: false

---

downloadTemplate

Automatically download and deploy the CloudBase project template.

Supported templates:

• react: React + CloudBase full-stack application template
• vue: Vue + CloudBase full-stack application template
• miniprogram: WeChat Mini Program + CloudBase Template
• uniapp: UniApp + CloudBase Cross-Platform Application Template
• rules: Only includes AI editor configuration files (covering all mainstream editors such as Cursor, WindSurf, CodeBuddy). Suitable for supplementing AI editor configurations in existing projects.

Supported IDE types:

• all: Download all IDE configurations (default)
• cursor: Cursor AI editor
• windsurf: WindSurf AI editor
• codebuddy: CodeBuddy AI editor
• claude-code: Claude Code AI editor
• cline: Cline AI editor
• gemini-cli: Gemini CLI
• opencode: OpenCode AI editor
• qwen-code: Tongyi Lingma
• baidu-comate: Baidu Comate
• openai-codex-cli: OpenAI Codex CLI
• augment-code: Augment Code
• github-copilot: GitHub Copilot
• roocode: RooCode AI editor
• tongyi-lingma: Tongyi Lingma
• trae: Trae AI editor
• vscode: Visual Studio Code

Special note:

• The rules template automatically includes the current mcp version information (version: 1.8.41) for subsequent maintenance and version tracking
• When downloading the rules template, if a README.md file already exists in the project, the system will automatically protect this file from being overwritten (unless overwrite=true is set)

Parameters

Parameter Name	Type	Required	Description
template	string	Required	The type of template to download. Allowed values: "react", "vue", "miniprogram", "uniapp", "rules"
ide	string		Specifies the type of IDE to download, defaults to 'all' (download configurations for all IDEs). Allowed values: "all", "cursor", "windsurf", "codebuddy", "claude-code", "cline", "gemini-cli", "opencode", "qwen-code", "baidu-comate", "openai-codex-cli", "augment-code", "github-copilot", "roocode", "tongyi-lingma", "trae", "vscode"; Default value: "all"
overwrite	boolean		Whether to overwrite existing files. Default value: false (no overwriting)

---

interactiveDialog

Unified interactive dialog tool supporting requirement clarification and task confirmation. When needing to confirm next steps with users, call this tool's clarify method; for sensitive operations requiring user confirmation, call this tool's confirm method.

Parameters

Parameter Name	Type	Required	Description
type	string	Required	Interaction type: clarify=requirement clarification, confirm=task confirmation. Allowed values: "clarify", "confirm"
message	string		Dialog message content
options	array of string		Optional preset options
forceUpdate	boolean		Whether to forcefully update the environment ID configuration
risks	array of string		Operation risk warnings

---

searchWeb

Performs information retrieval using web search, such as querying the latest news, articles, stock prices, weather, etc. Supports natural language queries and can also directly enter URLs to obtain webpage content.

Parameters

Parameter Name	Type	Required	Description
query	string	Required	Search keywords, questions, or URLs; natural language is supported

---

searchKnowledgeBase

Cloud Development knowledge base intelligent search tool supporting vector-based queries for Cloud Development and Cloud Functions knowledge

Parameters

Parameter Name	Type	Required	Description
threshold	number		Similarity search threshold. Default value: 0.5
id	string	Required	Knowledge base scope, cloudbase=Full knowledge of CloudBase, scf=Cloud Functions knowledge of CloudBase, miniprogram=Mini Program knowledge (excluding CloudBase and Cloud Functions knowledge). Valid values: "cloudbase", "scf", "miniprogram"
content	string	Required	Search content
options	object		Additional options
options.chunkExpand	array of number		Specifies the expansion length of the returned document content. For example, [3,3] represents the front and back expansion lengths. Default value: [3,3]
limit	number		Specifies the value of K for returning the Top K most similar results. Default value: 5

---

queryCloudRun

Query Cloud Run service information, supporting operations such as obtaining service lists, querying service details, and acquiring available template lists. Returned service information includes service name, status, access type, configuration details, etc.

Parameters

Parameter Name	Type	Required	Description
action	string	Required	Query operation type: list=Retrieve cloud hosting service list (supports pagination and filtering), detail=Query detailed information of specified services (including configuration, version, access address, etc.), templates=Retrieve available project template lists (for initializing new projects). Allowed values: "list", "detail", "templates"
pageSize	number		Page size, controlling the number of services returned per page. Valid range: 1-100. Default value: 10. It is recommended to adjust based on network performance and display requirements. Default value: 10
pageNum	number		Page number, used for paginated queries. Starts from 1, default value: 1. Used together with pageSize to achieve paginated browsing. Default value: 1
serverName	string		Service name filter condition, supporting fuzzy matching. For example: entering "test" will match service names like "test-service" and "my-test-app". If left blank, all services will be queried.
serverType	string		Service type filter condition: function=Function-based Cloud Run (simplified development model supporting WebSocket/SSE/file upload, ideal for rapid development), container=Container-based services (traditional container deployment supporting any language and framework, suitable for complex applications). Allowed values: "function", "container"
detailServerName	string		Service name for which to query detailed information. Must be provided when action is detail, and must be an existing service name. The list of available service names can be obtained via list operations.

---

manageCloudRun

Manages Cloud Run services, supporting the following operations in development sequence: initialize projects (can start from templates, template list queryable via queryCloudRun), download service code, local execution (function-based services only), deploy code, and delete services. Deployment supports configurable parameters such as CPU, memory, instance count, and access type. Delete operations require confirmation; setting force=true is recommended.

Parameters

Parameter Name	Type	Required	Description
action	string	Required	Cloud Run service management operation type: init=Initialize new Cloud Run project code from a template (Creates a subdirectory named serverName under the targetPath directory, supports multiple languages and framework templates), download=Download code of existing services from the cloud to local for development, run=Run function-based Cloud Run services locally (For development and debugging, supports function-based services only), deploy=Deploy local code to cloud-based Cloud Run services (Supports function-based and container-based), delete=Delete specified Cloud Run services (Irreversible, requires confirmation), createAgent=Create function-based Agent (Develop AI agents based on function-based Cloud Run). Allowed values: "init", "download", "run", "deploy", "delete", "createAgent"
serverName	string	Required	Cloud Run service name, used to identify and manage services. Naming rules: Supports uppercase/lowercase letters, numbers, hyphens, and underscores; must start with a letter; length 3-45 characters. In init operations, it serves as the subdirectory name created under targetPath; in other operations, it functions as the target service name.
targetPath	string		Local code path, must be an absolute path. Specifies the code directory to deploy in deploy operations, the target download directory in download operations, and the parent directory for Cloud Run services in init operations (a subdirectory named after serverName will be created under this directory). Recommended convention: cloudrun/ directory under the project root, e.g., /Users/username/projects/my-project/cloudrun
serverConfig	object		Service configuration used to set runtime parameters during deployment, including resource specifications, access permissions, environment variables, etc. Uses default configuration if not provided.
serverConfig.OpenAccessTypes	array of string		Public access type configuration, controlling service access permissions: WEB=Public access (default, accessible via HTTPS domain), VPC=Private network access (accessible only within the same VPC), PRIVATE=Internal access (accessible only within the cloud development environment). Multiple types can be configured.
serverConfig.Cpu	number		CPU specification configuration, in cores. Optional values: 0.25, 0.5, 1, 2, 4, 8, etc. Note: Memory specification must be twice the CPU specification (e.g., when CPU=0.25, memory=0.5; when CPU=1, memory=2). Affects service performance and billing.
serverConfig.Mem	number		Memory specification configuration, in GB. Optional values: 0.5, 1, 2, 4, 8, 16, etc. Note: Must be twice the CPU specification. Affects service performance and billing.
serverConfig.MinNum	number		Minimum instance count configuration, controlling the minimum number of running service instances. When set to 0, supports scaling down to 0 (no cost when no requests). When set greater than 0, always maintains the specified number of running instances (ensures quick response but increases costs).
serverConfig.MaxNum	number		Maximum instance count configuration, controlling the maximum number of running service instances. When request volume increases, the service can scale up to the specified number of instances. Once this limit is exceeded, new requests will be rejected. Recommended to set based on business peak demand.
serverConfig.Port	number		Service listening port configuration. Fixed at 3000 for function-based services; customizable for container-based services. The service code must listen on this port to properly receive requests.
serverConfig.EnvParams	object		Environment variable configuration used to pass configuration information to the service code. Format is key-value pairs, e.g., {"DATABASE_URL":"mysql://..."}. Sensitive information should be stored in environment variables rather than hardcoded.
serverConfig.Dockerfile	string		Dockerfile filename configuration, required only for container-based services. Specifies the Dockerfile path used to build container images, defaults to Dockerfile in the project root directory.
serverConfig.BuildDir	string		Build directory configuration, specifying the directory path for code building. Used when the code structure differs from the standard, defaults to the project root directory.
serverConfig.InternalAccess	boolean		Internal access switch configuration, controlling whether to enable private network access. true=Enable internal access (directly callable via CloudBase SDK), false=Disable internal access (public access only)
serverConfig.EntryPoint	string		Dockerfile EntryPoint parameter configuration, required only for container-based services. Specifies the entry point command for container startup, e.g., ["node","app.js"].
serverConfig.Cmd	string		Dockerfile Cmd parameter configuration, required only for container-based services. Specifies the default command for container startup, e.g., ["npm","start"]
template	string		Project template identifier used to specify the template for initializing a project. Available templates can be obtained via the templates operation of queryCloudRun. Common templates: helloworld=Hello World example, nodejs=Node.js project template, python=Python project template, etc. Default value: "helloworld"
runOptions	object		Local runtime parameter configuration, supported only by function-based cloud hosting services. Used to configure runtime parameters for the local development environment without affecting cloud deployment.
runOptions.port	number		Local runtime port configuration, valid only for function-based services. Specifies the port number that the service listens on when running locally, default is 3000. Ensure the port is not occupied by other programs. Default value: 3000
runOptions.envParams	object		Additional environment variable configuration for local runtime, used for local development and debugging. Format is key-value pairs, e.g., {"DEBUG":"true","LOG_LEVEL":"debug"}. These variables take effect only during local execution.
runOptions.runMode	string		Run mode: normal=Normal function mode, agent=Agent mode (for AI agent development). Allowed values: "normal", "agent"; Default value: "normal"
runOptions.agentId	string		Agent ID, used in agent mode, identifies specific Agent instances.
agentConfig	object		Agent configuration, used only during the createAgent operation
agentConfig.agentName	string	Yes	Agent name, used to generate BotId.
agentConfig.botTag	string		Bot tag, used to generate BotId, automatically generated if not provided
agentConfig.description	string		Agent description
agentConfig.template	string		Agent template type, default is blank (blank template). Default value: "blank"
force	boolean		Force operation switch, used to skip confirmation prompts. Default is false (confirmation required). When set to true, all confirmation steps are skipped. For delete operations, it is strongly recommended to set to true to prevent accidental operations. Default value: false

---

createFunctionHTTPAccess

Create HTTP access for cloud function

Parameters

Parameter Name	Type	Required	Description
name	string	Required	Function name
path	string	Required	HTTP access path

---

downloadRemoteFile

Downloads remote files to a specified relative path under the project root directory. For example: resource images such as the Mini Program's Tabbar must be in png format and can be chosen from resources like Unsplash, wikimedia (generally select the 500 size), Pexels, Apple's official UI, etc. to download.

Parameters

Parameter Name	Type	Required	Description
url	string	Required	URL address of the remote file
relativePath	string	Required	Path relative to the project root directory, for example: 'assets/images/logo.png' or 'docs/api.md'. Path traversal operations such as ../ are not allowed.

---

readSecurityRule

Read the security rules and permission types of specified resources (database collection, cloud function, bucket).

Parameter description:

• resourceType: Resource type (database/function/storage)
• resourceId: Unique resource identifier (collection name/function name/bucket name)

Parameters

Parameter Name	Type	Required	Description
resourceType	string	Required	Resource type: database=database collection, function=cloud function, storage=bucket. Allowed values: "database", "function", "storage"
resourceId	string	Required	Unique resource identifier. For databases, it is the collection name; for cloud functions, it is the function name; for storage, it is the bucket name.

---

writeSecurityRule

Set security rules for specified resources (database collection, cloud function, bucket).

Parameter description:

• resourceType: Resource type (database/function/storage)
• resourceId: Unique resource identifier (collection name/function name/bucket name)
• aclTag: Permission category (READONLY/PRIVATE/ADMINWRITE/ADMINONLY/CUSTOM)
• rule: Custom security rule content, required only when aclTag is CUSTOM

Parameters

Parameter Name	Type	Required	Description
resourceType	string	Required	Resource type: database=database collection, function=cloud function, storage=bucket. Allowed values: "database", "function", "storage"
resourceId	string	Required	Unique resource identifier. For databases, it is the collection name; for cloud functions, it is the function name; for storage, it is the bucket name.
aclTag	string	Required	Permission category. Allowed values: "READONLY", "PRIVATE", "ADMINWRITE", "ADMINONLY", "CUSTOM"
rule	string		Custom security rule content, required only when aclTag is CUSTOM

---

activateInviteCode

CloudBase AI programming incentive program, activating user incentives through invitation codes.

Parameters

Parameter Name	Type	Required	Description
InviteCode	string	Required	Invitation code to be activated

---