Skip to main content
Glama

List registered documents

list_docs
Read-onlyIdempotent

List registered documents with metadata to discover doc_id values and document classes for subsequent rendering or auditing.

Instructions

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

    Use this first to discover the ``doc_id`` values and document
    classes available before calling ``render`` or ``audit_pdf``. For
    just the document count (a connectivity probe) call ``doc_count``
    instead; to read the raw manifest text use the ``inclusio://meta``
    resource. Reads ``data/meta.yaml`` under ``INCLUSIO_CONTENT_DIR``
    (or the packaged content root); it writes nothing.

    Returns one dict per document with id, class, src, title, and
    any `pdf_a` / `note` flags. Empty list when no manifest exists.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

Annotations already declare read-only and non-destructive behaviors; the description adds context about reading from INCLUSIO_CONTENT_DIR and returning specific fields, enhancing transparency beyond annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the primary purpose, followed by usage context, technical details, and return format, all in a concise, well-organized structure without redundancy.

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?

Given zero parameters, rich annotations, and the existence of an output schema, the description covers the tool's full behavior including data source, return format, and edge case (empty list). Sufficiently complete.

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?

No parameters exist, so baseline 4 applies. The description does not need to elaborate on parameters, and schema coverage is 100% (vacuous).

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?

The description clearly states the tool lists documents from data/meta.yaml, and distinguishes itself from siblings like render, audit_pdf, and doc_count by specifying its role as a discovery step.

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?

Explicitly advises using this tool first to get doc_id and class before calling render or audit_pdf, and suggests doc_count for just the count. Provides clear when-to-use guidance.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/sebastienrousseau/inclusio'

If you have feedback or need assistance with the MCP directory API, please join our Discord server