Skip to main content
Glama

Train KB from DOCX

lyzr_kb_train_docx

Train a knowledge base by uploading a DOCX file, enabling retrieval-augmented generation from the document's content.

Instructions

Upload and train a DOCX file into a knowledge base.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rag_idYesThe ID of the RAG system to train
filenameYesName of the file being uploaded
mime_typeNoMIME type of the file (optional)
chunk_sizeNoChunk size for splitting the document (default 1000)
extra_infoNoExtra metadata JSON string (default "{}")
data_parserNoOptional parser strategy name to use for this file
chunk_overlapNoChunk overlap for splitting the document (default 100)
parser_configNoOptional JSON string with parser configuration
file_content_base64YesBase64-encoded contents of the file to train
Behavior2/5

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

Annotations indicate a mutating operation (readOnlyHint false), and the description merely repeats that action without adding context about side effects, processing time, or reversibility. No extra behavioral disclosure beyond what annotations already state.

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?

The description is a single clear sentence with no wasted words. It is perfectly concise and front-loaded.

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 tool with 9 parameters, a mutation, and no output schema, this description is too thin. It omits mention of prerequisites (e.g., the rag_id), what happens after training, or how the response is structured, making it incomplete for an agent.

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%, so the description is not required to explain parameters. The description adds no additional parameter semantics, resulting in the baseline score of 3.

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 clearly states a specific verb ('Upload and train'), a resource ('DOCX file'), and a target ('a knowledge base'). It distinguishes from sibling tools by naming the DOCX format explicitly.

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?

No guidance is provided on when to use this tool vs alternatives like kb_train_pdf or kb_train_txt_file. The format is implied by the name but there are no explicit conditions or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/nandanNM/lyzr-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server