Skip to main content
Glama

upload_knowledge_document

Index a PDF, DOCX, XLSX, PPTX, image, or text file (base64-encoded, max 20MB) as a knowledge source.

Input Schema

NameRequiredDescriptionDefault
bot_idYes
file_nameYes
mime_typeNo
file_base64Yes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden, and it does disclose two useful traits beyond the schema: the payload must be base64-encoded and is capped at 20MB. It is silent on indexing latency (is it async?), whether re-uploading the same file duplicates or replaces a source, 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?

One front-loaded sentence with no filler; the format list, encoding requirement, and size cap each earn their place.

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 mutation tool with no annotations, no output schema, and zero schema parameter documentation, the description is under-specified. An agent still cannot infer what bot_id should reference, whether mime_type is required for correct parsing, or what happens on success (indexing job vs immediate availability).

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and all four parameters are undocumented in the schema. The description clarifies only file_base64 (base64 encoding, formats, size limit); it says nothing about bot_id, file_name, or mime_type, leaving half the surface unexplained.

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 a specific verb ('Index') and resource ('file ... as a knowledge source') and enumerates supported formats (PDF, DOCX, XLSX, PPTX, image, text), which lets an agent recognize the operation. It does not distinguish itself from siblings like add_chatbot_knowledge, crawl_website_knowledge, or sync_cloud_storage, all of which also add knowledge.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no statement of when to use this tool versus the sibling ingestion paths (add_chatbot_knowledge, crawl_website_knowledge, sync_cloud_storage). Usage is only implied by the file-format list; no exclusions or prerequisites are given.

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