Explain Error Code

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

Description claims the tool saves findings to knowledge/manuals for future use, implying a write operation. However, annotations declare readOnlyHint=true, indicating no state modification. This is a direct contradiction, significantly reducing transparency.

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, with front-loaded main purpose. Every sentence adds value without redundancy, achieving clarity in few words.

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 tool's complexity (multi-platform error decoding), the description covers input formats, search sources, fallback web search, and saving behavior. With an output schema present and thorough annotations, this is comprehensive.

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?

Schema coverage is 100%, so baseline is 3. Description adds value by explaining acceptable input formats for errorCode (hex, IEC, decimal) and describing search sources (CiA 402, Festo PtP, etc.), which enriches the meaning of both parameters.

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 decodes Festo/CODESYS/EtherCAT error codes using all embedded references. It specifies the verb 'decode' and resource 'error codes', distinguishing it from sibling tools like review_st_code or plc_lookup.

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?

Explicitly states 'USE WHEN: any Festo/CODESYS/EtherCAT error code appears' with examples like 0x..., 16#..., drive fault, AL status. It also warns against guessing, providing clear usage context.

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