ghidriff_environment

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

With no annotations provided, the description must carry the burden of behavioral disclosure. It mentions the probe parameter's side effect (launching the interpreter and adding up to a minute) but does not state whether the tool is read-only, what it returns, or whether it has any side effects beyond the probe. The nature of 'checking' implies non-destructive, but this is not explicit.

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 concise and well-structured. It opens with a clear one-sentence purpose statement, then an 'Args:' block that explains the parameter. There is no redundancy or filler; every sentence earns its place.

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 is simple, with one parameter and an output schema (though not shown, it is indicated as present). The description covers the purpose and the parameter's behavior. It does not detail return values or error conditions, but these are presumably covered by the output schema. For a straightforward environment check, this 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 input schema has a single boolean parameter 'probe' with no description, and schema coverage is 0%. The description fully explains the parameter: it triggers launching the ghidriff interpreter to confirm importability and notes the cold-start delay. This adds significant meaning beyond the schema's bare definition.

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 tool's purpose: checking that Ghidra, Java, and ghidriff are installed and reachable. It uses a specific verb ('Check') and identifies the exact resources. It is distinct from all sibling tools, which deal with diffing, job management, or report reading, so there is no ambiguity about what this tool does.

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 explicitly state when to use this tool versus alternatives. It implies a preflight environment check, but there is no mention of scenarios where it should or should not be used, nor does it name any sibling as an alternative. The context of sibling tools makes the purpose obvious, but explicit guidance is missing.

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