Skip to main content
Glama
HakashiKatake

docorbit

by HakashiKatake
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

list_sources

Lists all indexed documentation sources, snapshot records, doc versions, and machine-readability status to help coding agents retrieve and verify software docs.

Instructions

List all indexed documentation sources, snapshot records, doc versions, and machine-readability status.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of sources to list (default: 50).
formatNoResponse format: "markdown" (default, human/agent-readable documentation) or "json" (structured raw machine data).

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 behavioral burden. 'List all' implies a read-only enumeration, but there is no disclosure of pagination behavior, ordering, default limit effects, or auth requirements. For a no-annotation tool this is thin.

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 with no filler. It is slightly dense by enumerating four output categories, but every clause describes what gets listed.

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 two-parameter, read-only listing tool with no output schema, the description adequately conveys the scope of what is returned. It omits ordering, pagination, and how the four listed categories relate to each other, which leaves modest gaps but nothing an agent would trip over before calling it.

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 both limit and format are already fully documented in the schema, including the default and the markdown/json distinction. The description adds no parameter meaning beyond that, 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 ('List') and a concrete resource set (indexed documentation sources, snapshot records, doc versions, machine-readability status). It is clearly a listing tool distinct in kind from search_docs and get_doc, though it never names or contrasts with a 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 statement of when to use this vs. search_docs or get_documentation_map, and no prerequisites or exclusions. The agent must infer that this is a broad enumeration endpoint from the word 'all'.

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