Skip to main content
Glama
J-MaFf

s2-netbox-mcp

by J-MaFf

get_reader_groups

Read-only

Lists reader groups configured on an S2 NetBox system via NBAPI, with an optional pagination cursor to continue results.

Instructions

Lists reader groups configured on the NetBox system (wraps NBAPI GetReaderGroups).

Input Schema

NameRequiredDescriptionDefault
STARTFROMKEYNoOptional. Pagination cursor to continue listing from a previous call.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.3

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds only 'wraps NBAPI GetReaderGroups', an implementation detail rather than useful behavior; it does not mention pagination behavior even though a cursor parameter exists.

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?

A single efficient sentence that front-loads the verb and resource. The parenthetical wrapper note is marginally wasteful but brief, so it doesn't harm readability.

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?

For a read-only list tool with a fully documented single parameter and no output schema, the definition is adequate. It could be stronger by noting pagination intent or routing to the singular sibling, but nothing critical 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%, so the single STARTFROMKEY parameter is already fully documented in the schema as a pagination cursor. The description adds no parameter meaning beyond that, which is the expected baseline when the schema does the heavy lifting.

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?

States a specific verb ('Lists') and resource ('reader groups') with a location qualifier ('configured on the NetBox system'), so the agent knows exactly what it retrieves. It doesn't explicitly differentiate itself from the singular sibling get_reader_group, but the plural scope is reasonably 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?

There is no guidance on when to use this versus the nearby get_reader_group or get_readers siblings, and no prerequisites or exclusions are stated. Usage is only implied by the word 'Lists'.

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