Skip to main content
Glama

Create KB document

create_kb_document
Destructive

Add a knowledge base document the bot will answer from. Provide either content (manual text) or a public source_url to crawl.

Input Schema

NameRequiredDescriptionDefault
titleYes
contentNo
categoryYes
source_urlNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare this is a write (readOnlyHint=false), non-idempotent, and destructive, so the safety profile is covered. The description adds useful context that the document feeds the bot's answers and that a URL is crawled, but it omits ingestion timing, whether reingestion is needed before the doc is live, and any permission requirements.

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, and the core purpose is front-loaded before the input rule. Every clause carries information the caller needs.

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

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 4-parameter, destructive create tool with 0% schema description coverage and no output schema, the description is thin: it omits the two required fields, the enum semantics, size limits, and what happens after creation. An agent would have to read the raw schema to call this correctly.

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 0%, so the description must carry parameter meaning. It usefully distinguishes content (manual text) from source_url (public page to crawl) and implies mutual exclusivity, but it never mentions the two REQUIRED parameters (title, category) or explains the category enum values (faq/document/policy/other).

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 ("Add a knowledge base document") and even the effect ("the bot will answer from"), which is more than the name alone conveys. It is clearly distinguishable from siblings like get_kb_document, update_kb_document, and reingest_kb_document, though it never names those alternatives explicitly.

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?

The description gives one real usage rule — supply EITHER content OR a public source_url — which shapes invocation. However, it says nothing about when to reach for this tool versus update_kb_document/reingest_kb_document, nor about prerequisites such as a valid category or a reachable URL, leaving usage only implied.

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