fsuipc_read_known

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

No annotations are provided, and the description gives no behavioral details beyond the basic read action. It does not disclose side effects, safety, output format, or error conditions. Since annotations are absent, the description carries the full burden but provides minimal information.

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 a single concise sentence with no fluff. It is front-loaded with the core action. However, it could be more structured to include additional details without losing conciseness.

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 existence of an output schema, the description may not need to detail return values, but it lacks clarity on prerequisite calls (e.g., fsuipc_status), error handling, and differentiation from sibling tools. The description is incomplete for helping an agent use the tool correctly in all scenarios.

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 schema has one parameter 'key' with no description (0% coverage). The description says 'by key' and hints that keys come from fsuipc_status.known_offsets, but does not explain the format, accepted values, or how to obtain them. This adds minimal meaning beyond the schema.

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 it reads a built-in known offset by key, referencing fsuipc_status.known_offsets for valid keys. This differentiates it from other read tools like fsuipc_read_offset, but could be more explicit about what is returned.

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 implies that the key should come from fsuipc_status.known_offsets, but does not explicitly state when to use this tool over fsuipc_read_offset or other siblings. No exclusion criteria or prerequisites are provided.

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