ramzinex_get_order

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

With no annotations provided, the description bears full burden. It declares the operation as read-only and notes the need for a configured API token, offering a clear safety profile. However, it lacks details on error responses or potential side effects, which are minimal for a read operation.

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 with four sentences covering purpose, authentication, endpoint mapping, and parameter details. The inclusion of a Persian purpose line is slightly redundant but does not detract from overall 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 tool's simplicity (fetch one order by id with two parameters), the description adequately covers purpose, parameters, authentication, and endpoint. The presence of an output schema reduces the need to describe return values.

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 0% description coverage, but the description compensates fully by explaining each parameter: 'order_id' as numeric id of the order, and 'instance' as the configured instance with default behavior. This adds significant value beyond the schema's type and title fields.

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 'Get one of my orders by id (read-only)', specifying the action, resource, and read-only nature. This distinguishes it from sibling tools like 'ramzinex_get_orders' which retrieves multiple orders.

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 the API endpoint and requirement for an API token, implying authentication context. It does not explicitly state when to use versus alternatives, but the specificity of 'by id' provides implicit guidance.

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