crm_get_timeline

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

No annotations are provided, so the description carries the full burden. 'Get timeline' implies a read-only operation, but it does not disclose what the returned timeline contains, whether it is paginated, requires specific permissions, or covers only currently-visible activities. Minimal disclosure beyond the basic purpose.

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?

A single efficient sentence with no filler. The core object (timeline), content (activities and stage changes), and target (lead or deal) are front-loaded in a compact phrasing.

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 single-parameter get tool it is minimally adequate, but with no output schema and no annotations, an agent lacks detail on the returned structure or ordering. Given the tool sits among many CRM tools, more context on what a 'timeline' includes would improve completeness.

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 description coverage is 0%, so the description must compensate. It does clarify that entity_id refers to a lead or deal identifier, which adds meaning beyond the bare string type, but it does not detail the expected format of the ID or how leads vs deals are distinguished.

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?

States a specific verb and resource: fetching the timeline of activities and stage changes for a lead or deal. It is clearly scoped but does not explicitly differentiate from siblings like crm_get_pipeline or crm_log_activity, which would be helpful given the large sibling list.

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?

No statement of when to use this tool versus alternatives such as crm_get_pipeline or audit logs. No exclusions, prerequisites, or comparison to sibling tools are provided, leaving the agent to infer when this is the right choice.

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