gcode_translate

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

The description reveals that the tool shows each command, its meaning, and current machine state context. This provides good insight into the output behavior, though it lacks explicit discussion of side effects or permissions (likely none needed).

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 adding distinct value with no fluff. The primary purpose is stated first, followed by input options and output details.

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 presence of an output schema (not shown), the description need not detail return values. It covers the main functionality, input methods, and output context. Could be strengthened by mentioning any limitations.

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 0% description coverage. The description partially explains the first parameter (file path or string) but completely ignores the second parameter 'max_lines'. This leaves significant ambiguity for the agent.

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 translates G-code to plain English line by line, which is a specific verb and resource. It distinguishes from sibling tools that deal with timing, macros, or safety.

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 mentions it accepts a file path or raw G-code string, providing clear input options. However, it does not explicitly guide when to use this tool versus its siblings or when not to use it.

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