Skip to main content
Glama

Get document outline

nodiom_tree
Read-onlyIdempotent

Returns the full structural outline of a document as a nested JSON tree. Use this first to understand a document's structure.

Input Schema

NameRequiredDescriptionDefault
doc_idYesDocument ID. Examples: "waitlist", "content-calendar", "metrics".

Output Schema

NameRequiredDescriptionDefault
doc_idYesThe document id.
outlineYesThe document's headings as a nested tree.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "doc_id": {
      +      "description": "The document id.",
      +      "type": "string"
      +    },
      +    "outline": {
      +      "description": "The document's headings as a nested tree.",
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "children": {
      +            "description": "Nested headings, in the same shape.",
      +            "items": {},
      +            "type": "array"
      +          },
      +          "depth": {
      +            "type": "integer"
      +          },
      +          "heading": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "heading",
      +          "depth",
      +          "children"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "doc_id",
      +    "outline"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds only the return shape ('nested JSON tree'), without noting depth, size limits, or behavior on invalid doc_ids.

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?

Two short sentences, front-loaded with what the tool returns, followed by the single usage cue. No filler.

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?

An output schema exists, so return-value explanation is unnecessary, and the annotations cover the safety profile for a trivial one-parameter read. The only real gap is the lack of differentiation from sibling read/get-doc tools.

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?

Only one parameter, and the schema documents it at 100% coverage with format hints and examples. The description adds nothing about doc_id semantics, so the baseline 3 applies.

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 ('Returns') and resource ('full structural outline of a document') plus the output shape ('nested JSON tree'), which distinguishes it from plain read tools like nodiom_read or nodiom_get_doc. It stops short of naming those siblings explicitly, so an agent must infer the distinction rather than be told.

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?

'Use this first to understand a document's structure' gives a sequencing hint, but there is no explicit when-not guidance and no named alternatives (e.g., use nodiom_get_doc for raw content, nodiom_read for text). Usage is implied rather than defined.

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.