Skip to main content
Glama
devaloi

mcpserve-py

by devaloi

list_documents

Retrieve all stored documents or filter them by tag for targeted lookups. Use this to browse or search a document collection.

Instructions

List all documents, optionally filtered by tag.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tagNoOptional tag to filter by

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/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 burden. It mentions optional filtering but does not disclose behavior such as whether it returns all documents by default (potential performance concern), pagination limits, permissions required, or what the output structure looks like. For a list operation with no structured behavioral hints, this is insufficient.

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?

One concise sentence that front-loads the primary action and specifies the optional filter. No wasted words.

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

Completeness2/5

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

With no annotations, no output schema, and a crowded set of sibling tools, the description is too sparse. An agent lacks critical context: default behavior, return shape, performance implications, and how to choose between this tool and siblings like search_documents or query_database.

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?

Schema description coverage is 100%, so the schema already explains the single parameter. The description adds the word 'optionally' and clarifies that filtering is by tag, which is consistent with the schema and provides slight reinforcing value. Baseline 4 is appropriate for zero required params and full coverage.

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?

The description states a clear verb (List) and resource (documents) with added scope (optional tag filter). However, it does not differentiate from sibling tools like search_documents or query_database, which is important for correct tool selection.

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 explicit guidance on when to use this tool versus alternatives. The description implies it is a general listing tool, but with siblings like search_documents and query_database, an agent needs to know when to prefer each. No when-to-use or when-not-to-use information is provided.

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