vs_error_logs

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint. Description adds constraint of up to 50 lines, status >=400 filter, and empty result interpretation. Does not contradict 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?

Well-structured with a one-line summary, bullet-like return fields, clear parameter docs. Every sentence adds value; no wasted words.

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?

Complete for a two-parameter read-only log retrieval tool. Covers purpose, return fields, parameter details, limitations (empty result), and usage guidelines. Output schema exists, so return is adequate.

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 0%, so description fully explains parameters: vs_name as exact name from vs_list, since as window in seconds or time units with default '1h'. Adds meaningful usage context beyond 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 it returns recent request error logs for one Virtual Service, listing specific fields (timestamp, status, URI, client IP) and status filter (400+). It distinguishes from sibling vs_analytics by focusing on per-request detail.

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?

Provides explicit guidance to use this tool instead of vs_analytics for per-request detail. Also explains empty result could mean no errors or capture disabled. Missing explicit when-not-to-use scenarios, but sufficient context given.

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