Skip to main content
Glama

Oxidized List

oxidized_list
Read-onlyIdempotent

List devices tracked by Oxidized for configuration backup. Supports pagination and optional hostname or ID filtering.

Instructions

List devices tracked by Oxidized for config backup.

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of results to return
offsetNoNumber of results to skip (offset) for pagination
hostnameNoFilter by device hostname or ID. Optional. An unknown device returns an error.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.12.0
    • changedInput schema / properties / hostname / description
      Previous value: -"Filter by device hostname. Optional."New value: +"Filter by device hostname or ID. Optional. An unknown device returns an error."
  2. Changed2 schema fields changedv1.10.3
    • addedInput schema / properties / limit
      Added value: +{
      +  "default": 100,
      +  "description": "Maximum number of results to return",
      +  "minimum": 1,
      +  "type": "integer"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "default": 0,
      +  "description": "Number of results to skip (offset) for pagination",
      +  "minimum": 0,
      +  "type": "integer"
      +}
  3. First observedv1.9.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds only that the devices are Oxidized-managed backups; it says nothing about pagination behavior or the unknown-hostname error path.

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?

A single front-loaded sentence with no redundant or filler content. Nothing in it needs trimming.

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

Completeness3/5

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

An output schema exists, so return values need no explanation, and the annotations cover safety. What is missing is the relationship to oxidized_config_get/oxidized_config_search and any note that the hostname filter can error on unknown devices, leaving the agent to discover the discovery-to-fetch workflow on its own.

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 limit, offset and hostname are already fully documented in the schema. The description adds no extra meaning about filtering or pagination defaults, which matches the baseline for a fully-documented schema.

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?

Specific verb-plus-resource: 'List devices tracked by Oxidized for config backup' tells the agent exactly what is returned and why. It implies a distinction from oxidized_config_get and oxidized_config_search but never names those siblings, so the differentiation is only inferable.

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?

No when-to-use or when-not-to-use guidance, and no pointer to the sibling tools that fetch or search actual configs. The agent must infer that this is the discovery step before oxidized_config_get.

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