Skip to main content
Glama

List kb documents

list_kb_documents
Read-only

Lista todos os documentos indexados na base de conhecimento do usuário, com nome, tipo, status de indexação e tags. Sem target_user_id, lista da PRÓPRIA conta autenticada; o administrador da plataforma pode passar target_user_id.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_kb_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
tagNoFiltrar por tag, ex: "marketing"
target_user_idNoID da conta-alvo (opcional; APENAS o admin da plataforma pode usar). Padrão: a conta autenticada.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered elsewhere. The description usefully adds the visible return fields and the admin-only permission constraint on target_user_id, but says nothing about result volume, ordering, or whether the full list is returned at once — meaningful gaps for an unbounded list operation.

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?

Two sentences, no filler, with the scope rule front-loaded before the admin caveat. Slight redundancy with the schema's target_user_id description is the only wasted space.

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 takes on the job of describing the return shape and does so by naming the four returned fields. What remains missing is behavior an agent needs for a list call — pagination, result limits, ordering — though the annotations already establish that the call is a safe read.

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 both parameters are already documented in the schema, including the admin-only note and the default to the authenticated account. The description restates that same target_user_id rule and says nothing about the tag filter, so it adds no meaning beyond structured data — baseline 3 is correct.

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?

States a specific verb and resource ("Lista todos os documentos indexados na base de conhecimento") and even enumerates the returned fields (nome, tipo, status de indexação, tags), so the agent knows exactly what this returns. It does not, however, contrast itself with the sibling search_knowledge_base, which is the nearest alternative for retrieving KB content.

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

Usage Guidelines3/5

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

The only conditional guidance is about target_user_id ("Sem target_user_id, lista da PRÓPRIA conta... o administrador da plataforma pode passar target_user_id"), which is really scope semantics rather than when-to-use-this-tool-versus-another. Nothing tells the agent when to pick list_kb_documents over search_knowledge_base or the create_kb_* siblings; usage must be inferred from the name.

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