ecosystem_summary_weekly

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

With no annotations provided, the description carries the full burden. It discloses the side effect of persisting the report via report_save when save_report=True. However, it does not specify whether the tool is read-only or the nature of any other potential side effects.

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 concise, starting with a clear purpose followed by aggregation details and optional persistence behavior. It is front-loaded and contains no unnecessary words, though grouping related information more tightly would improve flow.

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?

Given the presence of an output schema (not shown), the description does not need to detail return values, but it does not mention error cases, prerequisites, or the nature of the markdown content beyond aggregation lists. It is adequate but not fully comprehensive for a tool with side effects.

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 100%, but the description adds value by explaining that save_report=True triggers report_save with report_type='ecosystem-weekly'. This goes beyond the schema. However, it does not provide additional semantics for author or top_movers_limit 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 generates a past-N-days ecosystem briefing in markdown format, listing specific data aggregated (profiles, reviews, archive counters, top star movers). It distinguishes from sibling tools like ecosystem_summary_health or ecosystem_summary_top_n by focusing on a comprehensive weekly briefing.

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 generating ecosystem briefings over a configurable window, but does not explicitly state when to use this tool over alternatives (e.g., other ecosystem_summary tools). There is no mention of prerequisites or exclusions.

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