list_milestones

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

Annotations already indicate read-only and non-destructive nature. Description adds transparency by detailing returned fields (id, name, probability, position) and emphasizing pipeline-scoped constraints, but does not mention pagination behavior or rate limits.

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?

Four sentences, efficiently front-loaded with purpose, no redundant content, and logically structured from definition to usage context.

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?

Description covers return fields, usage prerequisites, and scope constraints. Minor gap: no mention of pagination behavior despite having pagination params. Annotation coverage is strong, and output schema is absent, so description compensates adequately.

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?

With 0% schema description coverage, the description explains pipelineId indirectly ('within a specific opportunity pipeline', 'discover the pipelineId first via list_pipelines') but omits any details about the page and perPage parameters, which are standard but not described.

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 'List milestones (deal stages) within a specific opportunity pipeline', specifies returned fields, and distinguishes from siblings by noting pipeline-scoping and referencing related tools (list_pipelines, create_opportunity, update_opportunity).

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 advises to use this tool before creating or updating opportunities, mentions that pipelineId must be obtained via list_pipelines, and clarifies that milestones are pipeline-scoped, providing clear context for when and how to use the tool.

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