Skip to main content
Glama
mhajder

NetBox MCP Server

by mhajder

Netbox Get Status

netbox_get_status
Read-onlyIdempotent

Retrieves NetBox version, installed plugins and apps, worker status, and authenticated user, and reports server read-only/dry-run modes.

Instructions

Get NetBox version, installed plugins and apps, worker status and the authenticated user. Also reports this server's read-only/dry-run modes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

The annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint, so the safety profile is covered. The description adds genuine behavioral context beyond that: it discloses that the server's read-only/dry-run modes are reported and implies an authenticated-user requirement via "the authenticated user."

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 lean sentences, front-loaded with the primary content (what status data is retrieved). Every clause carries meaning with no filler, and the secondary note about read-only/dry-run modes is placed last appropriately.

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?

With an output schema present, return-value detail need not be repeated, and the description still previews the key fields returned. For a zero-parameter, read-only status tool whose annotations cover the safety profile, nothing an agent needs to call it correctly is missing.

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?

The tool takes zero parameters, so per the rubric the baseline is 4. There are no parameters for the description to clarify, and the schema is trivially complete.

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 uses a specific verb ("Get") plus the resource (NetBox status) and enumerates exactly what is returned: version, installed plugins/apps, worker status, authenticated user, and server modes. This is clearly distinct from the object CRUD/query siblings, though it never explicitly names an alternative tool to reinforce the distinction.

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?

There is no explicit when-to-use or when-not-to-use guidance; the usage (a status/health check) is only implied by the enumerated return fields. No alternatives or prerequisites are mentioned, so an agent must infer the appropriate invocation context.

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