Get Module Details

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

Discloses that it returns files, dependencies, examples. Hints at an implied action (adding entries) when get-slice is empty. With no annotations, the description does well but could explicitly state whether the tool is read-only or has side effects.

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 concise sentences: purpose, usage guidelines, and a behavioral note. No superfluous words. Front-loaded with the core function.

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 an output schema exists, the description covers what is returned and when to use. Could mention error conditions or prerequisites (e.g., module must exist), but overall sufficient for an agent to use the tool correctly.

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 covers both parameters fully (100% coverage). The description adds value by requiring exact match for moduleName, which is not in the schema. No further detail needed for projectId.

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 returns a module's full detail (files, dependencies, examples). It distinguishes from sibling tools like get-slice (for cross-cutting lists) and get-project-architecture.

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 states when to use: 'Use when you know the module name from get-project-architecture or list-modules.' Also provides a when-not-to: 'For cross-cutting API/domain lists use get-slice.' Includes a specific workflow hint about adding entries if get-slice is empty.

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