Skip to main content
Glama
sebastienrousseau

inclusio-mcp

by sebastienrousseau
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

List registered documents

list_docs
Read-onlyIdempotent

List every document registered in data/meta.yaml with its metadata—identifiers, classes, titles, source paths, and PDF/A flags—to discover valid doc_id values before rendering or auditing.

Instructions

List every document registered in data/meta.yaml with its metadata.

    Purpose:
    Enumerates all registered documents, returning their identifiers, classes, source paths,
    titles, and PDF/A flags.

    When to use:
    - When discovering valid `doc_id` values before calling `render` or `audit_pdf`.
    - When checking document classes (e.g. CV, paper, report, letter) registered in the workspace.

    When NOT to use:
    - Do NOT use if you only need a quick connectivity probe; use `doc_count` instead.
    - Do NOT use for raw YAML content; use the `inclusio://meta` resource instead.

    Behavioral transparency:
    Pure, read-only filesystem inspection. Reads `data/meta.yaml` without mutating any state.

    Returns:
    List of document specification dictionaries. Empty list when no manifest exists.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.7

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint. The description reinforces the read-only filesystem nature and adds a genuinely non-obvious behavior: an empty list is returned when no manifest exists. This adds value beyond the annotations, though the openWorld implication is not elaborated.

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?

Well-structured with labeled sections (Purpose, When to use, When NOT to use, Behavioral transparency, Returns), but the labeled-header format is more verbose than strictly necessary; the content itself is front-loaded and earns its place.

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 the description need not explain return shape, yet it helpfully summarizes the returned fields and the empty-manifest edge case. Comprehensive for a zero-parameter read tool; minor gap is that the openWorldHint implication (external path dependencies) is not addressed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Zero parameters, so baseline is 4. The description correctly documents the output field set, which is relevant since this call has no inputs.

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 (lists every document) and resource (registered in data/meta.yaml), then enumerates exactly what is returned (identifiers, classes, source paths, titles, PDF/A flags). It clearly distinguishes itself from doc_count, render, and audit_pdf.

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

Usage Guidelines5/5

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

Provides explicit 'When to use' with two concrete triggering scenarios (discovering doc_id before render/audit_pdf; checking registered classes) and 'When NOT to use' naming two alternatives (doc_count for a probe; the inclusio://meta resource for raw YAML). Nothing is left to inference.

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