crm_get_pipeline

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

Annotations already declare readOnlyHint/idempotentHint, but the description adds valuable context beyond that: requires 'crm.schemas.deals.read' scope, is 'not cached and always reaches HubSpot' (unlike the pipeline list), and 'Raises a not-found error for an unknown id.' These are meaningful behavioral traits not present in annotations. No 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?

The description is concise and front-loaded with the core purpose. Each sentence adds value: purpose, usage guidance, discovery alternative, and behavioral caveats. No filler or redundancy. Despite several sentences, all are necessary for correct tool use.

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?

For a simple one-parameter tool with an output schema and strong annotations, the description covers purpose, when to use, auth scope, caching/network behavior, and error handling. It is fully complete for the task context; nothing critical is missing.

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 has 100% coverage for the single parameter with description 'Deal pipeline id, as returned by crm_list_pipelines.' The tool description repeats this context ('pipeline id is already known', 'by id') but adds little beyond the schema. With high schema coverage, baseline is 3; description offers no extra semantics.

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 starts with 'Fetch one deal pipeline by id with its stages sorted by display order,' a specific verb+resource combination that clearly states the tool's function. It also distinguishes from sibling tool crm_list_pipelines by focusing on fetching a single pipeline by ID, not listing all pipelines.

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 explicit when-to-use guidance: 'Use this when the pipeline id is already known and only its stages are needed.' Also names the alternative: 'Use crm_list_pipelines to discover ids.' This directly addresses tool selection and differentiates from the list sibling.

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