Skip to main content
Glama

validate_pipeline

Validates a pipeline YAML configuration against the deepset API to ensure correctness and return validation results or error messages.

Instructions

Validates the provided pipeline YAML configuration against the deepset API. :param yaml_configuration: The YAML configuration to validate. :returns: Validation result with original YAML or error message.

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

Examples::

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

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

# Mixed call
validate_pipeline(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
yaml_configurationYes
Behavior4/5

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

The description discloses that the output is automatically stored and can be referenced in other functions, and that it returns a formatted preview with an object ID. It also explains object reference syntax. Since there are no annotations, this behavioral context is valuable.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

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

The description is structured with a param/returns block and examples, but it is somewhat verbose. It could be more concise by removing the docstring-style formatting and redundancy about object references.

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?

Given a single parameter and no output schema, the description covers the input, return format, object references, and output storage. However, it lacks details on error handling, expected success/failure conditions, and potential validation outcomes.

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

Parameters4/5

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

The description adds meaning beyond the schema by explaining the yaml_configuration parameter ('The YAML configuration to validate') and describing the object reference pattern. With 0% schema description coverage, this compensation is significant.

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 tool validates pipeline YAML configuration against the deepset API. It specifies the resource (pipeline YAML) and action (validate), giving a clear purpose. However, it does not explicitly distinguish from sibling tools like validate_index.

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?

The description provides examples of calling the tool but gives no guidance on when to use it versus alternatives. It lacks explicit context for when to use or not use this tool, and does not mention when it should be preferred over other tools.

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

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