get_activity_heatmap

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

No annotations are provided, so the description carries the full burden, yet it discloses nothing about read-only behavior, permissions, aggregation unit, or return shape. It doesn't even state whether the heat map is scoped to all projects or a single one, which is a meaningful gap for a reporting tool with no safety hints.

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?

One short sentence with no filler, and the core resource is front-loaded. It is efficient, though its brevity comes at the cost of the missing scope information.

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?

With no annotations, no output schema, and a sibling set of overlapping analytics tools, the description should at minimum state scope and that it is a read-only aggregate report. Instead it leaves both unspecified, so an agent cannot confidently distinguish or invoke 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?

Schema coverage is 100% and the single 'days' parameter is fully documented with its default, so the schema does the work. The description's phrase "recent days" only loosely echoes it and adds no format or range guidance, so this is the baseline case rather than an above-baseline one.

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 phrase "Show project activity heat map" names a concrete resource (activity heat map) and verb (show), so the agent knows the general output. However, it doesn't clarify scope — whether the heat map covers one project or all projects, or what 'activity' means (commits, events, tickets) — and gives no differentiation from the adjacent get_project_timeline or get_project_health tools.

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?

There is no statement of when to call this versus get_project_timeline, get_project_health, or get_technology_trends, all of which overlap in reporting project activity over time. No prerequisites or exclusions are given, so the agent must guess from the name alone.

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