Skip to main content
Glama

shareout_get_document

Read-onlyIdempotent

Inspect one authorized document summary and current version without content.

Input Schema

NameRequiredDescriptionDefault
document_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds genuinely useful context beyond them: it will NOT return document content, and only documents the caller is authorized to see are accessible.

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 tight sentence with no filler, and the scope-limiting phrase ('without content') is present. It is efficient but arguably clipped for a tool whose parameter is undocumented.

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 no output schema, the description does carry the return contract ('document summary and current version without content'), which is the key thing an agent needs. Missing only edge-case behavior (nonexistent, unauthorized, or non-current documents) for a low-complexity single-parameter read tool.

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?

One required parameter with 0% schema description coverage, so the description must compensate. It implies the ID selects exactly one authorized document, but never states the identifier's format (the ^[a-z0-9_]{1,64}$ pattern is only in the schema) or what happens for an unknown/unauthorized ID.

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 (Inspect) and resource (one authorized document summary and current version), with the scope qualifier 'without content' that separates it from a content-read operation. It is distinguishable from list_documents/list_versions by the singular 'one document' framing, though no sibling is named.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: the singular 'one authorized document' and 'without content' suggest a metadata lookup, not a listing or content fetch. No explicit when-to-use, when-not, or named alternative (e.g., shareout_list_versions) is given.

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