Skip to main content
Glama

Set document access

set_document_sharing
DestructiveIdempotent

Use when the owner wants to make a document accessible to anyone with its link, require an email before viewing, or restrict access to specific verified email addresses. Replaces access settings and the allowed recipient list. Public allows anyone with the link; verified requires readers to sign in with a verified email before viewing (an existing verified session suffices); specific requires a listed verified email. Changes take effect immediately for published documents. Does not publish a draft or send invitations. This tool does not return individual reader emails. The owner dashboard shows verified reader email addresses in Reader activity; anonymous visits remain unidentified and cannot be retroactively identified. The owner dashboard also supports optional pre-view name/email/phone capture (self-reported, not verified), passcodes and expiration. Selected capture fields must be completed before content is shown. Public mode plus email capture collects an email without requiring sign-in; verified/specific modes still require verified sign-in; use the dedicated reader-settings and explicit-request activity/lead tools to manage these controls in chat.

Input Schema

NameRequiredDescriptionDefault
idYesUUID of an existing document owned by the connected SharedBrief account, returned by document creation or listing.
modeYespublic: no verified sign-in required; verified: require a verified email before viewing; specific: only listed verified email addresses after sign-in. Additional dashboard reader controls can apply in every mode.
emailsNoAllowed addresses for specific mode, up to 50; at least one required for specific. This is an access allowlist, not captured leads or a visitor report. Replaces the previous list.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / emails / description
      Added value: +"Allowed addresses for specific mode, up to 50; at least one required for specific. This is an access allowlist, not captured leads or a visitor report. Replaces the previous list."
    • addedInput schema / properties / mode / description
      Added value: +"public: no verified sign-in required; verified: require a verified email before viewing; specific: only listed verified email addresses after sign-in. Additional dashboard reader controls can apply in every mode."
  2. Changed1 schema field changed
    • addedInput schema / properties / id / description
      Added value: +"UUID of an existing document owned by the connected SharedBrief account, returned by document creation or listing."
  3. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already flag destructiveHint=true and idempotentHint=true, but the description adds real context: it is a full replacement of prior access settings and the recipient allowlist, changes apply immediately for published documents, it neither publishes drafts nor sends invitations, and it deliberately returns no individual reader emails. That is the kind of side-effect and return-scope disclosure annotations cannot express.

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

Conciseness3/5

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

The trigger and mode semantics are front-loaded and earn their place, but the middle-to-late portion drifts into dashboard features (pre-view name/email/phone capture, passcodes, expiration) and repeats mode caveats already present in the schema. Several of these sentences are tangential to invoking this specific tool, so the definition is longer than needed.

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?

For a 3-parameter mutation tool with no output schema, the description covers side effects, immediate effect timing, scope of replacement, and what is not returned, which is more than adequate. It stops short of only trivial detail, and the mode/email specifics live in a fully-covered schema.

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 the baseline is 3, but the description still earns credit: it explains that public mode allows anyone with the link while verified/specific require a verified sign-in, and that 'emails' is an allowlist that fully replaces the previous list rather than a lead report. The 50-item cap and per-mode requirement are left to the schema, so it is not a full 5.

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?

The description opens with a concrete trigger plus the three access outcomes it sets (link-anyone, sign-in-required, listed-emails), which is a specific verb+resource statement. It is clearly separable from get_document_sharing, update_document_reader_settings, get_document_leads and publish_document because it names what it does not do (no publishing, no invitations, no email reporting).

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

Usage Guidelines5/5

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

It states when to use it ('when the owner wants to make a document accessible...') and when not to ('Does not publish a draft or send invitations'), and it routes the agent elsewhere for adjacent concerns by naming the dedicated reader-settings and explicit-request activity/lead tools. The only minor softness is that the alternatives are named by category rather than by exact tool name.

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