Skip to main content
Glama

List KB documents

list_kb_documents
Read-onlyIdempotent

List the knowledge base documents the bot answers from (title, category, source, ingestion status). Call before creating, updating, deleting or re-ingesting a document.

Input Schema

NameRequiredDescriptionDefault
fieldsNoOptional: return only these fields of each record.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered. The description adds the returned field set and the pre-mutation workflow, but says nothing about pagination, result limits, or ordering for what could be a large list.

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?

Two compact sentences; the identity/scope statement comes first and the workflow directive second. Every clause carries information and nothing is padded.

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?

With no output schema, the description helpfully names the returned fields, compensating for the missing return contract, and annotations cover the read-only profile. The only gap is list-size/pagination behavior, which is minor for a simple listing tool.

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?

Only one optional parameter with 100% schema description coverage, so the schema already explains the `fields` projection. The description's field list (title, category, source, ingestion status) loosely echoes enum members but adds no format or behavioral detail beyond the 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?

States a specific verb (List) and resource (knowledge base documents) with a scoping qualifier ('the bot answers from') that separates it from raw document retrieval. The parenthetical enumerates the returned fields, and the verb distinguishes it cleanly from get_kb_document, create_kb_document, delete_kb_document, and reingest_kb_document.

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

Usage Guidelines4/5

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

Explicitly tells the agent to call this before creating, updating, deleting, or re-ingesting a document, naming the four sibling operations that depend on it. It gives strong positive context but no exclusion cases (e.g., when to prefer get_kb_document for a single record).

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