Skip to main content
Glama
AIops-tools

io.github.AIops-tools/network-aiops

get_environment

Read-only

Read fan, temperature, power, CPU, and memory data from a network device to check hardware health. Specify a target device or omit it to query the default.

Instructions

[READ] Hardware environment: fans, temperature, power, CPU, memory.

Args: target: Device name from config; omit to use the default device.

Input Schema

NameRequiredDescriptionDefault
targetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.8.0

TDQS

A3.5/5.0
Behavior3/5

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

readOnlyHint=true already declares this is a safe read, and the '[READ]' prefix is consistent with it. The description adds the useful detail that the payload covers five specific hardware categories, but says nothing about response shape, timing, or device-access requirements beyond the annotation.

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?

Two tight lines with the resource scope front-loaded and the parameter note separated into an Args block. No filler sentences.

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?

For a one-parameter, read-only tool with no output schema, the definition covers purpose, scope, and the optional-target default. Only anticipated return format and any device-not-found behavior are unaddressed, which is a minor gap.

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 burden for the single parameter, and it does: it defines target as a device name from config and explains the default-device behavior when omitted. That is meaningful semantics the schema lacks, though it does not describe expected name format.

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 states a specific verb and resource ([READ] Hardware environment) and enumerates what it covers: fans, temperature, power, CPU, memory. This lets an agent distinguish it from sensor-specific siblings like get_optics or interface-oriented ones like get_interfaces_counters, though it never names an alternative explicitly.

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?

Beyond the '[READ]' tag and the target-default note, there is no guidance on when to choose this over adjacent tools such as device_health or device_facts, nor any prerequisite or exclusion. The usage must be inferred from the resource name alone.

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