ca-docit

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

Thoroughly discloses return fields, that invented_metrics is always false, that MCP does not write files or call LLM, and how focus parameter works (trailing text). No annotations provided, so description carries full burden and meets it.

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?

Front-loaded with key purpose, uses bullet-style listing for clarity. Slightly verbose but each sentence adds value. Could be more streamlined.

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?

Covers return values in detail without output schema, describes main behaviors. Missing parameter explanations for path and workspace_root, but overall fairly complete for a tool with no annotations.

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?

Describes 'focus' and 'analyzer_mode' with details, but 'path' and 'workspace_root' are not explained. Schema coverage is 0%, so description must compensate but is incomplete.

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 it produces a 'single-file context pack for structured companion markdown' with specific outputs (outline, API extract, drift scorecard). Distinguishes from sibling ca-* tools by specifying its unique purpose and default behavior.

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 guidance on when to use ('fast', 'default skips heavy analyzers'), analyzer_mode options, and instructions for the agent. Lacks explicit exclusion of alternatives but context is clear enough.

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