Pipeline savings

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

Beyond the readOnly/idempotent/openWorld annotations, the description discloses the critical fallback behavior (no fabricated $1/GB when no rate is set; headline degrades to percent-and-bytes), the rate_source states, and the cross-destination isolation rule (env-configured rates never leak, envelope stamps siem_actual vs siem_lens). That is substantive behavioral context an agent could not infer from annotations.

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 output content is front-loaded, then use cases, then the siem_lens clause, which is the right ordering. It is dense in places (nested parentheticals about pricing arithmetic) but every sentence carries information relevant to invocation; nothing is filler.

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?

An output schema exists, so return values need no narrative, and the description covers the rate-absent and lens paths thoroughly for a 7-parameter read-only tool. The one real omission is disambiguation from the sibling savings/cost tools, which matters for correct tool selection in this crowded namespace.

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 already 100%, so the baseline is 3, but the description adds genuine meaning: it explains siem_lens as a re-pricing lens that leaves volumes untouched, clarifies the effective_ingest_per_gb override precedence against the account profile rate, and ties a missing rate to the percent-and-bytes headline. It stops short of explaining view, timeRange, or storageCost, which remain schema-only.

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 names a specific resource (pipeline savings) and spells out exactly which quantities are returned: bytes the Receiver keeps out of the SIEM and bytes the Retriever indexed, with an optional dollar overlay. It is far more than a restatement of the name. It does not, however, distinguish itself from the sibling log10x_estimate_savings or log10x_cost_options, leaving an agent to guess which savings tool to pick.

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?

Clear usage triggers are given verbatim: 'how much are we saving', 'pipeline ROI', 'what is the Log10x stack worth financially', plus the specific condition for siem_lens (what-if destination pricing). No explicit when-not guidance or named alternative tool is provided, so an agent facing the savings/estimate_savings overlap gets no routing rule.

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