Skip to main content
Glama

Read one document's outline

get_document
Read-only

Read one document and its top level structure, without the text.

The outline is where to find a clause key when you know roughly where to look. Read the words with get_clause. The call is recorded.

Input Schema

NameRequiredDescriptionDefault
slugYesThe document's slug, such as gdpr
as_ofNoRead the document as it stood on this date

Output Schema

NameRequiredDescriptionDefault
outlineYes
documentYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already establish that this is a safe read-only, non-open-world call. The description adds useful behavioral context: the outline excludes document text and the call is recorded, which is relevant audit information not captured by the annotations.

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

Conciseness5/5

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

The description is short and front-loaded: it states what is returned, how it relates to clause lookup, and the logging behavior. Every sentence carries useful information without repetition.

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?

With annotations covering safety, schema coverage at 100%, and an output schema present, the description provides enough context for correct invocation. It explains the outline's purpose and points to get_clause for full text.

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%, so slug and as_of are already well documented in the schema. The description adds no parameter-level semantics beyond the general 'one document' framing, which is acceptable given the schema coverage.

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 states a specific verb and resource: reading one document's top-level structure without its text. It also distinguishes the tool from get_clause, which is for reading the actual words, so an agent can tell the two apart immediately.

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?

It gives a clear usage condition: use the outline when you know roughly where to look for a clause key, and use get_clause to read the words. It does not explicitly cover when to prefer list_documents or search_policies, so it falls short of full when/when-not guidance.

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