lexware_deeplink_order_confirmationRetrieve a direct link to view or edit a specific order confirmation in the Lexware web app by providing its UUID, enabling quick access for management tasks.
Get a direct link to view/edit an order confirmation in the Lexware web app.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Order confirmation UUID |
Changes observed during successful MCP inspections.
v3.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds that the link allows viewing and editing, which is consistent. However, it does not disclose details like whether authentication is required or link expiration behavior. Additional context beyond annotations is minimal.
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?
A single, clear sentence with no unnecessary words. It front-loads the purpose and is appropriately concise.
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 deeplink tool with one parameter and no output schema, the description sufficiently explains the purpose. It does not elaborate on the link format or behavior, but that is not critical for a tool of this complexity.
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 only parameter 'id' is fully described in the schema with format and description. Schema coverage is 100%, so the description adds no further meaning. Baseline 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 tool returns a direct link to view or edit an order confirmation in the Lexware web app. It uses a specific verb ('get') and resource ('order confirmation'), and distinguishes from sibling deeplink tools by specifying the document type.
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 this tool is for obtaining a deep link, but it does not explicitly state when to use it versus alternatives like lexware_get_order_confirmation (which returns data) or other deeplink tools. No context about when not to use it is provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.