Skip to main content
Glama

pool_status

Read-only

Check the health, scan status, and topology of a single TrueNAS pool to monitor storage integrity and plan maintenance.

Instructions

[READ] Health and scan/topology status of a single pool.

Args: pool_id: TrueNAS pool id. target: TrueNAS target name from config.

Input Schema

NameRequiredDescriptionDefault
targetNo
pool_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

readOnlyHint=true already establishes the safe-read profile, and the '[READ]' tag merely restates it. The description does add value by scoping the return to health plus scan/topology status, but it says nothing about auth requirements, failure modes, or how expensive the call is.

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 single-sentence summary is front-loaded and the Args block is terse and scannable. Nothing is padded, though the bracketed '[READ]' tag is redundant with the annotation and slightly wastes the opening position.

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?

With no output schema, the description must convey what comes back, and it does so at a useful level (health and scan/topology status). It omits return structure and error behavior, but for a simple read-only status call it is adequate.

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 description coverage is 0%, so the description carries the full burden, and it does document both parameters: pool_id as the TrueNAS pool id and target as the target name from config. That meaningfully fills a gap the schema leaves entirely blank, though it does not note that target is optional or has a null default.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb+resource: health and scan/topology status of a single pool, which is more informative than a bare 'get pool'. However, it never distinguishes itself from closely overlapping siblings like pool_get, pool_health_rca, pool_capacity, or scrub_status, so an agent cannot tell from the text alone which one to pick.

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

Usage Guidelines2/5

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

There is no when-to-use, when-not-to-use, or alternative-tool guidance. The phrase 'of a single pool' weakly implies contrast with pool_list, but the reader gets no signal about when pool_status is preferable to pool_get or pool_health_rca.

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