List top-level symbols in a Swift file

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

No annotations provided. Description adds context like 'Cheap orientation' and explains parameter behavior (topLevelOnly effect). Lacks disclosure of potential side effects or authorization needs, but does cover some behavioral aspects beyond schema.

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 sentences, front-loaded with main action. No wasted words. Every sentence provides value.

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 tool with 3 parameters and no output schema, the description adequately covers purpose, parameter behavior, and usage context. Missing some details like exact output format, but overall complete enough.

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 67%. Description adds meaning for topLevelOnly ('Default true keeps responses small') but adds little for filePath (already clear in schema) and nothing for projectRoot. Adds marginal value beyond schema.

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 the tool returns top-level symbols (classes, structs, etc.) from a Swift file via SourceKit-LSP's documentSymbol. Distinguishes itself by mentioning it's useful after swiftGetSymbolDefinition, which is a sibling tool.

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?

Provides clear context: 'Useful right after swiftGetSymbolDefinition lands you in a new file.' However, it does not explicitly state when not to use it or mention alternatives, but the context is sufficient.

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