Skip to main content
Glama

Read a knowledge base

get_knowledge_base
Read-onlyIdempotent

A knowledge base's sources and whether each is indexed yet (ready, indexing or failed with the error). Wait until its sources are ready before testing an agent that uses it.

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": {
      "knowledge_base_id": "<knowledge_base_id>"
    },
    "name": "get_knowledge_base"
  }
}

Input Schema

NameRequiredDescriptionDefault
knowledge_base_idYesFrom list_knowledge_bases.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

With annotations already covering read-only, idempotent, and non-destructive behavior, the description adds real value by disclosing the return payload: per-source indexing state with the enumerated values ready, indexing, and failed-with-error. That status/error semantics is only available here since there is no output schema; only ordering and any source metadata fields are left unstated.

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 short sentences, zero filler: the first defines the return content and the second front-loads the actionable timing guidance. Nothing repeats the annotations or the schema.

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 one-parameter read-only tool with no output schema, the description covers what is returned, the possible status values including the error case, and the practical reason to call it. The remaining gap is minor: it does not describe source-level fields or ordering.

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?

The single parameter is fully documented in the schema, including that the ID comes from list_knowledge_bases, and the description adds no further meaning such as accepted formats or behavior for an unknown ID. Per the high schema-coverage baseline, a 3 is appropriate.

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 states the resource (a knowledge base's sources) and exactly what is returned about each source (indexing status), which cleanly separates it from list_knowledge_bases and search_knowledge_base. It is phrased as a noun fragment rather than a verb-led statement, so the read action is implied by the title rather than stated.

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?

It gives a concrete when-to-use rule: wait until sources are ready before testing an agent that uses the knowledge base. It does not name exclusion cases or point to a sibling alternative for checking indexing another way, but the primary usage context is explicit.

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