Skip to main content
Glama

invoice_share

Returns share_url, the client's view link for this invoice, and the full document (parties, lines, totals in integer CENTS) in one call. action: 'get' (default) returns the live link; 'rotate' replaces it and the old link stops working; 'revoke' turns it off. A link the owner turned off stays off for agents: 'get' never re-issues it, and an agent's 'rotate' waits for the owner's approval. Anyone with the link can open the page until the invoice is cancelled or 90 days after payment (see link_serving). There is no PDF file yet; the link opens a print-ready page the client can print or save as PDF. Nothing is sent: give the link to the owner, who decides whether it goes to the client.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "invoice_share"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe invoice id (invoice_list shows them).
actionNoget (default): the live link, made the first time. rotate: replace it with a new link; the old one stops working. revoke: turn the link off.
invoice_idNoAlias of id.
fresh_afterNoOmit it. Only when an error's next_call includes fresh_after, send that call exactly as given.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations: rotating invalidates the old link, a revoked link stays revoked for agents, an agent's rotate waits on owner approval, and the link is publicly openable until cancellation or 90 days after payment. This surfaces irreversibility, approval gating, and exposure risk that readOnlyHint/destructiveHint flags alone could not convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with purpose and return shape, then lifecycle caveats, then the 'nothing is sent' workflow rule. It is somewhat long and the action enumeration partially duplicates the enum description in the schema, but no sentence is filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description takes on the burden of describing the return value (share_url plus parties, lines, totals in integer CENTS) and it does. Link lifetime, revocation behavior, approval gating, and the no-PDF clarification together cover what an agent needs to call this correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% with enum-documented actions, so the schema already carries the parameter burden. The description adds value by framing what the returned share_url represents in each action state, though it does not mention 'fresh_after' or the id alias at all.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb-and-resource pair up front ('Returns share_url, the client's view link for this invoice, and the full document') plus scope ('in one call'). The three action modes are enumerated, so an agent can distinguish this from invoice_read, invoice_pdf, or quote_share without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit conditions for each action ('get' default, 'rotate' replaces, 'revoke' turns off) and a downstream rule ('give the link to the owner, who decides whether it goes to the client'). It does not explicitly name a sibling alternative (e.g. invoice_pdf), though 'There is no PDF file yet' implicitly contrasts the two.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources