Skip to main content
Glama
fgui-agent-bridge

fgui-agent-bridge

by Wilson520403

fgui_open_document

Opens a FairyGUI component document by package and item name for read-only inspection, optionally targeting a branch.

Instructions

按包名和资源名打开 FairyGUI 组件文档。

省略 branch 时跟随当前活跃分支,branch="" 表示主干。只读打开不要求该分支处于活跃状态, 但后续写该文档前仍需切换。

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": {
      "package_name": "<package_name>",
      "item_name": "<item_name>"
    },
    "name": "fgui_open_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
branchNo
item_nameYes
package_nameYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.8.25
    • addedInput schema / properties / branch
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Branch"
      +}
  2. First observedv0.6.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations supplied, the description carries the full burden, and it does disclose the important trait that opening is read-only and works across inactive branches, plus the follow-on write caveat. It does not say whether opening changes the active document, what happens if the package or item does not exist, or whether the document is locked or cached. Those gaps keep it at a minimum-viable level for an unannotated tool.

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

Conciseness4/5

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

Two short sentences with the core action front-loaded and the branch semantics immediately after. No filler or repetition of the tool name. Slightly more structure, such as separating the branch rule from the write caveat, would improve scanability.

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

Completeness3/5

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

An output schema exists, so return values need not be explained, and the branch semantics are covered. However, for an open-document operation in a tool family that includes fgui_get_active_document, the description never says whether this changes which document is active, nor how missing packages or items are reported. That is a meaningful omission for a 3-parameter tool with no annotations.

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

Parameters3/5

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

Schema description coverage is 0% and all three parameters are bare titles, so the description must compensate. It adds real meaning for branch (null means follow the active branch, empty string means trunk), which the schema does not convey. It does nothing for package_name and item_name beyond restating them conceptually, and does not clarify name format, path syntax, or case sensitivity.

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: open a FairyGUI component document by package name and item name. That is unambiguous and matches the two required parameters. It does not differentiate itself from siblings like fgui_get_active_document or fgui_list_items, so it falls short of a 5.

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 concrete routing context: omit branch to follow the currently active branch, pass an empty string for trunk, and note that read-only opening does not require the branch to be active while later writes do. That tells an agent how to pick the branch value and what a subsequent write workflow requires. There is still no explicit statement of when to use this versus siblings such as fgui_get_active_document or fgui_list_items.

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