Skip to main content
Glama

Oxidized Config Search

oxidized_config_search
Read-onlyIdempotent

Search every stored Oxidized device configuration for a string, such as an IP, interface, or ACL name, to identify matching devices.

Instructions

Search all Oxidized device configurations for a string.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of results to return
offsetNoNumber of results to skip (offset) for pagination
searchYesSearch string to look for in all stored device configs (e.g. an IP address, interface name, ACL name, or any config keyword)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
      +}
  2. First observedv1.9.0

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is fully covered. The description adds the scope of 'all' configs but does not disclose additional behavior such as case sensitivity, match semantics, or performance characteristics. This is acceptable but not rich.

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?

The description is a single sentence with no filler. The action and resource are front-loaded, and every word contributes to understanding the tool's purpose.

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 simple search tool, the description, combined with the fully described parameters, existing output schema, and read-only annotations, covers everything an agent needs to select and invoke it correctly. No critical context 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%, and each parameter (search, limit, offset) has a clear description. The tool description adds no extra semantic meaning beyond restating the search string concept, so it meets the baseline but does not go further.

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 uses a specific verb ('Search') with a specific resource ('all Oxidized device configurations') and a clear object ('for a string'). The word 'all' distinguishes it from related tools like oxidized_config_get, which presumably retrieves a single device's config, making the purpose unambiguous.

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

Usage Guidelines3/5

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

The description implies this tool is for searching across all device configs, but it does not explicitly state when to use it versus alternatives like oxidized_config_get or oxidized_list. Given the large sibling set, adding a note such as 'use when you need to find which configs contain a string; use oxidized_config_get for a specific device's config' would improve guidance.

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