Skip to main content
Glama

Delete an Assist pipeline

voice_delete_pipeline
DestructiveIdempotent

Delete an Assist pipeline by ID. To remove the preferred pipeline, first assign preference to another pipeline using voice_set_preferred_pipeline.

Instructions

Delete an Assist pipeline via WS assist_pipeline/pipeline/delete.

HA rejects deleting the pipeline currently marked preferred — call voice_set_preferred_pipeline with a different id first in that case.

Use when: permanently removing a pipeline that is no longer needed. Not for: the preferred pipeline without switching preference first, and not for temporarily disabling a pipeline (HA has no such state). Returns: HA's WS response for assist_pipeline/pipeline/delete (typically empty on success).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pipeline_idYesID of the pipeline to delete, from `voice_list_pipelines`.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.25.1
    • addedInput schema / properties / pipeline_id / description
      Added value: +"ID of the pipeline to delete, from `voice_list_pipelines`."
  2. Addedv0.4.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, but the description adds the non-obvious behavioral constraint that HA rejects deleting the currently-preferred pipeline and requires switching preference first, plus the fact that no 'disabled' state exists. That is substantive context beyond the structured hints.

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

Conciseness5/5

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

Front-loaded with the action, then structured Use when / Not for / Returns sections. Every sentence carries load — the precondition, the exclusion, and the return behavior — with no redundancy.

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

Completeness5/5

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

For a single-param destructive tool with an output schema present, the description covers the destructive caveat, the required precondition, and even summarizes the return. Nothing an agent needs to call it safely is missing.

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 coverage is 100% and the single parameter already documents itself ('ID of the pipeline to delete, from voice_list_pipelines'). The description adds no format or syntax detail beyond the schema, so the baseline 3 applies.

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?

States a specific verb (Delete) and resource (Assist pipeline) and even names the underlying WS command `assist_pipeline/pipeline/delete`, which cleanly separates it from the sibling voice_update_pipeline and voice_create_pipeline. An agent knows exactly what this does.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit 'Use when' and 'Not for' clauses: permanent removal only, not for the preferred pipeline without switching preference first, and not for disabling (which HA does not support). It routes the agent to voice_set_preferred_pipeline as the required prior step, leaving nothing to inference.

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