Skip to main content
Glama

integrations_start_config_flow

Start configuring a Home Assistant integration by entering its domain. Returns the first setup step with form schema and any errors.

Instructions

Start a new config flow for the given integration domain.

Returns the first step (form, schema, errors). Pass flow_id from the result into submit_config_flow_step to provide user input.

Example: start_config_flow("shelly") → {flow_id, step_id: "user", data_schema: [...]}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
handlerYes
show_advanced_optionsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

Without annotations, the description carries the burden of behavioral disclosure. It explains that the tool returns the first step (form, schema, errors) and provides an example output. It implies a stateful action by starting a flow, but does not detail side effects or prerequisites.

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?

The description is concise, with three sentences including an example. It is front-loaded with the core purpose and avoids extraneous information.

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

Completeness4/5

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

Given the tool's role in a multi-step config flow and the presence of an output schema, the description provides sufficient context to use the tool correctly. It links to the next step but could mention error handling or prerequisites.

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?

The description adds meaning for the 'handler' parameter by referring to 'integration domain' and giving an example ('shelly'). However, the 'show_advanced_options' parameter is not described, and schema coverage is 0%, so the description does not fully compensate.

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?

The description clearly states the tool starts a new config flow for a given integration domain, using specific verbs and resources. It distinguishes itself from sibling tools like 'integrations_submit_config_flow_step' by explaining the sequence of steps.

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

Usage Guidelines4/5

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

The description explicitly tells the user to pass the returned 'flow_id' to 'submit_config_flow_step', providing clear context for the next step. However, it does not mention when not to use this tool or specify alternatives.

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/Fistacho/ha-nexus-agent'

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