Skip to main content
Glama

Get an Assist pipeline

voice_get_pipeline
Read-onlyIdempotent

Fetch a single Home Assistant Assist pipeline by ID, or the preferred pipeline when omitted, to inspect its engines and languages.

Instructions

Get a single Assist pipeline by id, or the preferred one if omitted.

Calls WS assist_pipeline/pipeline/get, passing pipeline_id only when given.

Use when: you need one pipeline's full configuration (engines, languages) rather than the whole list. Not for: every pipeline at once — use voice_list_pipelines. Returns: dict with the pipeline's engine/language fields, as returned by HA.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pipeline_idNoPipeline ID to fetch, from `voice_list_pipelines`. Omit to return the current preferred pipeline instead.

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: +"Pipeline ID to fetch, from `voice_list_pipelines`. Omit to return the current preferred pipeline instead."
  2. Addedv0.4.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already cover readOnly/idempotent/non-destructive, so the bar is lower; the description still adds value by disclosing the WS method used (assist_pipeline/pipeline/get), the conditional argument passing, and the preferred-pipeline fallback. It doesn't discuss auth or error behavior, but that is minor given the safety annotations.

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?

Short, front-loaded (purpose first, then dispatch detail, then when/when-not, then return shape), with no redundant sentences.

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 read tool with full annotations and an output schema, the description covers purpose, routing, dispatch mechanism, fallback behavior, and return shape. Nothing an agent needs to invoke it correctly 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 parameter description already explains the omit-for-preferred behavior, so the description mostly restates it. Baseline 3 applies since the schema carries the parameter information.

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 and resource ('Get a single Assist pipeline by id, or the preferred one if omitted'), and explicitly distinguishes itself from the sibling voice_list_pipelines. The fallback-to-preferred behavior is called out up front.

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?

Contains explicit 'Use when' and 'Not for' clauses naming the alternative (voice_list_pipelines) with the selecting condition. An agent can route between the two tools without 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