ecosystem_diff_period

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

No annotations are provided, so the description must disclose behaviors. It mentions that the diff is computed dynamically from the event log (v1.6.0 event sourcing), which implies a read-only operation and provides version context. However, it does not address potential side effects, performance implications, or data freshness guarantees, 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 three concise sentences: first states the main action, second describes the output, and third provides context (replacing legacy). Every sentence adds value with no unnecessary words, and the structure is front-loaded with the core purpose.

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?

The description explains the output (summary counts by event type) and differentiates from the legacy approach, which is sufficient given the existence of an output schema. However, it could mention edge cases (e.g., empty result) or performance notes, but overall it is complete enough for a diff tool.

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% with both parameters (from_date, to_date) described in the schema as YYYY-MM-DD inclusive. The description does not add additional semantics beyond what the schema provides, so it meets the baseline without improvement.

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 that the tool returns a time-period diff computed dynamically from the event log, grouping events by type (new repos, topics, stars, status). It uses a specific verb (return) and resource (diff), and distinguishes itself from the legacy index_diff snapshot approach.

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 provides clear context by stating it replaces the legacy index_diff snapshot approach, implying it is the preferred method for dynamic diffs. However, it does not explicitly state when to use this tool versus other ecosystem tools like ecosystem_summary_* or ecosystem_repo_events.

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