Get fax status

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

The description adds meaningful behavioral context beyond the readOnlyHint annotation by naming the possible statuses (processing, completed, failed) and framing this as a polling operation after sending. This clarifies the asynchronous nature of fax transmission without contradicting the annotations.

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?

Two sentences contain all necessary information with no filler. The core action and scope are front-loaded, and the polling guidance follows naturally.

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?

For a simple single-parameter read operation, the description is complete: it identifies the resource, explains what data will be returned, and tells the agent when to use it. The lack of an output schema is mitigated by the explicit list of returned content.

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%, and the schema already describes transmission_id as 'The transmission id.' The description's 'by id' adds no new semantic meaning beyond what the schema provides, so the baseline score of 3 is appropriate.

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 states a specific verb and resource: 'Get one fax transmission by id,' and enumerates the content returned (status, contact, pages). It clearly distinguishes itself from the sibling listing tool by emphasizing a single transmission identified by id.

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 phrase 'Poll this after sending a fax' gives clear contextual guidance on when to call this tool. It does not explicitly contrast it with ictfax_list_faxes, so it stops short of full when-not-to-use guidance.

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