Skip to main content
Glama

Show SharedBrief document

show_document
Read-onlyIdempotent

Display one of your documents in the embedded SharedBrief viewer and editor.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=false, destructiveHint=false, so safety and idempotence are covered by structured fields. The description adds the fact that it renders in an embedded viewer/editor, but says nothing about editor state, side effects, or whether opening is purely display.

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?

A single short sentence, front-loaded with the verb 'Display' and the resource 'document'. Nothing is wasted, though very little is included.

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

Completeness3/5

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

With one required param, complete annotations, and no output schema, a one-sentence definition is barely adequate. The agent still cannot tell why it would choose this over get_document or read_document_for_app, which is a meaningful gap in completeness.

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 0% for a single 'id' parameter, which is already constrained to a UUID by schema format and pattern. The description adds no meaning about what the id refers to or how it is obtained; with one param the baseline is 3, so the score anchors there rather than rising.

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?

States a specific verb + resource: 'Display one of your documents in the embedded SharedBrief viewer and editor.' That is more specific than a plain get, but the description does not differentiate it from get_document or read_document_for_app among the 13 document siblings, so it falls short of the 5 tier.

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

Usage Guidelines2/5

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

There is no explicit when-to-use guidance. The phrase 'inside the embedded SharedBrief viewer and editor' implies a UI/embedding context, but with siblings like get_document and read_document_for_app present it is left to inference, and no alternative is named.

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