Skip to main content
Glama
lyonzin

knowledge-rag

by lyonzin
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

list_documents

Lists all indexed documents, optionally filtered by category, to browse the knowledge index or confirm a specific file is indexed.

Instructions

List all indexed documents, optionally filtered by category.

Read-only. No side effects.

Args: category: Optional category filter. Must be a valid category name — call list_categories() to see available options (e.g., security, ctf, logscale, development, general, redteam, blueteam).

Returns: JSON string with list of document filepaths, categories, and metadata for each indexed file.

Usage: Use to browse what's in the index or verify a specific file is indexed. Use list_categories() first to see valid category names. Use search_knowledge() when you want to find documents by topic rather than browsing the full list. Use get_document() to read a specific file once you have its filepath.

Input Schema

NameRequiredDescriptionDefault
categoryNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv4.11.1
    • addedInput schema / properties / category / anyOf
      Added value: +[
+  {
+    "type": "string"
+  },
+  {
+    "type": "null"
+  }
+]
    • removedInput schema / properties / category / type
      Removed value: -"string"
  2. First observedv3.0.0

TDQS

A4.7/5.0
Behavior4/5

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

With no annotations provided, the description carries the behavioral burden and explicitly says 'Read-only. No side effects.' It also describes the return payload as a JSON string with filepaths, categories, and metadata. The only minor gap is that it doesn't mention any permission, rate-limit, or pagination behavior, though for a simple index-listing tool this is reasonable.

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?

The description is front-loaded with purpose and read-only behavior, then uses clear Args and Usage sections. It is slightly verbose because it repeats return-value information despite the presence of an output schema, but the Args section is necessary given 0% schema description coverage.

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?

For a one-parameter, read-only listing tool with an output schema, the description is complete: it states scope, safety, category constraints, return shape, and routes to the right sibling tools. Nothing an agent needs in order to call it correctly is missing.

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

Parameters5/5

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

Schema description coverage is 0%, so the description must compensate, and it does: the single `category` parameter is described as an optional filter, must be a valid category name, and callers are directed to `list_categories()` with concrete examples such as security, ctf, and logscale. This adds substantial meaning beyond the bare schema.

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 states a specific verb and resource: 'List all indexed documents, optionally filtered by category.' It clearly distinguishes the browsing behavior from search_knowledge and get_document in the Usage section. An agent can tell exactly what this tool does without opening the schema.

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?

It gives explicit when-to-use guidance: browse the index or verify a file is indexed, call list_categories first for valid category names, use search_knowledge for topic-based lookup, and use get_document to read a specific file. It names the relevant siblings and the conditions that select them.

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