getImportTree

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

Annotations declare readOnlyHint=true, indicating safe read. Description adds no new behavioral detail beyond the name and use case; does not describe output format, recursion behavior, or what qualifies as 'local'. With annotations already covering safety, description adds limited context.

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, no wasted words. All content is relevant and front-loaded with the core purpose.

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?

At three parameters and no output schema, the description is adequate but could be more complete by outlining the return tree structure, clarifying 'local' scope, and noting any performance considerations.

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 describes two of three parameters (maxDepth, includeExternal) with constraints. Description adds no parameter-level information, leaving the 'file' parameter undocumented in both schema and description. Schema coverage is 67%, so baseline of 3 is appropriate.

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 the tool returns a tree of local imports for a file and mentions use cases (understanding deps, circular imports). However, does not explicitly differentiate from similar siblings like 'getDependencyTree' or 'getImportedSignatures'.

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?

Implies usage for dependency analysis and circular import detection, but provides no explicit guidance on when not to use it or alternatives among similar sibling tools.

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