Skip to main content
Glama

Share a document

share_document

Create a shareable link to a document so anyone with the URL can open it — no sign-in required. Choose "participate" (the default: comment, add stickies and vote), "view" (read-only) or "edit". Returns the link URL. Use after creating or finding a document to hand it to teammates.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
roleNoWhat the link grants. "participate" (default): recipients add stickies, write and vote but cannot reshape it; right for a retro or a workshop. "view": they only look, with no comments or votes. "edit": they can change anything. No sign-in is needed to open any.
expiryNoWhen the link stops working. Defaults to "never" (until revoked).
documentIdYesThe document to share (from find_documents / read_document).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesThe share link. Opening it needs no sign-in.
roleYesWhat the link grants.
expiresAtYesWhen the link stops working, as a ms epoch; null when it never expires.
documentUrlYesLink that opens the document in the livediagram editor.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / role / description
      Previous value: -"What the link grants. \"view\" (default) — recipients can open and read but not change it; safest for just showing your work. \"edit\" — recipients can also edit. No sign-in is needed to open either."New value: +"What the link grants. \"participate\" (default): recipients add stickies, write and vote but cannot reshape it; right for a retro or a workshop. \"view\": they only look, with no comments or votes. \"edit\": they can change anything. No sign-in is needed to open any."
    • changedInput schema / properties / role / enum
      Previous value: -[
      -  "view",
      -  "edit"
      -]New value: +[
      +  "view",
      +  "participate",
      +  "edit"
      +]
    • changedOutput schema / properties / role / enum
      Previous value: -[
      -  "view",
      -  "edit"
      -]New value: +[
      +  "view",
      +  "participate",
      +  "edit"
      +]
  2. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations flag this as non-read-only and non-destructive, and the description adds meaningful context beyond them: the link is publicly openable without sign-in, the default role is 'participate', and the tool returns the link URL. It does not explain how to revoke a link or what happens to existing links, but the access/security model is disclosed well.

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?

Three tight sentences, front-loaded with the core action, then options, then usage trigger. Efficient overall, with a minor restatement of the role enum that the schema already covers.

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

Completeness4/5

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

With a full output schema present, the description correctly avoids over-explaining return values while still noting the link is returned. Combined with annotations it covers purpose, roles, and the no-sign-in access model; only revocation mechanics are left unstated.

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

Parameters3/5

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

Schema coverage is 100%, so the schema already documents all three parameters and their enum values in detail. The description restates the role options with brief glosses and notes the default, which is mostly redundant with the schema's own enum descriptions, so the baseline 3 is appropriate.

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 (create a shareable link) applied to a specific resource (a document) and makes the access model explicit (anyone with the URL, no sign-in). The resource is unambiguous, so an agent can immediately distinguish this from the share_diagram and share_form siblings.

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 a clear trigger: 'Use after creating or finding a document to hand it to teammates,' which tells the agent the correct sequence relative to create_document/find_documents. It stops short of naming explicit when-not conditions or the adjacent share_* alternatives, so no exclusion is offered.

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