gdscript_sync_files

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

The description adds value beyond annotations by stating it 'Reads content from disk for all specified files' and 'Returns: diagnostics for all synced files.' Annotations already indicate idempotentHint=true and destructiveHint=false, so the description supplements behavioral context without contradicting them.

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

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

The description is three concise sentences, each serving a specific purpose: stating the core action, describing the return value, and providing usage guidance. No wasted words; front-loaded with the primary throughput.

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

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

Given the tool's simplicity (single parameter, no output schema, idempotent annotation), the description covers all necessary context: what it does, when to use, return value, and behavior (reads from disk). No gaps remain for an agent to misinterpret.

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

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

Schema coverage is 100% for the single 'files' parameter. The description adds the behavioral note that the tool 'Reads content from disk', clarifying that it expects paths, not file contents. This extra context enhances parameter meaning beyond the schema's description.

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

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

The description clearly states the tool's purpose: 'Batch sync multiple modified files with Godot's LSP'. It specifies the verb (sync), resource (modified files), and scope (batch), distinguishing it from the sibling tool gdscript_sync_file which syncs a single file.

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

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

Explicit when-to-call guidance: 'AFTER modifying multiple .gd files with Edit/Write tools.' The description also explains why it is preferable to the alternative: 'More efficient than calling gdscript_sync_file repeatedly.' This provides clear usage context.

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