spraay_sctp_invoice_by_id

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

Annotations already declare readOnlyHint=true and openWorldHint=true. The description adds cost information and confirms read-only, which is redundant with annotations but not contradictory. No additional behavioral details (e.g., response format, error cases, or authentication) are provided beyond what annotations cover.

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: one sentence plus separate phrases for cost and read-only. It is front-loaded with 'Get invoice', making the purpose immediately clear. However, the structure could be more organized, e.g., grouping cost and read-only with usage.

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 simplicity (one parameter, read-only, output schema exists), the description covers the essential points. However, it lacks differentiation from the similar sibling 'spraay_invoice_get' and does not mention any limitations or special considerations.

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 100% coverage with a clear description for the 'id' parameter. The description adds that it is a 'path parameter' and that it fetches a single record, but this is already implied by the name and schema. Thus, it adds marginal value 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 the verb 'Get' and the resource 'invoice', and specifies that it fetches a single record via a path parameter. The name 'spraay_sctp_invoice_by_id' is specific and distinguishes from siblings like 'spraay_invoice_get' and 'spraay_sctp_invoice'.

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 cost and read-only nature, which are useful, but provides no guidance on when to use this tool versus alternatives like 'spraay_invoice_get' or 'spraay_sctp_invoice'. There is no explicit 'when to use' or 'when not to use' information.

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