get_directory_line

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

No annotations are provided, so the description must carry the burden. It implies a read-only, non-destructive operation via 'Look up' and the HTTP GET method in the endpoint. However, it does not disclose potential errors, rate limits, or required permissions explicitly.

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 sentence, front-loads the core purpose, and includes the endpoint. Every word is necessary and contributes to clarity.

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?

The tool has a simple signature with one parameter and an output schema. The description covers the essential lookup action. It omits error handling or edge cases, but given the output schema exists, the description is sufficiently complete for this straightforward 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?

The parameter id_instance is fully described in the input schema (100% coverage). The description adds no additional semantic details beyond restating the purpose, so the baseline of 3 applies.

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 'Look up' and the resource 'directory line' with the specific identifier 'directory instance ID'. It distinguishes from siblings like get_directory_line_by_code by specifying the lookup key. Including the HTTP endpoint adds precision.

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 clearly indicates when to use this tool: to retrieve a directory line by its instance ID. While it does not explicitly state when not to use it or mention alternatives, the context from the tool name and sibling names implies the distinction (e.g., use get_directory_line_by_code for code-based lookup).

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