Skip to main content
Glama

ZeroWidth Workbench

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

TableJSON 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

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered. The description adds value beyond that by disclosing what the read returns (name, recipe, status, document/chunk counts, embedding model, ingestion settings). It does not address auth/scope behavior, but the safety profile is already handled.

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 tight sentences, front-loaded with the returned fields and following with the usage condition. No filler. The field enumeration is a slightly long list but each item is informative.

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 carries the return-value burden, and it does so by listing the concrete fields an agent would receive. For a simple single-record read with full schema coverage and safety annotations, this is nearly complete; only auth/scope behavior is left unstated.

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 the schema already documents both kbId and workspace (including the workspace-auth nuance). The description adds only provenance guidance ('Get the kbId from workbench_kb_list'), so the baseline 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 names the specific resource (one knowledge base) and enumerates the fields it returns, and the title supplies the read verb. It implicitly distinguishes itself from the plural sibling workbench_kb_list by pointing to it for the kbId, though the verb itself is left to the title. Clear and unambiguous, just not a fully self-contained verb+resource statement.

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 an explicit usage trigger: 'Read it to confirm a KB has content before pointing a flow at it,' which tells the agent when this tool is the right call. It also routes to workbench_kb_list to obtain the id. There is no explicit when-not-to-use or statement of alternatives for the read itself, so it falls short of a 5.

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