Skip to main content
Glama
J-MaFf

s2-netbox-mcp

by J-MaFf

get_reader

Read-only

Retrieve details for a single physical access reader by READERKEY to inspect its configuration in LenelS2 S2 NetBox.

Instructions

Returns the details of a single reader for a given READERKEY (wraps NBAPI GetReader).

Input Schema

NameRequiredDescriptionDefault
READERKEYYesRequired. The unique READERKEY of the reader to retrieve.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.3

TDQS

B3.2/5.0
Behavior2/5

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

readOnlyHint=true already tells the agent this is a safe read. The description adds only that it 'wraps NBAPI GetReader,' an implementation detail that does not help invocation, and says nothing about not-found/error behavior or what happens with an unknown key.

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 front-loaded sentence with the verb and resource up front. The parenthetical wrapper note is the only arguably non-earning clause, but the overall size is efficient.

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 simple one-parameter read tool, the essentials are covered. With no output schema, however, the description does not indicate what 'details' are returned (credential format, location, status), leaving the return shape unspecified.

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 schema already documents READERKEY as required and unique. The description repeats the parameter name but adds no format, source, or lookup guidance beyond it, so baseline 3 applies.

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?

Clear verb (returns details) plus resource (a single reader) keyed by READERKEY. The word 'single' implicitly distinguishes it from the sibling get_readers, but the differentiation is left for the agent to infer rather than stated.

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?

Usage is only implied: 'a single reader' suggests this is the per-item companion to get_readers, but there is no explicit when-to-use or when-not-to-use statement, and no alternative is named.

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