Skip to main content
Glama

sp_document_outline

Read-only

Indexes literal blocks, paragraphs, and tables with text offsets from a document snapshot; use it to navigate document structure without inferring official headings.

Instructions

Literal block/paragraph/table index with text offsets; not inferred official headings.

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": {
      "snapshot_id": "<snapshot_id>"
    },
    "name": "sp_document_outline"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
offsetNo
snapshot_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered and the bar is lower. The description still adds real behavioral context: the output is a literal structural index with character offsets, and it explicitly does not synthesize official headings — a meaningful disclosure about output fidelity. It does not mention pagination behavior or what the offsets are relative to, which is the remaining gap.

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

Conciseness2/5

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

It is a single sentence fragment with no verb and no front-loaded statement of what the tool returns. Brevity here is under-specification rather than economy — a few more words naming the operation and the snapshot requirement would cost little and remove ambiguity.

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

Completeness2/5

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

For a three-parameter paginated tool with no output schema, the description is too thin: nothing explains what snapshot_id must reference, how limit/offset paginate, or what the offsets are measured against. The absence of an output schema means the description should say something about the shape of the returned index, and it does not.

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

Parameters2/5

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

Schema description coverage is 0% across three parameters, so the description carries the full burden and provides essentially nothing: snapshot_id, limit, and offset are undocumented. 'Text offsets' in the description refers to the output, not the offset parameter, and could even mislead an agent about what the 'offset' input means. The default page size of 40 and required snapshot_id are discoverable only from the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The fragment names the resource (a block/paragraph/table index with text offsets) and adds a useful negative scope ('not inferred official headings'), which hints at how it differs from a heading-based reader. But it is a noun phrase with no verb, so an agent must infer that the tool *returns* this index rather than building or modifying one. Purpose is recognizable but not stated outright.

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 when-to-use guidance and no named alternative among the many siblings (sp_read_document, sp_read_table, sp_search_document, sp_compare_revisions). The 'not inferred official headings' clause implies a contrast with some other extraction mode, but the agent is left to guess which sibling that is and when to prefer one over the other.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.