get_r_report_queries_application_vulnerabilities_os_patch

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

With zero annotations, the description carries the full burden of disclosing behavior, but it only reveals that this is a GET (implying read-only) and gesturally mentions 'any required request headers'. It does not discuss pagination behavior, result sizing, authentication requirements, rate limits, or what happens with unspecified filters. The `additionalProperties: true` query and the open-ended 'any required request headers' leave the runtime contract effectively undefined.

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 functionally compact — two sentences and under 180 characters — and front-loads the HTTP verb and endpoint before parameter placement. The sentence structure is slightly awkward ('Retrieve records' plus 'Calls GET...' reads as a template concatenation), but every clause contributes placement guidance and there is no 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?

The tool has an output schema, so return-shape documentation is already covered, and the description gets the HTTP mechanics right. Yet in a sibling list of 250+ tools with dozens of near-identical get_r_report_queries_application_vulnerabilities_* endpoints, the description doesn't explain which scenario this variant addresses, what its distinguishing filter dimensions are, or how it differs from os_pending_patches and the by_os siblings. An agent could not confidently justify selecting this exact tool without treating external documentation.

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?

The schema has 0% description coverage and consists of four untyped object containers, so the description must compensate. It adds a rough mapping (path_params hold route IDs, query holds filters/pagination, headers hold required values), which is mildly helpful, but the endpoint path contains no placeholders, making 'Provide route IDs in path_params' a boilerplate that may not even apply. No parameter names, value formats, pagination keys, or header names are provided, so the compensation is shallow and generic.

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 verb and resource — 'Retrieve' records via `GET /r/report_queries/application_vulnerabilities_os_patch` — so the agent knows exactly which HTTP call to make. However, it never states what these records represent (os-patch-related application vulnerability data) and gives no semantic differentiation from the very close siblings such as get_r_report_queries_application_vulnerabilities, _application_vulnerabilities_by_os, or get_r_report_queries_os_pending_patches. The purpose is clear at the transport level but vague at the domain level.

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 when-to-use guidance is provided: the description never says when an agent should select this report query over the numerous get_r_report_queries_application_vulnerabilities_* variants that share the same naming pattern. It only describes parameter placement (filters/pagination in query, route IDs in path_params), which is invocation mechanics, not usage selection. No exclusions, alternatives, or contextual conditions are given.

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