crm_get_timeline

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

Without annotations, the description carries the burden and does reveal the output nature (all field changes, activities, audit trail) and gives error recovery guidance. However, it does not mention pagination behavior, permission requirements, or whether the timeline includes deleted entries, leaving some gaps.

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 well-structured with bolded sections that front-load the core purpose and then efficiently add practical guidance. The workflow and error recovery sections are concise and directly usable, with no fluff.

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 read-only tool with no output schema, the description gives a good high-level understanding of the return content. It also integrates the tool into a larger workflow, which helps the agent decide when and how to use it. However, without an output schema, it doesn't specify the structure of individual timeline entries, so some details remain 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?

The schema provides 100% coverage with descriptions for all six parameters. The description itself does not elaborate on parameter semantics but reinforces the need for record_id via prerequisites. Thus it adds marginal value beyond the 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?

The description clearly states the tool's action ('Get timeline history for a CRM record') and specifies the content ('all field changes, activities, and audit trail'). It differentiates from siblings like crm_get_field_changes by positioning this as the comprehensive audit trail and explicitly suggesting the sibling for specific field tracking.

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 prerequisites (use crm_search_records to find record_id), next steps (crm_analyze_activity_patterns, crm_get_field_changes), and a complete workflow chain. This gives unambiguous guidance on when to use this tool and how it fits into a broader analysis sequence.

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