Skip to main content
Glama

create_knowledge_document

Create a knowledge document. Attach documents separately to use them in an assistant. Total injected knowledge has a 200 KiB limit.

Input Schema

NameRequiredDescriptionDefault
dataYesResource fields. Attach documents separately to use them in an assistant. Total injected knowledge has a 200 KiB limit. Additional settings are documented in https://apifleet.dev/docs

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnly=false, destructive=false, idempotent=false, so the safety profile is covered. The description adds the 200 KiB total knowledge quota, which is a real behavioral constraint, but that same sentence is copied verbatim from the schema's data description, and it omits what happens on a duplicate name or what the call returns.

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 short sentences, front-loaded with the purpose, with no tangential content. It loses a point because sentences two and three merely restate the nested schema description rather than adding new 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 low-complexity single-parameter create tool with full schema coverage and annotations, the description covers purpose, the quota constraint, and the separation from assistant attachment. Only the return value and duplicate-name behavior 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 single nested object documents name/source/content with limits, so the schema carries the parameter burden. The description adds no syntax, formatting, or precedence detail beyond it, so baseline 3 applies.

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 a specific verb and resource ("Create a knowledge document"), so the operation is unambiguous against delete/get/list/update siblings. It does not explicitly contrast with update_knowledge_document, but the create semantics are clear from the verb.

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?

"Attach documents separately to use them in an assistant" implies the follow-up workflow step, which is useful guidance. However, it never names the tool that performs the attachment (e.g. set_assistant_knowledge), and gives no conditions for choosing create over update_knowledge_document when a document may already exist.

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