Skip to main content
Glama

List knowledge base documents

list_knowledge_base_documents
Read-onlyIdempotent

[Knowledge base] List the company's knowledge base documents, optionally for one store, with the interviews each is limited to. knowledge_base_id narrows it to one document's limit.

Every argument in full, with examples: get_tool_reference.

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_knowledge_base_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of records to return (1–1000).
offsetNoNumber of records to skip from the start of the result set.
llm_modelNoYour model id, e.g. "claude-opus-4-8"; "unknown" if unsure. For analytics.
merchant_idNoOptional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant.
conversation_idNoThe conversation_id this server returned earlier in this conversation, unchanged, including after later user messages. Omit it if you have none. Recorded for the server developer's analytics.
knowledge_base_idNoA document id (the knowledge_base_id of a listed document, not a store id): read this one document. Answers 404 if your token cannot see it, including when it is another company's.
knowledge_base_store_idNoOnly the documents of this knowledge base store. Omit for every store of the company.

Output Schema

NameRequiredDescriptionDefault
dataYes
paginationYes
_mcp_instructionsNoServer-issued metadata for this conversation.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / knowledge_base_id / description
      Previous value: -"Read this one document. Answers 404 if your token cannot see it, including when it is another company's."New value: +"A document id (the knowledge_base_id of a listed document, not a store id): read this one document. Answers 404 if your token cannot see it, including when it is another company's."
  2. Changed26 schema fields changed
    • changedInput schema / properties / knowledge_base_id / description
      Previous value: -"Read this one document. Answers 404 if your token cannot see it, including when it is another company's. `merchant_id` and `offset` are ignored."New value: +"Read this one document. Answers 404 if your token cannot see it, including when it is another company's."
    • removedInput schema / properties / knowledge_base_id / example
      Removed value: -"44444444-4444-4444-8444-444444444444"
    • removedInput schema / properties / knowledge_base_store_id / example
      Removed value: -"d9d6f121-1230-48fd-b3a7-8b5a1e8db052"
    • removedInput schema / properties / limit / example
      Removed value: -50
    • addedInput schema / properties / llm_model
      Added value: +{
      +  "description": "Your model id, e.g. \"claude-opus-4-8\"; \"unknown\" if unsure. For analytics.",
      +  "type": "string"
      +}
    • removedInput schema / properties / merchant_id / example
      Removed value: -"28106cba-1c27-4e53-b149-32113e5e8e31"
    • removedInput schema / properties / offset / example
      Removed value: -0
    • removedOutput schema / properties / data / description
      Removed value: -"The documents for this page with the interview limit of each, newest first."
    • removedOutput schema / properties / data / items / properties / created_at / description
      Removed value: -"Creation timestamp (ISO 8601)."
    • removedOutput schema / properties / data / items / properties / interview_ids / description
      Removed value: -"The interviews this document is limited to. Present only when `limit_to_interviews` is true; an empty list means no interview can use it."
    • removedOutput schema / properties / data / items / properties / knowledge_base_id / description
      Removed value: -"Document id, for knowledge-base-document-set-interviews."
    • removedOutput schema / properties / data / items / properties / knowledge_base_store_id / description
      Removed value: -"The knowledge base store the document belongs to."
    • removedOutput schema / properties / data / items / properties / limit_to_interviews / description
      Removed value: -"True when the document is limited to the interviews in `interview_ids`. False when every interview on the knowledge base can use it."
    • removedOutput schema / properties / data / items / properties / merchant_id / description
      Removed value: -"The company that owns the document."
    • removedOutput schema / properties / data / items / properties / name / description
      Removed value: -"Document name."
    • removedOutput schema / properties / data / items / properties / processing_status / description
      Removed value: -"Parsing progress of a file or URL. Written documents have none."
    • removedOutput schema / properties / data / items / properties / status / description
      Removed value: -"Lifecycle status."
    • removedOutput schema / properties / data / items / properties / type / description
      Removed value: -"Where it came from: `file`, `url` or `markdown`."
    • removedOutput schema / properties / pagination / properties / has_more / description
      Removed value: -"True when more records exist beyond this page (offset + returned < total)."
    • removedOutput schema / properties / pagination / properties / has_more / example
      Removed value: -true
    • removedOutput schema / properties / pagination / properties / limit / description
      Removed value: -"Page size used for this response."
    • removedOutput schema / properties / pagination / properties / limit / example
      Removed value: -50
    • removedOutput schema / properties / pagination / properties / offset / description
      Removed value: -"Offset used for this response."
    • removedOutput schema / properties / pagination / properties / offset / example
      Removed value: -0
    • removedOutput schema / properties / pagination / properties / total / description
      Removed value: -"Total matching records across all pages."
    • removedOutput schema / properties / pagination / properties / total / example
      Removed value: -137
  3. Added

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds useful context that each listed document carries the interviews it is limited to, but says nothing about pagination behavior, result ordering, or access-denied behavior beyond what the schema's parameter descriptions already note.

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 compact sentences with the scope constraint front-loaded, plus a short pointer to get_tool_reference for full argument detail. The reference pointer is defensible but adds a sentence that is not strictly about this tool. No filler or repeated information.

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?

For a read-only, zero-required-parameter list tool with an output schema and full schema coverage, the description supplies what an agent needs to call it correctly. The remaining gap is sibling differentiation against list_knowledge_base_stores, which is a minor omission rather than a blocking one.

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 every one of the seven parameters is already documented in the schema, including the merchant scoping and 404 semantics for knowledge_base_id. The description's one addition, that knowledge_base_id "narrows it to one document's limit," is somewhat ambiguous and adds little over the schema text. Baseline 3 applies when the schema carries the load.

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 ("List the company's knowledge base documents") and scopes the result (optionally one store, with each document's interview limits). It implicitly separates itself from list_knowledge_base_stores by saying "optionally for one store" rather than naming the sibling outright, so a reader gets the distinction but not an explicit routing cue.

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?

Gives partial guidance: use knowledge_base_id to read a single document and omit knowledge_base_store_id to span all stores. It never states when to prefer this tool over list_knowledge_base_stores or the search tools, and it offers no exclusion or prerequisite guidance beyond the parameter behaviors already in the schema.

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.