Skip to main content
Glama
zvec-ai

zvec-mcp-server

Official
by zvec-ai

insert_documents

Add new documents to a Zvec collection with unique IDs and schema validation. Operation fails if a document with the same ID exists.

Instructions

Insert new documents into a collection.

Documents must have unique IDs and conform to the collection schema. This operation fails if a document with the same ID already exists.

Args: params (InsertDocumentsInput): Validated input parameters containing: - collection_name (str): Collection identifier - documents (List[DocumentInput]): Documents to insert

Returns: str: Success message with insertion count or error message

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

Annotations already indicate this is not read-only (readOnlyHint=false) and not destructive (destructiveHint=false). The description adds specific mutation behavior: insertion with uniqueness constraint, failure on duplicate ID, and return of success message with count or error. This provides useful context beyond annotations.

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 concise, front-loaded with purpose, and includes structured Args/Returns sections. It avoids verbosity, though the Args section partially duplicates schema information. Still efficient and clear.

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?

Given the tool has a single parameter (nested) and an output schema, the description covers the essentials: purpose, constraints, input structure, output type (string with success/error). It explains the failure case but does not detail validation or side effects beyond annotations. Adequate for its complexity.

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?

The description repeats parameter names (collection_name, documents) and document fields (id, vectors, fields) from the schema, but adds minimal new meaning. The schema already provides detailed descriptions for each property, so the description adds no new semantics. Baseline 3 is appropriate.

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 'Insert new documents into a collection.' and specifies constraints: 'Documents must have unique IDs and conform to the collection schema. This operation fails if a document with the same ID already exists.' This distinguishes it from siblings like upsert_documents or update_documents.

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 usage for inserting new documents with unique IDs, but does not explicitly state when to avoid this tool or suggest alternatives such as upsert_documents or update_documents. Given sibling tools, more explicit guidance would improve differentiation.

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/zvec-ai/zvec-mcp-server'

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