lexware_deeplink_credit_noteRetrieve a direct weblink to view or edit a specific credit note in Lexware by providing its UUID, enabling quick access for management and edits.
Get a direct link to view/edit a credit note in the Lexware web app.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Credit note UUID |
Changes observed during successful MCP inspections.
v3.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false. The description adds the phrase 'view/edit', which could imply mutability, but the tool itself is read-only (returns a link). No additional behavioral traits like return format or permissions are disclosed.
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, efficient sentence conveying the essential purpose without extra words.
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 tool with one parameter and comprehensive annotations, the description is sufficient. It clearly states the output (a direct link) and purpose, though it could mention that the link leads to the Lexware web app for viewing/editing.
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% with a single parameter 'id' described as 'Credit note UUID'. The description adds no additional context beyond the schema, so 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 verb 'Get' and the resource 'direct link to view/edit a credit note', making the tool's purpose explicit. It differentiates from siblings like lexware_deeplink_voucher or CRUD tools by specifying the credit note resource.
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?
Description implies usage for obtaining a URL to a credit note, but does not explicitly state when to use this vs. alternatives like deeplink_invoice or CRUD operations. No exclusion criteria or alternative suggestions are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.