Skip to main content
Glama
HakashiKatake

docorbit

by HakashiKatake
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

get_documentation_map

Retrieve the hierarchical documentation map, page tree, and section headings with token budgets to help agents navigate indexed docs before retrieving pages.

Instructions

Retrieve the hierarchical documentation map, page tree, section headings, and estimated token budget footprints for indexed documentation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNoResponse format: "markdown" (default, human/agent-readable documentation) or "json" (structured raw machine data).
sourceIdNoOptional source ID or source URL substring filter.
docVersionNoOptional documentation version filter (e.g. "v14", "15.0").

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.2.3
    • addedInput schema / properties / format
      Added value: +{
+  "description": "Response format: \"markdown\" (default, human/agent-readable documentation) or \"json\" (structured raw machine data).",
+  "enum": [
+    "markdown",
+    "json"
+  ],
+  "type": "string"
+}
  2. First observedv0.1.4

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It usefully discloses what is returned, including 'estimated token budget footprints' which helps an agent plan context budget, but says nothing about permissions, caching, rate limits, or whether the call is read-only (only implied by 'Retrieve').

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 front-loaded sentence that packs the return-content list efficiently with no filler. It is well-sized for a low-complexity read tool.

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?

There is no output schema, so the description properly enumerates the returned artifacts (map, tree, headings, token footprints), filling that gap. Only the lack of usage guidance keeps it from being fully complete.

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 all three optional parameters (format, sourceId, docVersion) are already documented in the schema. The description adds no additional parameter meaning, so the baseline of 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 ('Retrieve') and resource ('hierarchical documentation map, page tree, section headings'), which clearly distinguishes it from get_doc and search_docs. It does not explicitly name any sibling, so it falls short of perfect differentiation.

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?

The description gives no when-to-use or when-not-to-use guidance and never references alternatives such as search_docs or get_doc. An agent must infer that this is a navigation/orientation tool rather than a lookup tool.

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

Deploy Server

Other Tools