Skip to main content
Glama
HakashiKatake

docorbit

by HakashiKatake
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

get_doc

Retrieve a specific documentation page or contextual chunk by URL, page ID, or chunk ID, returning complete metadata and security annotations for agent use.

Instructions

Retrieve a specific documentation page or contextual chunk by ID or URL with complete metadata and security annotations.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoNormalized source URL of the documentation page.
formatNoResponse format: "markdown" (default, human/agent-readable documentation) or "json" (structured raw machine data).
pageIdNoUnique page identifier (e.g. "page_...").
chunkIdNoUnique chunk identifier (e.g. "chk_...").

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

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It hints at the return payload ('complete metadata and security annotations') but says nothing about permissions, error behavior for missing IDs, or what happens when both URL and ID are supplied. 'Security annotations' is vague and unexplained.

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 states the action and lookup keys immediately. No filler, though the trailing 'with complete metadata and security annotations' is somewhat vague and slightly less earned than the rest.

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

Completeness3/5

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

For a read-only retrieval tool with no output schema or annotations, the description is adequate but thin: it does not cover mutual exclusivity of url/pageId/chunkId, failure behavior, or what 'security annotations' in the payload means. It is minimum viable rather than 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 the schema already documents url, format, pageId, and chunkId (including enum meanings). The description only restates the 'ID or URL' idea and adds no disambiguation between pageId and chunkId or guidance on precedence. Baseline 3 is appropriate.

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 (documentation page or contextual chunk) with the lookup keys (ID or URL). It implicitly contrasts with search_docs by emphasizing retrieval of a specific item, but never names or distinguishes itself from that sibling explicitly.

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 explicit when-to-use or when-not-to-use guidance, nor any mention of alternatives like search_docs or list_sources. The reader must infer that this is a direct-lookup tool used after a search, but nothing in the text says so.

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