Skip to main content
Glama

Read one knowledge base

workbench_kb_get
Read-only

One knowledge base: name, recipe (docs / tabular / graph), status, document and chunk counts, embedding model, and ingestion settings. Read it to confirm a KB has content before pointing a flow at it. Get the kbId from workbench_kb_list.

Input Schema

NameRequiredDescriptionDefault
kbIdYesKnowledge base id.
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.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=false, so the safety profile is covered. With no output schema, the description carries the return-shape burden and does enumerate the fields returned, which is genuinely useful beyond the annotations; it stops short of explaining what status/ingestion settings values mean.

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?

Three tight sentences, front-loaded with the field inventory, then purpose, then the ID source. No filler; only minor density in the field list.

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 single-fetch tool with annotations covering safety and a schema covering both params, the description fills the remaining gaps: what you get back, when to call it, and where the ID comes from. Nothing essential is missing, though status value semantics are left implicit.

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% and the workspace parameter is richly documented in the schema itself. The description only adds provenance for kbId ('get it from workbench_kb_list'), which is more usage routing than parameter semantics, so the baseline 3 holds.

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?

The description states the exact resource and enumerates the concrete fields returned (name, recipe, status, counts, embedding model, ingestion settings), so the agent knows precisely what this tool yields. It also names the sibling workbench_kb_list as the source of the kbId, clearly distinguishing the single-fetch from the list operation.

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 usage context ('read it to confirm a KB has content before pointing a flow at it') and a prerequisite ('get the kbId from workbench_kb_list'). No explicit when-not guidance, but the intended use case is unmistakable.

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