get_pipeline_state

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

With no annotations, the description carries the full burden. It explicitly lists the returned components (shaders, resources, samplers, etc.), making the behavior clear. It does not disclose any side effects, but as a read operation, the 'Get' verb implies non-destructive access.

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 structured with a clear header and a bulleted list of return details. It is reasonably concise given the complexity of the return value, though the list could be slightly more compact.

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 the complexity of a graphics pipeline state and the absence of annotations, the description provides a thorough breakdown of what is returned (shaders, resources, UAVs, samplers, etc.). The existence of an output schema is noted, but the description itself is sufficiently complete for an AI agent to understand the tool's output.

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?

Although the input schema has 0% description coverage, the description adds meaning by stating 'The event ID to get pipeline state at,' which clarifies the purpose of the only parameter (event_id). This compensates for the schema's lack of description.

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 'Get the full graphics pipeline state at a specific event,' specifying the verb (Get) and resource (pipeline state). It distinguishes itself from sibling tools like get_draw_call_details or get_shader_info by focusing on the complete pipeline state.

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 does not provide explicit guidance on when to use this tool versus alternatives. It implies usage for retrieving pipeline state at an event, but lacks instructions on when not to use it or what distinguishes it from similar tools like get_draw_call_details.

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