Skip to main content
Glama

Typebar (formerly SuperDocs)

get_document_detail

One saved document's metadata plus a STRUCTURE outline and the chat sessions that have it open (prior-chats-per-file). Owner-scoped — 404 if the document isn't yours.

structure (always included, token-light, NON-BILLABLE) is the cheap verify step after any edit: headings (level + text + position), section_count (heading-anchored), block_count (editable chunks), media (image/diagram counts). It answers "did my edit land?" for free — never export a whole document just to check its structure. Pass include_html=true only when you need the body.

structure.parts (present when the document has headers, footers, notes or comments) lists each part with part_type, chunk_id and preview: whole is true when preview is the part's entire text, and full_len is that text's full length in characters (when whole is false the preview is abridged; pass include_html=true to read it all).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "document_id": "<document_id>"
    },
    "name": "get_document_detail"
  }
}

Input Schema

NameRequiredDescriptionDefault
document_idYes
include_htmlNoWhen true, also returns the document's full reassembled HTML body (`html`), plus its `page_setup` and `version_id`. Default false returns metadata + structure + prior-chats only, keeping the response token-light. This is the by-id way to read a saved document's body without opening it into a session.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

With no annotations provided, the description carries the full disclosure burden and does most of it: owner scoping with a 404 outcome, token-light and NON-BILLABLE cost behavior, what is always included, and when include_html is required to read abridged part text. Gaps remain around the prior-chats-per-file list shape (ordering, truncation, how many sessions come back) and any error case other than 404.

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?

The lead sentence front-loads what the tool returns, and each subsequent paragraph maps to a distinct decision (verify vs. read body, how to interpret parts previews). It is longer than strictly needed — the emphasis caps and repeated 'token-light' framing add noise — but no sentence is idle.

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?

No output schema exists, so the description must define the return shape and it does: structure fields (headings, section_count, block_count, media) and the parts sub-structure (part_type, chunk_id, preview, whole, full_len) with the abridging rule. For a two-parameter read tool, an agent has everything needed to call it and interpret the result.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50% because document_id has no schema description at all. The description compensates by tying document_id to owner scoping ('404 if the document isn't yours') and adds real meaning for include_html — it is the trigger that reads abridged `structure.parts` previews in full, which the schema text alone does not state.

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 first sentence states a specific verb+resource triple: one saved document's metadata, a structure outline, and the chat sessions that have it open. That scope cleanly separates it from list_documents (enumeration) and export_document (full body export), so an agent can pick it without opening the 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?

Explicit when-to-use: the structure block is named as the cheap verify step after any edit, with a direct negative instruction not to export a whole document just to check structure. It also states the precise gate for the alternative mode — pass include_html=true only when you actually need the body — which is both a use rule and a when-not rule.

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.