ipc_read_file

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered; the description adds real substance beyond that — ADS transport with no share requirement, binary-to-base64 conversion, target-resolved path prefixes, and a warning that the legacy C:\TwinCAT\3.1\Boot path is stale. It stops short of covering error behavior or the max_bytes truncation semantics.

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?

Front-loaded with the action and transport before diving into prefix details, and every clause is informative. The stale-legacy-path caution is long, but it earns its place by preventing a common misinterpretation.

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?

An output schema exists so return values need no explanation, and annotations cover safety. The path semantics are thoroughly covered for the complex TwinCAT target layout; only as_text/encoding/max_bytes semantics are missing, a minor gap for a read tool.

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 description coverage is 0%, so the description must carry all four parameters. It thoroughly documents the 'path' parameter via prefix guidance and hints at 'as_text' via 'Binary → base64', but leaves 'encoding' and 'max_bytes' entirely unexplained. Partial compensation only.

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?

Specific verb+resource: 'Read a file from the target IPC's file system over ADS (no share needed)'. The transport detail and 'Binary → base64' make the operation unambiguous. It does not explicitly name the sibling proj_read_file, but the 'target IPC's file system' scoping distinguishes it well enough.

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 prefix guidance ('Prefer the OS-independent prefixes...') is strong invocation advice, but the description never states when to use this tool versus alternatives like proj_read_file or how it relates to ipc_list_dir. Usage is implied through path conventions rather than explicit selection criteria.

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