Skip to main content
Glama

Documents in a knowledge base

knowledge_documents
Read-only

The documents inside one knowledge base, newest first, each with its title, whether it is a PDF or plain text, its indexing state (PROCESSING, READY or FAILED), its length, how many passages it was split into and the reason if it failed. Use it after knowledge_list when someone asks what a base contains, or why an upload is not being used in answers.

Input Schema

NameRequiredDescriptionDefault
limitNoHow many documents to return, newest first. Defaults to 50; 200 is the most this tool will ever return.
knowledgeBaseIdYesThe knowledge base's id, as returned by knowledge_list.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds valuable behavioral context by describing the returned document fields, sort order, indexing states, and failure reason, though it does not discuss pagination or permission requirements beyond the schema.

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 two tightly written sentences with no filler. It front-loads what the tool returns and then immediately follows with concrete usage guidance.

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?

There is no output schema, so the description carries the burden of explaining return values, and it does so thoroughly: title, type, indexing state, length, passage count, and failure reason. Combined with complete input schema coverage and read-only annotations, an agent has everything needed to call it correctly.

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 both knowledgeBaseId and limit are fully documented in the schema. The description does not add parameter-level meaning beyond what the schema already provides, which is the baseline when schema coverage is high.

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 identifies the resource (documents inside one knowledge base) and the returned fields, including sort order and indexing states. It also distinguishes itself from knowledge_list by naming that sibling and the follow-up scenario in which this tool is used.

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 explicitly says to use this tool after knowledge_list when the user asks what a knowledge base contains or why an upload is not used in answers. This gives both the alternative tool and the triggering conditions with no ambiguity.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources