Skip to main content
Glama

Get invoice draft link

well_get_invoice_draft_link
Read-only

Get the link to the web page that shows one draft invoice, read only, to whoever holds it: the sheet as it stands, what the draft still lacks before it can be issued, and one button back to WhatsApp. The first call for a draft makes the link; every later call returns the same address, and call_to_action updates its button. The link stops when the draft is issued or deleted. It changes nothing on the invoice; it only records that the link was handed out. Only a workspace owner or admin can get the link.

REQUIRED: invoice_id (an open draft of this workspace). OPTIONAL: call_to_action ("back_to_whatsapp", "send_on_whatsapp" or "none"); send_again (true when the person asks for the link again).

Returns url, or refusal_reason: "not_found" (no such invoice here), "not_an_open_draft" (the invoice is issued, paid or canceled) or "unavailable" (this deployment has no web app address) or "admin_only" (the caller is not a workspace owner or admin; say so and give no link).

When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.

Input Schema

NameRequiredDescriptionDefault
invoice_idYesThe draft invoice the link opens.
send_againNoSet true only when the person asks to see the link again in a later turn, so Well sends the address once more. Left out, Well sends an address it already sent in this chat only when it changed.
workspace_idNoTarget workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose which.
call_to_actionNoThe one button the page shows under the draft: "back_to_whatsapp" returns to this chat, "send_on_whatsapp" opens it with a message asking Well to issue this draft, "none" shows no button. Omitted, a link handed out before keeps its button and a new one shows none.
conversation_idNoThe conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation.
workspace_scopeNoRestrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace.

Output Schema

NameRequiredDescriptionDefault
urlYesThe page address that opens the draft, read only. The same address on every call for the same draft.
errorNo
successYes
invoice_idNo
refusal_reasonNo
conversation_idNoThe conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation.
newly_connectedNoTools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later.
resolved_workspaceNoThe workspace that answered, when the caller named none and the token authorizes several.
conversation_id_noteNoPresent only when the server opened a fresh lane, stating that no choice recorded earlier was read.
conversation_id_sourceNoWhere the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • removedOutput schema / properties / resolved_workspace / properties / name / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / resolved_workspace / properties / name / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / url / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / url / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  2. Changed1 schema field changed
    • addedInput schema / properties / send_again
      Added value: +{
      +  "description": "Set true only when the person asks to see the link again in a later turn, so Well sends the address once more. Left out, Well sends an address it already sent in this chat only when it changed.",
      +  "type": "boolean"
      +}
  3. Changed1 schema field changed
    • changedOutput schema / properties / refusal_reason / enum
      Previous value: -[
      -  "not_found",
      -  "not_an_open_draft",
      -  "unavailable"
      -]New value: +[
      +  "not_found",
      +  "not_an_open_draft",
      +  "unavailable",
      +  "admin_only"
      +]
  4. Changed1 schema field changed
    • changedOutput schema / properties / newly_connected / description
      Previous value: -"Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. Start the reply with one line per entry, in the person's language: \"<name> is connected.\". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later."New value: +"Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: \"<name> is connected.\". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later."
  5. Added

TDQS

A4.1/5.0
Behavior4/5

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

Goes well beyond the annotations: discloses that only a workspace owner/admin can get the link, that the link persists until the draft is issued or deleted, and that it 'records that the link was handed out.' That last point is a subtle side effect that sits slightly against readOnlyHint=true, but the description is otherwise candid about the idempotent get-then-record pattern.

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-loads the core purpose, then uses REQUIRED/OPTIONAL/Returns labels and refusal reasons to structure the rest. It is dense but nearly every clause carries operational value; a couple of sentences (button-url description) could be tightened.

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?

For a 6-parameter tool with workspace routing, auth gating, and an output schema, the description covers everything an agent needs: lifecycle, refusal reasons, permissions, and how workspace_id/workspace_scope interact with the token. Since an output schema exists, return shape need not be spelled out, and the key failure modes are named anyway.

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?

With 100% schema coverage the baseline is 3, but the description adds situational meaning: invoice_id must be 'an open draft of this workspace,' send_again is for when the person asks again, and call_to_action defines the single button. This contextualizes the enum values beyond the schema's own descriptions.

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

Purpose4/5

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

States a specific verb and resource: 'Get the link to the web page that shows one draft invoice, read only, to whoever holds it,' and specifies what the page contains. The purpose is unambiguous, though it never names the adjacent tools (e.g. delete_invoice_draft_link, get_invoice_portal_link) that an agent might confuse it with.

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 clear operating conditions: the first call mints the link, later calls return the same address, and send_again/call_to_action govern button behavior. It also explains the workspace-routing choice (call directly when one workspace, pass workspace_id when several). What's missing is explicit when-not-to-use guidance versus sibling link tools.

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