Skip to main content
Glama
deepset-ai

deepset-mcp

Official
by deepset-ai
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

create_index

Creates a new index in your Haystack Enterprise Platform workspace from a YAML configuration and optional description. Use it to set up searchable data storage for pipelines.

Instructions

Creates a new index within your Haystack Enterprise Platform workspace. :param index_name: Unique name of the index to create. :param yaml_configuration: YAML configuration to use for the index. :param description: Description of the index to create. :returns: A message and the created index, or an error message.

All parameters accept object references in the form @obj_id or @obj_id.path.to.value.

Examples::

# Direct call with values
create_index(data={'key': 'value'}, threshold=10)

# Call with references
create_index(data='@obj_123', threshold='@obj_456.config.threshold')

# Mixed call
create_index(data='@obj_123.items', threshold=10)The output is automatically stored and can be referenced in other functions.

Returns a formatted preview with an object ID (e.g., @obj_123). Use the object store tools in combination with the object ID to view nested properties of the object. Use the returned object ID to pass this result to other functions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
index_nameYes
descriptionNo
yaml_configurationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior3/5

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

No annotations exist, so the description carries the full burden. It does disclose useful behavior: the return is 'a message and the created index, or an error message', the output is auto-stored, and an object ID is returned for chaining. It says nothing about permissions, uniqueness enforcement on index_name, or side effects, which leaves real 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.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose is front-loaded, but the body is bloated with Sphinx docstring artifacts (:param:, :returns:), generic boilerplate about the object store repeated twice, and example calls whose parameter names (data, threshold) do not match this tool's schema. Much of the text does not earn its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema and no annotations, the description does cover the return shape and object-store mechanics, which is the minimum needed to use the result. It omits duplicate-name behavior, required permissions, and what the YAML configuration must contain, so an agent could still call it incorrectly.

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 names all three parameters and adds genuinely useful object-reference syntax ('@obj_id.path.to.value') not present in the schema, but the per-parameter notes are thin (yaml_configuration is not explained beyond 'YAML configuration to use') and the code examples reference non-existent parameters (data, threshold), which is actively misleading.

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 opening sentence gives a specific verb+resource ('Creates a new index') scoped to the Haystack Enterprise Platform workspace, which is enough to distinguish it from unrelated siblings like create_pipeline or create_deployment. It does not explicitly contrast itself with the closest siblings (update_index, validate_index, deploy_index), so it stops short of a 5.

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 guidance on when to use create_index versus update_index, validate_index, or deploy_index, nor any stated prerequisites. The only routing advice concerns post-call object handling ('use the object store tools'), not tool selection.

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