List Plan Revision Logs

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

Discloses default behavior (only current date if no date parameters) and pagination details. Annotations already indicate read-only, idempotent. Description adds value without contradiction.

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?

First sentence conveys purpose. Reasonably concise, though some redundancy exists (e.g., 'Returns all...' and later 'Returns a paginated JSON array...'). Overall well-structured and informative.

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 date filtering, pagination, required parameter, and response format. References external docs. Adequately complete given annotations and no output schema.

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%, but description adds context on date parameter interaction (default behavior) and pagination control. This goes beyond mere schema descriptions.

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 'Returns all Plan Revision Logs for the current date.' Identifies verb and resource. However, does not explicitly differentiate from sibling tools among the many list tools.

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: 'Use this to enumerate Daily Log records when you need a paginated overview, to find IDs, or to filter by query parameters.' Also references external documentation for filtering. Lacks explicit when-not-to-use or alternative tool mentions.

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