pipelines_get

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

No annotations provided, so description carries full burden. It details return values: pipeline configuration, stages, deal totals, conversion statistics, stage order/probabilities, rotten deal settings. Good transparency about read-only behavior, though idempotency is not explicitly stated.

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?

Well-structured with clear sections: purpose, return info, workflow tips, use cases. Slightly repetitive (e.g., 'Returns pipeline details...' appears early and later), but overall efficient and front-loaded.

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?

No output schema, so description compensates by listing return components (stages, statistics, settings). Common use cases and parameter examples give practical context. Could be more specific about response structure, but sufficient for a get tool.

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?

Input schema covers both parameters with descriptions. Description adds value via workflow tips and explicit examples (e.g., '{"id": 1}' and '{"id": 1, "totals_convert_currency": "USD"}'), going beyond schema.

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 'Get detailed information about a specific pipeline' with verb+resource. Lists what is returned: pipeline details, stages, deal statistics. However, does not explicitly differentiate from sibling tools like pipelines_list, pipelines_get_stages, or pipelines_deals.

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?

Description includes 'Workflow tips' and 'Common use cases' with parameter examples (e.g., using totals_convert_currency). Provides context for when to use, but lacks explicit exclusions or guidance on when not to use vs. siblings.

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