tencent cloud

Tencent WorkBuddy Enterprise

DocumentationTencent WorkBuddy EnterpriseCodeBuddyCodeBuddy CodeReference DocumentationTool Reference

Tool Reference

Download
Focus Mode
Font Size
Last updated: 2026-09-30 18:41:47
AI-Translated & Reviewed
Note:
A complete reference for the tools available in CodeBuddy Code, including permission requirements.
CodeBuddy Code includes a set of built-in tools to help you understand and modify your codebase. The tool names in the following table are the identifiers used in permission rules, subagent tool lists, and Hook matchers.
Tool
Description
Permission Required or Not
Agent
Generate subagents with independent context windows to handle tasks.
No
Artifact
Publish a local HTML or Markdown file as an artifact and return a shareable public link (Markdown is rendered by the server into a styled page). Passing existingShareLink updates the same link in place (only the content is refreshed, and permissions remain unchanged). Enabled by default, it can be disabled using CODEBUDDY_ARTIFACT_ENABLED or the cloud-side productFeatures.Artifact (the legacy switches CODEBUDDY_SHARE_LINK_ENABLED / productFeatures.ShareLink remain compatible). Formerly named ShareLink, the old name can still be matched only in permission rules (allow/deny, disallowedTools); the matcher in hooks and the --tools allowlist recognize only the new name, so update the configuration accordingly. See Environment Variables.
Yes
ArtifactControl
Performs control actions on artifacts published by Artifact. Currently, only unpublish is supported: it sets the public link to private. HTML page links are unpublished; Markdown document links have public access disabled and collaborators removed. Accepts a full link or a bare nodeId. Formerly named ShareLinkUnpublish (with the same compatibility scope as Artifact).
Yes
AskUserQuestion
Ask the user multiple-choice questions to collect requirements or clarify ambiguities.
Yes
Bash
Execute Shell commands in your environment. See Bash tool behavior.
Yes
CronCreate
Schedule recurring or one-time tasks within the current session (invalid after exit). See Scheduled Tasks.
No
CronDelete
Cancel a scheduled task by ID.
No
CronList
List all scheduled tasks in the current session.
No
DeferExecuteTool
Execute lazily loaded tools discovered through ToolSearch
No
Edit
Perform precise string replacement edits on files.
Yes
EnterPlanMode
Switch to plan mode and design the implementation plan before coding.
No
EnterWorktree
Create an isolated git worktree and switch to it.
Yes
ExitPlanMode
Submit the plan for user approval and exit plan mode.
Yes
Glob
Find files based on glob patterns.
No
Grep
Search for regular expression patterns in file content.
No
ImageGen
Generate images based on text descriptions, supporting text-to-image and image-to-image generation.
Yes
LeaveWorktree
Exit the worktree session and return to the original directory.
Yes
ListMcpResources
List all resources/templates exposed by connected MCP servers, optionally filtered by server name.
No
LSP
Provide code intelligence through language servers. Automatically report type errors and warnings after file edits. Also support navigation operations such as jumping to definitions, finding references, obtaining type information, listing symbols, finding implementations, and tracing call hierarchies. Requires the code intelligence plugin and its language server binaries.
No
MultiEdit
Perform multiple edits on the same file in a single atomic operation.
Yes
NotebookEdit
Modify Jupyter notebook cell content.
Yes
NotebookRead
Read Jupyter notebook cell content. You can specify a cell_id to read a single cell.
No
PowerShell
Execute PowerShell commands on Windows. Available only on Windows. See PowerShell tool behavior.
Yes
PushNotification
Send terminal/desktop notifications to alert users when long-running or background tasks complete. Lazy-loaded tool. See environment variables.
No
Read
Read file content, supporting images, PDFs, and Jupyter notebooks.
No
ReadMcpResource
Read the content of a specified MCP resource by server + URI. Use with ListMcpResources.
Yes
ReportFindings
Submit issues found during code review as structured fields (file, summary, failure scenario, optional category), rendered as a dedicated list component instead of plain text. Lazy-loaded tool. See environment variables.
No
SendMessage
Send messages to teammates in an Agent team.
No
Skill
Execute Skill in the main conversation.
No
SlashCommand
Execute custom slash commands
Yes
StructuredOutput
Return structured output that conforms to JSON Schema.
No
TaskCreate
Create a new task in the task list.
No
TaskGet
Get full details of a specific task.
No
TaskList
List all tasks and their current statuses.
No
TaskOutput
Get the output of a background task or subagent.
No
TaskStop
Terminate the running background task by ID.
No
TaskUpdate
Update task status, dependencies, details, or delete the task.
No
TeamCreate
Create an Agent team to coordinate collaboration among multiple agents.
No
TeamDelete
Delete the Agent team and its task directory.
No
VideoGen
Generate videos based on text descriptions or input images, supporting text-to-video and image-to-video generation.
Yes
ToolSearch
Search for and load deferred-loading tools, supporting built-in tools and MCP tools; combine with Defer(...)/NoDefer(...) modifiers to adjust the deferred loading status of tools as needed.
No
WaitForMcpServers
Wait for the specified MCP servers to complete connection (by default, wait for all pending servers), up to 5 seconds.
No
WebFetch
Fetch the content of the specified URL and perform AI analysis.
Yes
WebSearch
Perform a web search.
Yes
Workflow
Start Dynamic Workflow to run asynchronously, return the runId immediately, and execute it in the background; pull the result through TaskOutput.
Yes
Write
Create or overwrite a file.
Yes
Permission rules can be configured through the /permissions command or in permission settings. See also tool-specific permission rules.

Tool Alias

Some tools have aliases that can be used interchangeably in permission rules. This applies only to the allow/deny/ask permission rules and disallowedTools. Hook matchers and the --tools allowlist match only by the actual tool name.
Tool
Alias
TaskOutput
BashOutput
TaskStop
KillShell
PowerShell
pwsh,ps
Artifact
ShareLink (former name before renaming)
ArtifactControl
ShareLinkUnpublish (former name before renaming)

Bash Tool Behavior

The Bash tool executes each command in a separate process and has the following persistence characteristics:
The working directory persists across commands. Set CODEBUDDY_BASH_MAINTAIN_PROJECT_WORKING_DIR=1 to reset it to the project directory after each command.
Environment variables do not persist. An export in one command does not take effect in the next command.
Activate your virtualenv or conda environment before starting CodeBuddy Code. To persist environment variables across Bash commands, set CODEBUDDY_ENV_FILE to point to a shell script before starting, or use a SessionStart Hook to populate them dynamically.

Sandbox Mode

The Bash tool supports sandbox isolation, which limits file system and network access. When sandbox is enabled, commands are executed in a restricted environment to prevent unauthorized system access.
You can bypass the sandbox on a per-command basis by using the dangerouslyDisableSandbox parameter, which requires user approval.

Background Execution

You can run a command in the background by using the run_in_background parameter and read its output with the TaskOutput tool. This is suitable for long-running scenarios such as builds and tests.

PowerShell Tool Behavior

The PowerShell tool is available only on Windows and provides native PowerShell command execution capabilities.

Relationship with the Bash Tool

When Git Bash is available: both the Bash tool and the PowerShell tool are available, and the model selects the appropriate tool based on the scenario.
When Git Bash is not available: the Bash tool is automatically disabled, and the PowerShell tool becomes the only shell tool.
The PowerShell tool is not available on macOS/Linux.

Version Adaptation

The PowerShell tool automatically detects the PowerShell version and prioritizes PowerShell 7+ (pwsh), followed by Windows PowerShell 5.1. The syntax guidance in the prompt adjusts automatically based on version differences, such as the && operator being supported only in 7+.

Security Check

The PowerShell tool has a built-in security checker that covers dangerous patterns such as code injection, download execution, privilege escalation, and system destruction. Dangerous commands such as Invoke-Expression and Add-Type are blocked, while system-modifying commands require user confirmation.

Environment Variable

Environment Variable
Description
CODEBUDDY_POWERSHELL_PATH
Explicitly specify the PowerShell path (taking precedence over automatic detection).
CODEBUDDY_USE_POWERSHELL_TOOL
Set to 0 to disable the PowerShell tool.

Lazy-Loading Tools

Some tools, such as those provided through MCP servers and a few built-in tools like PushNotification and ReportFindings, use a lazy loading mechanism. These tools do not appear in the initial tool list and must be discovered and activated through ToolSearch. Once activated, they remain available for the rest of the session.

See Also

Identity and Access Management: permission system, rule syntax, and tool-specific rules
Subagent: Configure tool access permissions for the subagent.
Hooks System: Run custom commands before and after tool execution.
MCP Integration: Extend available tools through MCP servers.
Scheduled Tasks: Use CronCreate to schedule automated tasks.
Agent Teams: a team system for multi-agent collaboration

Previous Topic: Cost managementNext Topic: Channels Reference (Beta)

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback

Search
    Enter keywords to search documentation