Skip to main content
Glama

List Knowledge Documents

list_knowledge_documents
Read-onlyIdempotent

The documents (sources) of a notebook: name, type, status (queued, processing, ready, failed), size and error.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "notebook_id": "<notebook_id>"
    },
    "name": "list_knowledge_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
app_idNoOptional app whose notebooks to use. Omitted: the owner's own Business Brain.
notebook_idYesThe notebook id, from list_knowledge_notebooks.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=false and destructiveHint=false, so the safety profile is covered. Beyond that, the description adds genuinely useful return-shape context by listing the exposed fields and the status lifecycle (queued, processing, ready, failed) plus an error field. It says nothing about ordering, pagination, or result limits for what could be a large document set.

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?

A single compact fragment with zero filler, front-loading the resource and then the returned fields. It is slightly clipped — a leading verb like 'Lists' would cost one word and make the sentence self-standing — but no sentence is wasted.

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

Completeness3/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 carries the burden of explaining returns, and it does partially by enumerating fields and status values. It omits pagination/ordering behavior and any hint of volume, which matters for a listing tool on a document collection. Adequate for a two-parameter read, but not complete.

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%: app_id (fallback to the owner's own Business Brain) and notebook_id (from list_knowledge_notebooks) are both fully documented in the schema. The description adds no parameter-level meaning, so the baseline 3 applies; nothing in the schema is left ambiguous.

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 names the resource ('documents (sources) of a notebook') and enumerates what each entry contains: name, type, status, size, error. Combined with the verb in the tool name, an agent can tell this is a per-notebook document listing. It stops short of distinguishing itself from close siblings such as list_failed_knowledge_documents or read_knowledge_document.

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 when-to-use guidance and no alternative is named. The presence of the status values implies it is useful for polling ingestion progress, but the agent must infer that, and must also infer that list_failed_knowledge_documents is the narrower path for failures.

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