Well

Stop sharing a document link

well_revoke_document_shares

DestructiveIdempotent

Stop a document download link, so it no longer opens for anyone, including in an email already sent. Call it when the user asks to stop sharing, unshare or revoke a link.

well_draft_email puts such a link in the body of every email draft it shows (a URL ending in /document-shares/<code>). Pass exactly one of:

url: the link exactly as the user pasted it.
invoice_id: when the user names an invoice instead, by its id or its number (INV-2026-0148); every live link of that invoice stops. A number several invoices carry is refused with each one named: ask which.
document_id: when the user names another PDF that was linked.

Only an owner, an admin or a member who holds the invoice right can stop a link. When the call is refused for that, tell the user who can stop it and do not retry.

The document itself stays in Well. A later well_draft_email for the same document makes a new link, and the stopped one never opens again. Tell the user plainly that the link no longer opens. When revoked_count is 0, say this workspace had no live link to stop; never say a link was stopped.

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

Name	Required	Description
`url`	No	The document link the user pasted.
`invoice_id`	No	The UUID of the invoice to stop sharing. When the person named it by its reference instead (DRAFT-0007, the draft's own reference, or an issued number), pass that reference: Well resolves it, and refuses a reference that names several invoices.
`document_id`	No	The PDF whose link stops.
`workspace_id`	No	Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which.
`conversation_id`	No	The 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.
`idempotency_key`	No	Optional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation.
`workspace_scope`	No	Restrict 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

Name	Required	Description
`error`	No
`message`	No
`success`	Yes
`revoked_ids`	No
`revoked_count`	No
`conversation_id`	No	The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation.
`newly_connected`	No	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.
`resolved_workspace`	No	The workspace that answered, when the caller named none and the token authorizes several.
`conversation_id_note`	No	Present only when the server opened a fresh lane, stating that no choice recorded earlier was read.
`conversation_id_source`	No	Where 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.

Changed2 schema fields changedOct 28, 2026
- 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"
+]
```

Changed1 schema field changedOct 19, 2026

changedInput schema / properties / invoice_id / description

Previous value: -"The UUID of the invoice to stop sharing. When the person named it by its reference instead (DRAFT-061, the number a draft shows, or an issued number), pass that reference: Well resolves it, and refuses a reference that names several invoices."New value: +"The UUID of the invoice to stop sharing. When the person named it by its reference instead (DRAFT-0007, the draft's own reference, or an issued number), pass that reference: Well resolves it, and refuses a reference that names several invoices."

Changed1 schema field changedOct 12, 2026

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."

Changed1 schema field changedOct 8, 2026

addedInput schema / properties / workspace_scope

Added value: +{
+  "description": "Restrict 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.",
+  "enum": [
+    "family"
+  ],
+  "type": "string"
+}

Changed1 schema field changedOct 6, 2026

addedOutput schema / properties / newly_connected

Added value: +{
+  "description": "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.",
+  "items": {
+    "additionalProperties": false,
+    "properties": {
+      "name": {
+        "type": "string"
+      },
+      "service_id": {
+        "type": "string"
+      }
+    },
+    "required": [
+      "name",
+      "service_id"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}

AddedOct 2, 2026

TDQS

A4.6/5.0

Behavior5/5

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

Annotations already declare the destructive/write/idempotent profile, and the description adds substantial context beyond them: the permission model (owner, admin, or member holding the invoice right), the instruction not to retry on a permission refusal, the fact that the document survives while only the link dies, and that a later draft creates a fresh link. It also pre-empts a false success message via the `revoked_count` of 0 case.

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 the effect and trigger, then the parameter decision tree, then edge cases — a sensible order with no filler sentences. It is on the long side for a 7-parameter tool, and the closing workspace paragraph repeats what the schema already says for `workspace_id` and `workspace_scope`, and calls this write operation a 'read'.

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 destructive, multi-parameter, workspace-scoped tool with an output schema, everything an agent needs is present: which identifier to pass, what happens on ambiguity, what happens on permission failure, what the user should be told, and how a zero `revoked_count` must be reported. The output schema covers return values, so the description correctly omits them.

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 coverage is 100%, so a baseline 3 would be defensible, but the description genuinely adds meaning: 'pass exactly one of' establishes mutual exclusivity that the flat schema cannot express, and it explains that `invoice_id` accepts a human reference/number and that an ambiguous number is refused with all matches named. Workspace-selection behavior is also covered, though the final paragraph largely restates the `workspace_id` schema text.

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 — 'Stop a document download link' — plus the precise effect ('so it no longer opens for anyone, including in an email already sent'). It also identifies where such links come from (`well_draft_email`, URL shape `/document-shares/<code>`), which pins down exactly which object is being acted on.

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?

Explicit trigger conditions are given ('when the user asks to stop sharing, unshare or revoke a link') and the three mutually exclusive parameter routes are spelled out with the conditions that select each. The one gap is sibling differentiation: `well_revoke_share_links`, `well_list_share_links` and `well_refresh_share_link` exist but are never mentioned, so an agent must infer that this tool covers only document links.

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

All Well tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?