Skip to main content
Glama

ZeroWidth

List the documents in a knowledge base

workbench_kb_documents_list
Read-only

Every document ingested into the KB's current content: id, name, type, size, chunk count. Empty for a KB with nothing ingested yet (or one whose ingestion is still running — check workbench_kb_ingestion_status). Use it before workbench_kb_add_documents to avoid re-adding a document, and to get the documentId for workbench_kb_document_delete.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kbIdYesKnowledge base id, from workbench_kb_list.
workspaceNoWorkspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

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 cover the safety profile (readOnly, non-destructive, closed-world), and the description adds genuinely new behavior: the result is empty both when nothing has been ingested and when ingestion is still running, with a pointer to workbench_kb_ingestion_status. It stops short of pagination or ordering behavior, but the empty-state disclosure is the operationally important one.

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?

Three sentences, zero filler, and the critical scope and return fields come first. The parenthetical about the empty state is dense but placed immediately after the claim it qualifies, so nothing important is buried.

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, and the description compensates by naming the returned fields. Combined with the empty-state semantics, the ingestion cross-reference, and the two downstream use cases, an agent has everything needed to call and interpret this tool 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 description coverage is 100%, so kbId and workspace are already documented with their constraints (workspace slug rules, personal-token requirement). The description adds nothing about either parameter. Baseline 3 applies when the schema carries the full parameter burden.

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 and resource (list documents in a KB) and pins the exact scope: 'Every document ingested into the KB's current content.' It even enumerates the returned fields (id, name, type, size, chunk count), which no sibling tool claims, so an agent can separate it from workbench_kb_search or workbench_kb_get without opening a 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?

Gives two concrete when-to-use conditions: call before workbench_kb_add_documents to avoid re-adding a document, and call to obtain the documentId required by workbench_kb_document_delete. It also routes the empty-result case to workbench_kb_ingestion_status, so no ambiguous path is left to inference.

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