Skip to main content
Glama

Get add-on resource stats

supervisor_get_addon_stats
Read-onlyIdempotent

Fetch an add-on's current CPU, memory, network, and disk I/O usage to check whether it is consuming unexpected resources. Returns only a snapshot, not historical trends.

Instructions

Get an add-on's current runtime resource usage.

Calls GET /addons/<slug>/stats for CPU, memory, network and disk I/O figures at the moment of the call.

Use when: checking whether an add-on is consuming unexpected resources. Not for: historical usage over time — this returns only a snapshot. Returns: Supervisor's raw stats payload (CPU percent, memory usage/limit, network and block I/O counters). 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 add-on is not running.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesAdd-on slug to fetch stats for, e.g. from `supervisor_list_addons`.

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 / slug / description
      Added value: +"Add-on slug to fetch stats for, e.g. from `supervisor_list_addons`."
  2. First observedv0.3.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already establish the safe-read profile (readOnlyHint, idempotentHint, destructiveHint false), and the description goes well beyond them by disclosing the raw return shape (CPU percent, memory usage/limit, network/block I/O counters) and three concrete error modes, including the SUPERVIZOR_TOKEN env-var prerequisite. That auth/environment constraint is exactly the kind of context an agent cannot infer from annotations alone.

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?

The description is front-loaded with purpose, then scoping, returns, and errors in clearly labeled sections, so an agent can scan it quickly. The error block is somewhat verbose (the full token-error string is quoted), which is slightly more than strictly needed, but every line still carries information.

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 one-parameter, read-only stats tool with an output schema, this description covers purpose, when-to-use, when-not-to-use, return shape, and failure modes. Nothing an agent needs in order 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 description coverage is 100%, so the single slug parameter is already fully documented in the schema, including the pointer to supervisor_list_addons. The description adds no further slug syntax or format detail, so the baseline of 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?

The first sentence names a specific verb ('Get') and resource ('an add-on's current runtime resource usage') and even discloses the backing endpoint GET /addons/<slug>/stats. It explicitly distinguishes this snapshot tool from historical-usage tools, so an agent can tell it apart from siblings like supervisor_get_addon_logs without opening the 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?

The description gives an explicit 'Use when' trigger ('checking whether an add-on is consuming unexpected resources') and an explicit 'Not for' exclusion ('historical usage over time — this returns only a snapshot'). It also routes the agent to supervisor_list_addons as the source of slugs, 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