Skip to main content
Glama
J-MaFf

s2-netbox-mcp

by J-MaFf

get_card_formats

Read-only

Retrieve the card formats configured on the NetBox system to see which credential types are supported for access control.

Instructions

Returns the card formats configured on the NetBox system (wraps NBAPI GetCardFormats). No parameters required.

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.3

TDQS

B3.1/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 'wraps NBAPI GetCardFormats,' an internal implementation detail of no decision value, and says nothing about scope, completeness of the returned set, or pagination.

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 short sentence with the core purpose front-loaded. The trailing parenthetical about the NBAPI wrapper is dead weight but does not obscure the main claim.

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?

The tool is simple and parameterless, so little is required, but with no output schema the description could have indicated what a 'card format' record contains or whether the list is complete or paginated. It is minimally adequate rather than complete.

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. The description correctly notes no parameters are required, matching the empty schema.

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 and resource: returns the card formats configured on the system. The resource is distinct enough from siblings like get_card_access_details, but the description never explicitly contrasts itself with any alternative, so it stops short of a 5.

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 tool versus siblings such as get_card_access_details or get_access_levels. 'No parameters required' is a fact about invocation, not a usage condition, so the agent gets no routing help.

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