Skip to main content
Glama

process_files_batch_api_v1_retrieval_process_files_batch

Batch process files and save their embeddings to a vector database for search and retrieval.

Instructions

Process a batch of files and save them to the vector database.

NOTE: We intentionally do NOT use Depends(get_session) here. The save_docs_to_vector_db() call makes external embedding API calls which can take 5-60+ seconds for batch operations. Database operations after embedding (Files.update_file_by_id) manage their own short-lived sessions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
collection_nameYes
filesYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
errorsYes
resultsYes
Behavior4/5

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

With no annotations, the description carries full burden. It discloses external API calls, 5-60+ second latency, and session management strategy. However, it omits failure behavior and idempotency.

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?

The description is brief and front-loaded with the purpose. The technical note adds value but is slightly verbose. Overall efficient for its content.

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?

Despite having an output schema, the description lacks critical context about processing pipeline (e.g., chunking, embedding), error handling, prerequisites (e.g., file upload required), and duplicate handling. Incomplete for a complex batch operation.

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

Parameters1/5

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

Schema description coverage is 0%, so description must compensate. It adds no parameter details: 'collection_name' is not mentioned, and 'files' is only described as 'batch of files' without structure. Agent gains no insight beyond schema.

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 it 'Process a batch of files and save them to the vector database', specifying the verb, resource, and destination. It distinguishes from siblings like process_file (single file) by emphasizing batch operations and latency.

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 implies batch use but does not explicitly compare to single-file alternatives or provide prerequisites. The note about latency hints at use cases but no direct when/when-not guidance.

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/TETRA-2023/open-webui-mcp'

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