Locate a Swift symbol's source declaration

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

Without annotations, the description fully discloses behavior: pre-scans with regex, uses SourceKit-LSP, returns position even if LSP fails. This gives the agent a clear model of how the tool operates.

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?

Two concise sentences plus a usage note. Every sentence earns its place: first states purpose and algorithm, second provides workflow context. No redundant 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?

Given 4 params, nested object, and no output schema, the description covers the algorithm, fallback, and typical use case. Lacks explicit return format (e.g., file path and line number), but 'Returns the position' is adequate. Complete enough for the complexity.

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%, baseline 3. Description adds meaning for all parameters: explains symbolName types, hint usage, projectRoot override, and candidatePaths as a speedup. Exceeds baseline by explaining the two-step search process.

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?

Clearly states it finds the file:line where a Swift symbol is declared, using specific verb-resource pairs. Distinguishes from siblings like swiftFindSymbolReferences by mentioning typical use after findRetainers/classifyCycle.

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 says to use after findRetainers/classifyCycle to land in source file. Provides guidance on candidatePaths and hint to speed up search. Does not list alternative tools for different purposes, but implies context.

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