Skip to main content
Glama

Show SharedBrief document

show_document
Read-onlyIdempotent

Use when the user wants to preview, review, or manually edit an existing SharedBrief document inside the conversation. Opens the embedded viewer and editor.

Input Schema

NameRequiredDescriptionDefault
idYesUUID of an existing document owned by the connected SharedBrief account.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / id / description
      Added value: +"UUID of an existing document owned by the connected SharedBrief account."
  2. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description usefully adds that the output is an in-conversation viewer/editor rather than raw data, but it never clarifies whether edits made in that editor persist or how they are saved, a meaningful ambiguity for a tool whose description includes 'edit'.

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?

Two tight sentences with no filler, but the when-to-use trigger is front-loaded while the actual action (what the tool does) is deferred to the second sentence. Swapping them would make the purpose scannable first.

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 one-parameter tool with rich annotations and no output schema, the description covers the trigger and the mechanism adequately. The remaining gap is the fate of edits made through the embedded editor and whether the tool returns any confirmation or document payload.

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?

There is a single parameter with 100% schema description coverage, including UUID format and ownership scoping, so the schema carries the semantics. The description adds nothing about the id beyond 'an existing SharedBrief document', which is the expected baseline when the schema is already complete.

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?

The second sentence states the concrete action: it opens an embedded viewer/editor for a SharedBrief document, which tells an agent this is a UI-facing display tool rather than a data fetch. It does not, however, explicitly distinguish itself from sibling read tools such as get_document or read_document_for_app, leaving that inference to the agent.

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?

The description gives a clear trigger condition (user wants to preview, review, or manually edit an existing document inside the conversation), which is genuinely actionable. It stops short of naming alternatives or exclusions, e.g. when to prefer get_document for programmatic retrieval or read_document_for_app for app consumption.

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