ha-nexus-agent

Overview Schema Source Related Servers Discussions Admin

Get add-on details

supervisor_get_addon

Read-onlyIdempotent

Retrieve full Supervisor info for one Home Assistant add-on with secret option values redacted, so you can review or edit options without exposing credentials.

Instructions

Get full Supervisor info for one add-on, with secret option values redacted.

Calls GET /addons/<slug>/info: every field Supervisor stores for that add-on (options schema, current options, ports, boot mode, version, state and more), except options values are replaced with a fixed placeholder wherever the schema marks a field a password, the key name looks like a secret (password/pass/pwd, token, api_key, secret, credential, private, key as a word/suffix), or the value is a URL with inline credentials (scheme://user:pass@host) — covers nexus's own API key and other add-ons' secrets/connection strings alike, recursively through nested groups and lists. An empty/unset value stays empty. Adds redacted_fields: {"path", "reason"} dicts.

Use when: the full add-on record is needed, e.g. before editing its options with supervisor_set_addon_options, which accepts the same placeholder back for an unchanged secret field without overwriting it. Not for: a quick overview across all add-ons — use supervisor_list_addons. Returns: Supervisor's add-on info payload with secret-looking options values replaced by a placeholder, plus redacted_fields. Errors: {"error": "invalid_slug"} for a bad slug; {"error": "SUPERVISOR_TOKEN not set — Nexus must run as HA add-on for Supervisor API"} when the token env var is missing; {"error": "HTTP <status>", "detail": ...} if the slug does not exist.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`slug`	Yes	Add-on slug, e.g. from `supervisor_list_addons`.

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.25.1Oct 4, 2026
- addedInput schema / properties / slug / description
```
Added value: +"Add-on slug, e.g. from `supervisor_list_addons`."
```
First observedv0.3.0May 3, 2026

TDQS

A4.4/5.0

Behavior4/5

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

Annotations already cover readOnlyHint, idempotentHint and destructiveHint, but the description adds a rich redaction contract (fixed placeholder, empty values stay empty, redacted_fields with path and reason, recursive redaction through nested groups and lists) plus an errors section naming invalid_slug, missing SUPERVISOR_TOKEN, and HTTP-status failures. It does not strictly contradict any annotation. A minor gap is that it doesn't restate the read-only guarantee.

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

Conciseness4/5

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

It front-loads the redaction behavior and usage guidance and separates content into Purpose, Redaction, Use when, Not for, Returns and Errors sections. The redaction enumeration (password/pass/pwd, token, api_key, secret, credential, private, key) is verbose and could be tightened, costing one point.

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?

Despite having output schema the description still covers the relevant parts of the return (redacted options values plus redacted_fields), states the empty-value behavior, and documents failure modes. Nothing an agent needs to call this 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 description coverage is 100%, so the schema already documents the single slug parameter. The description adds a cross-reference to supervisor_list_addons as the source of slugs but no syntax or format detail beyond what the schema provides, so the baseline of 3 is correct.

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 full Supervisor info for one add-on') and names the sibling it is not ('Not for: a quick overview across all add-ons — use supervisor_list_addons'). An agent can distinguish it from supervisor_list_addons without opening either schema.

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 name concrete alternatives (supervisor_set_addon_options for editing, supervisor_list_addons for a quick overview) along with the exact condition that selects each.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server