Skip to main content
Glama

Publish a document

publish_document
DestructiveIdempotent

Use when the user wants a shareable link to an existing SharedBrief draft. Publishes the document at its stable unlisted link using its current access settings. Public mode does not require verified sign-in; verified and specific-email modes require it. Additional dashboard reader controls may apply in every mode. Publishing does not email recipients or send invitations. 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.

Output Schema

NameRequiredDescriptionDefault
idYes
urlYes
revisionYes
shareModeYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": {},
      +  "properties": {
      +    "id": {
      +      "format": "uuid",
      +      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +      "type": "string"
      +    },
      +    "revision": {
      +      "exclusiveMinimum": 0,
      +      "maximum": 9007199254740991,
      +      "type": "integer"
      +    },
      +    "shareMode": {
      +      "enum": [
      +        "public",
      +        "verified",
      +        "specific"
      +      ],
      +      "type": "string"
      +    },
      +    "url": {
      +      "format": "uri",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "id",
      +    "revision",
      +    "url",
      +    "shareMode"
      +  ],
      +  "type": "object"
      +}
  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?

Adds substantial behavior beyond the annotations: sign-in requirements per mode (public vs verified/specific-email), that dashboard reader controls may apply in every mode, and that publishing does not send invitations. It clarifies the openWorld/exposure implications that the destructiveHint=true annotation only gestures at.

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 trigger and core action, then layers mode/sign-in caveats in a logical order. It is dense and runs long, but each sentence carries a distinct behavioral fact rather than 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?

An output schema exists and annotations already carry the safety/idempotency profile, so the description need not explain return values. Given the multi-mode publishing complexity, the description supplies the mode and sign-in context an agent needs to call it correctly.

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 description coverage is 100% and the single 'id' parameter is fully documented in the schema (UUID of an existing owned document). The description adds no syntax or format detail beyond that, so the baseline of 3 applies.

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+resource ('Publishes the document at its stable unlisted link') and its scope ('existing SharedBrief draft'), which is enough for an agent to distinguish it from unpublish_document and the reader-settings siblings without opening a schema.

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?

Opens with an explicit trigger ('Use when the user wants a shareable link to an existing SharedBrief draft'), names an exclusion ('does not email recipients or send invitations'), and routes the agent to alternatives ('use the dedicated reader-settings and explicit-request activity/lead tools to manage these controls').

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