ecosystem_index_update

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

With no annotations provided, the description carries the full burden of disclosure, and it delivers richly. It details the full pipeline, the config sources (min_stars gate, focus_topics, alert_max_new_per_scan), and explicitly states which tables are touched when dry_run=False vs. untouched when dry_run=True, citing BUG #6/#8 fix and a test name. This is exemplary transparency for a state-mutating operation.

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 front-loaded with the core action and then provides dense technical detail. While every sentence earns its place (config, pipeline, dry_run semantics, test reference), it is fairly long and includes somewhat esoteric details like BUG #6/#8 reference numbers that a typical agent user may not need.

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 having an output schema (which relieves the need to explain return values), the description is exceptionally complete for a complex tool with zero annotations. It explains config sources, the full pipeline order, the dry_run guardrails, which tables are written, and even provides a verification test reference. This leaves no ambiguity about behavior.

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 dry_run parameter is fully described in both the schema and the description. The description reinforces the semantics ('simulate... return diff preview' vs 'persist profile upserts'). Baseline 3 is correct since the schema already documents the parameter thoroughly and the description adds only modest reinforcement.

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 ('Trigger ecosystem index update — runs scanner + computes diff') with a specific verb and resource. It distinguishes itself from siblings like ecosystem_scan by explicitly describing the full pipeline (gh search → classify → diff → alert → persist), which differentiates index_update from the raw scan 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?

The description explains the operational context: scan config comes from project ecosystem settings, and explicitly documents the dry_run behavior (default True = simulate, False = persist). It clearly states when writes happen vs. when they don't, though it doesn't explicitly name alternative tools to use instead.

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