Skip to main content
Glama
jgravelle

jdocmunch-mcp

by jgravelle
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

list_docs

Read-only

List every indexed document in a repository with its path, section count, format, and size, without section titles or content. Filter by glob or page results with limit and offset.

Instructions

v1.55+ — flat per-doc inventory of an indexed repo: doc_path, section_count, format, byte_size for each indexed document. Lighter than get_toc_tree (which returns full section trees per doc). Sorted by doc_path. Inventory only; it returns no section titles and no content. Each doc also carries mtime when one is known — as of the last indexing pass, omitted when unknown rather than null — and _meta.docs_with_mtime says how many have one, so a partially filled or pre-1.144 index is distinguishable from a complete one.

Input Schema

NameRequiredDescriptionDefault
repoYesRepository identifier
limitNov1.147+ — return at most this many docs, starting at offset. Default: all, subject to the response ceiling (JDOCMUNCH_RESPONSE_MAX_BYTES, 1 MiB), over which the call is refused, never truncated. docs_total, docs_truncated and next_offset are always present.
offsetNov1.147+ — docs to skip. Pass the previous response's next_offset. Default 0.
path_globNov1.147+ — fnmatch glob restricting the list to matching doc_paths. Default: no filter.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.147.0
    • addedInput schema / properties / limit
      Added value: +{
+  "description": "v1.147+ — return at most this many docs, starting at offset. Default: all, subject to the response ceiling (JDOCMUNCH_RESPONSE_MAX_BYTES, 1 MiB), over which the call is refused, never truncated. docs_total, docs_truncated and next_offset are always present.",
+  "minimum": 1,
+  "type": "integer"
+}
    • addedInput schema / properties / offset
      Added value: +{
+  "description": "v1.147+ — docs to skip. Pass the previous response's next_offset. Default 0.",
+  "minimum": 0,
+  "type": "integer"
+}
    • addedInput schema / properties / path_glob
      Added value: +{
+  "description": "v1.147+ — fnmatch glob restricting the list to matching doc_paths. Default: no filter.",
+  "type": "string"
+}
  2. Addedv1.118.0
  3. Removedv1.99.0
  4. First observedv1.66.3

TDQS

A4.4/5.0
Behavior5/5

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

Annotations only declare readOnlyHint=true, but the description adds substantial behavior: sorted by doc_path, inventory-only with no titles/content, and nuanced mtime semantics (omitted when unknown rather than null, with _meta.docs_with_mtime distinguishing partial from complete indexes). This is real context an agent cannot get from the annotation alone.

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?

Front-loaded with the core inventory purpose and the sibling contrast, and most sentences earn their place. The 'v1.55+' version prefix and the dense mtime clause add minor noise but are not wasteful enough to penalize heavily.

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

Completeness5/5

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

With no output schema, the description carries the return-value burden and does so thoroughly (fields per doc, sorting, optional mtime, _meta counter). An agent has everything needed to call and interpret the result.

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 coverage is 100%, so repo, limit, offset, and path_glob are already fully documented in the schema. The description adds little parameter-level detail (only the implicit doc_path sorting), so the baseline 3 applies.

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

Purpose5/5

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

States a specific verb+resource ('flat per-doc inventory of an indexed repo') and enumerates the fields returned (doc_path, section_count, format, byte_size). It explicitly distinguishes itself from the sibling get_toc_tree, so an agent can pick between them without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Names the alternative (get_toc_tree) and the condition that favors this tool ('lighter... returns no section titles and no content'). Clear context for selection, but no explicit statement of when this tool itself is a poor choice beyond the lightness contrast.

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