Skip to main content
Glama
homeassistant-ai

Home Assistant MCP Server

Official
by homeassistant-ai
OverviewSchemaRelated ServersScoreDiscussions
Python
Remote

Get Apps (add-ons)

ha_get_app
Read-onlyIdempotent

Retrieve Home Assistant add-on details or lists. Specify a slug for one add-on's info, or list installed or available add-ons with optional filtering and stats.

Instructions

Get Home Assistant Apps (formerly known as add-ons, and this tool as ha_get_addon) - list installed, available, or get details for one.

This tool retrieves add-on information based on the parameters:

  • slug provided: Returns detailed info for a single add-on (ingress, ports, options, state)

  • source='installed' (default): Lists currently installed add-ons

  • source='available': Lists add-ons available in the add-on store

Note: This tool only works with Home Assistant OS or Supervised installations.

SINGLE ADD-ON (slug provided): Returns comprehensive details including ingress entry, ports, options, state, and (when the add-on exposes one) a top-level log_level reflecting the current Supervisor option — useful for confirming ha_manage_app log_level changes. Useful for discovering what APIs an add-on exposes before calling ha_manage_app.

INSTALLED ADD-ONS (source='installed'): Returns add-ons with version, state (started/stopped), and update availability.

  • include_stats: Optionally include CPU/memory usage statistics

AVAILABLE ADD-ONS (source='available'): Returns add-ons from official and custom repositories that can be installed.

  • repository: Filter by repository slug (e.g., 'core', 'community')

  • query: Search by name or description (case-insensitive)

Example Usage:

  • List installed add-ons: ha_get_app()

  • Get Node-RED details: ha_get_app(slug="_nodered")

  • List with resource usage: ha_get_app(include_stats=True)

  • List available add-ons: ha_get_app(source="available")

  • Search for MQTT: ha_get_app(source="available", query="mqtt")

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugNoAdd-on slug for detailed info (e.g., '<prefix>_nodered'). Slug prefixes vary by add-on repository — omit to list all add-ons and discover the actual installed slug.
queryNoSearch filter for add-on names/descriptions (only for source='available')
sourceNoAdd-on source: 'installed' (default) for currently installed add-ons, 'available' for add-ons in the store that can be installed.
repositoryNoFilter by repository slug, e.g., 'core', 'community' (only for source='available')
include_statsNoInclude CPU/memory usage statistics (only for source='installed')

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Tool Definition Quality

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, and the description adds valuable constraints such as 'only works with Home Assistant OS or Supervised installations' and clarifies naming (formerly add-ons). No contradictions; the added OS limitation enriches transparency beyond annotations.

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 verbose and repetitive, restating examples and bullet points that overlap with the schema. It could be trimmed to a few sentences without losing essential information, but the structure is logically organized.

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?

Covers the main use cases (detailed info, list installed/available), includes optional stats, and mentions the OS requirement. It does not describe the output schema, but that is not mandated. The description is sufficiently complete for a read-only retrieval tool.

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?

Schema already covers 100% of parameters with detailed descriptions, so baseline is 3. The description adds helpful nuances like 'slug prefixes vary by add-on repository' and provides concrete examples for each parameter, slightly increasing clarity.

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's purpose: to retrieve add-on information (list installed/available or get details for one). It explicitly distinguishes from sibling tools like ha_manage_app, which likely modifies add-ons, by focusing on read-only retrieval.

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?

Provides clear guidance on when to use the tool, including examples for listing installed vs. available add-ons, filtering by repository, and searching. It also advises using it 'before calling ha_manage_app' to discover APIs, establishing a practical usage context.

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/homeassistant-ai/ha-mcp'

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