Skip to main content
Glama
Sign In
Typesense MCP Server

Typesense MCP Server

by avarant
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

create_document

Add a new document to a specified collection in Typesense, ensuring it includes required fields like 'id' unless using auto-schema. Simplify document creation for structured data storage and retrieval.

Instructions

Creates a single new document in a specific collection.

Args:
    ctx (Context): The MCP context.
    collection_name (str): The name of the collection.
    document (dict): The document data to create (must include an 'id' field unless auto-schema).

Returns:
    dict | str: The created document dictionary or an error message string.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "collection_name": "<collection_name>",
      "document": "<document>"
    },
    "name": "create_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
collection_nameYes
documentYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool creates a document and mentions an 'id' field requirement, but fails to cover critical aspects like permissions needed, error handling, whether it's idempotent, or mutation effects. This leaves significant gaps for a mutation tool.

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 front-loaded with the core purpose in the first sentence, followed by structured parameter and return details. It avoids unnecessary fluff, but the Args/Returns formatting could be more integrated into natural language, slightly affecting flow.

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?

Given the complexity of a mutation tool with no annotations, no output schema, and 0% schema coverage, the description is incomplete. It lacks details on error cases, return value structure beyond 'dict | str', and behavioral traits like idempotency or side effects, making it inadequate for safe agent use.

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 description coverage is 0%, so the description must compensate. It explains that 'collection_name' specifies the target collection and 'document' includes data with an 'id' field requirement, adding some semantic context beyond the bare schema. However, it doesn't detail format constraints or examples, keeping it at a baseline level.

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 clearly states the verb ('creates') and resource ('single new document in a specific collection'), making the purpose evident. However, it doesn't explicitly differentiate from sibling tools like 'index_multiple_documents' or 'upsert_document', which prevents a perfect score.

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 versus alternatives like 'upsert_document' or 'index_multiple_documents'. The description mentions the tool's function but lacks context about prerequisites, constraints, or comparisons with siblings, leaving the agent without usage direction.

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

Deploy Server

Other Tools

Related Tools