get_report_metadata

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

No annotations are present, so the description carries full burden. It only states the action without disclosing behavioral traits: no mention of whether the operation is read-only, what happens on error (e.g., missing key), rate limits, or authentication requirements.

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 a single sentence, front-loaded with the verb and resource. It wastes no words. However, it might be slightly under-specified given the existence of four parameters; additional concise details could improve it without harming conciseness.

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 no output schema, the description should hint at what the metadata JSON contains, or at least state the return type. It does not. Additionally, with four parameters (one required), the lack of any parameter explanation makes the tool description incomplete for an agent to use confidently.

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 50% (two of four parameters have descriptions in the schema), but the tool description adds no parameter information. The key parameter is referenced implicitly ('one SPX report key') but not explained (e.g., format, where to obtain it). The description does not compensate for the missing schema descriptions for 'key' and 'timeoutMs'.

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 verb 'Get' and the resource 'metadata JSON for one SPX report key', making the core function explicit. However, it does not distinguish itself from siblings like 'list_reports' or 'analyze_report', which might also return metadata.

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?

No guidance is provided on when to use this tool versus alternatives. The description lacks context about prerequisites (e.g., needing a valid report key), when to prefer it over 'list_reports' (which might list keys), or when not to use it.

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