get_project_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. It discloses the return structure (Dict with success, entries list, entry_count), sorting order (timestamp desc), and the limit parameter's default. It does not explicitly state that it is read-only, but the verb 'Get' implies a safe read operation. This is reasonably transparent for a read-only tool.

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 compact and front-loaded with the main purpose, followed by clearly labeled Args and Returns sections. Every sentence provides essential information without redundancy.

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?

Despite no output schema or annotations, the description covers the return structure and content categories. It does not explicitly mention that it uses the current project context, but the tool name and sibling set imply that. Overall, it is complete enough for an agent to use it correctly.

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 describes the limit parameter only as 'limit parameter', while the description adds meaning: 'Maximum entries to return (default: 100)'. This fully explains the parameter's purpose and default value, exceeding the schema's minimal descriptor.

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 action ('Get activity timeline'), the scope ('entire project'), and the content types ('status changes, decisions, updates, and git commits'). It distinguishes from sibling tools like get_item_timeline and get_status_history by specifying project-wide scope.

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?

The description implies usage for project-level activity overview, but does not explicitly name alternative tools or provide exclusions. It gives clear context that this is not item-specific, but doesn't mention when to use get_item_timeline instead. This meets the 'clear context, no exclusions' level.

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