get_pending_changes

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

No annotations are provided, so the description carries the full burden. It says 'check' which implies a non-mutating operation, but it does not explicitly state read-only behavior, potential side effects, or error handling. It also does not describe what happens if the subsystem is invalid or if there are no pending changes, leaving the agent to infer from the name.

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?

A single, concise sentence that front-loads the action and clearly defines the parameter scope. No redundant words or filler. The structure is optimal for a simple check tool.

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?

For a tool with one parameter and an output schema, the description covers the essential purpose and parameter values. It does not explain the return format, but the output schema likely handles that. It also omits usage context (e.g., calling before apply_changes), but that is covered under usage guidelines. Given the simplicity, it is largely complete.

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 provides only a string parameter with no description (0% coverage). The description compensates by enumerating the valid values ('firewall', 'dhcp' or 'dns'), giving the agent precise knowledge of what the parameter expects. This adds significant meaning beyond the raw 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 states a specific verb ('Check whether') and a clear resource ('a subsystem has staged, unapplied changes'). It explicitly lists the valid subsystem values, making the purpose unambiguous and distinct from sibling mutation tools like add/delete/apply.

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?

There is no guidance on when to use this tool versus alternatives. It does not mention that this should be called before apply_changes, nor does it state any exclusions or conditions that would lead an agent to choose a different tool. The description only states what it does, not when.

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