schema

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

Description declares read-only, no side effects, consistent with readOnlyHint annotation. Adds context about what the tool returns (envelope structure, exit codes, etc.), going beyond the annotation.

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?

Three sentences, each essential: first states action, second adds read-only and usage context, third differentiates from siblings. No wasted words, front-loaded.

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?

Despite no parameters or output schema, the description fully explains what the tool does, why to use it, and how it relates to siblings. Adequate for an agent to understand when to invoke it.

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?

No parameters in input schema, so baseline is 4. Description adds no parameter info but that is unnecessary; it instead explains the output content well.

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?

Clearly states it returns the full aicoreutils JSON protocol specification with specific components (envelope structure, exit codes, etc.). Differentiates from siblings like 'tool-list' and 'catalog' by explicitly stating it is not for tool discovery.

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 when-to-use ('Use before invoking other tools to understand response format and error semantics') and when-not-to-use ('Not for tool discovery — use 'tool-list' or 'catalog''), with alternative tool names.

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