Skip to main content
Glama
fgui-agent-bridge

fgui-agent-bridge

by Wilson520403

fgui_create_branch

Create a branch and branch roots for every package using the native project API, with immediate and irreversible on-disk changes; optionally switch to the new branch and save open documents first.

Instructions

创建分支并为每个包建立分支根;走工程原生 API,立即落盘且不可撤销。

switch_to=True 创建后切换活跃分支;有未保存文档时需同时 save_open_documents=True。

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "fgui_create_branch"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
verifyNo
switch_toNo
save_open_documentsNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.8.25

TDQS

A4.3/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full behavioral burden and does so: it discloses that the native project API is used, that changes are written to disk immediately ('立即落盘'), and that the operation is irreversible ('不可撤销'). It also flags the unsaved-document prerequisite, which is exactly the kind of side effect an agent must know before calling a mutation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences: the first front-loads purpose plus the irreversible-write warning, the second covers the two behavioral flags. No filler, and the most decision-relevant fact (irreversibility) comes before the parameter guidance.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations, the description covers the safety profile, persistence behavior, and conditional prerequisites, and an output schema exists so return values need no explanation. The only shortfall is the undocumented `verify` parameter, which an agent would have to guess at.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate; it explains switch_to and save_open_documents including their interaction with unsaved state. `name` is self-evident, but `verify` (defaulting to true) is left completely unexplained, which is the one remaining gap in an otherwise strong compensation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('create branch') plus an extra effect ('establish a branch root for each package'), so the agent knows exactly what will be produced. It distinguishes itself from the read-only siblings like fgui_list_branches by implication, but never names fgui_switch_branch as the alternative for switching, so sibling differentiation is only partial.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives a clear conditional rule: set switch_to=True to activate the new branch after creation, and set save_open_documents=True when unsaved documents exist. That is real when-to-use guidance tied to state. It stops short of exclusions, e.g. whether to use this versus fgui_switch_branch when the branch already exists.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools