gdscript_references_in_file

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

Description adds behavioral details beyond annotations: uses zero-based coordinates, returns list of line/char positions, cheaper than alternative, requires Godot 4.7+. Annotations (readOnlyHint=true, openWorldHint=false) are consistent and enhanced by description.

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?

Three well-structured sentences: purpose, return format + important note, and comparative guidance. No unnecessary words, front-loaded with key information.

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?

For a simple find tool with three parameters and no output schema, the description is fully complete. It explains what it does, what it returns, important coordinate details, and how it compares to alternatives.

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 descriptions already cover all three parameters with zero-based info. Description reinforces zero-based but adds no significant new meaning beyond schema. Baseline 3 for 100% coverage.

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?

Description clearly states 'Find occurrences of a symbol within ONE file.' It specifies the verb (find), resource (symbol in a file), and scope (one file), distinguishing it from the sibling tool gdscript_references which searches all files.

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?

Explicitly guides when to use this tool: 'Much cheaper than gdscript_references, which reparses every .gd file in the project on Godot 4.6+.' Also notes version requirement and that it reports unsupported otherwise, providing clear context for alternative selection.

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