Skip to main content
Glama
J-MaFf

s2-netbox-mcp

by J-MaFf

get_udf_list_items

Read-only

Retrieve all items in a UDF list by its UDFLISTKEY to inspect or use custom field options in S2 NetBox access control.

Instructions

Returns the items of a single UDF list for a given UDFLISTKEY (wraps NBAPI GetUDFListItems).

Input Schema

NameRequiredDescriptionDefault
UDFLISTKEYYesRequired. The unique UDFLISTKEY of the UDF list to retrieve.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.3

TDQS

B3.2/5.0
Behavior3/5

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

The readOnlyHint=true annotation already establishes this is a safe read, so the bar is lower; the description adds the useful note that it wraps NBAPI GetUDFListItems. It does not disclose anything about the returned item structure, pagination, or error behavior for an invalid 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?

One compact sentence that leads with the action and resource, with the wrapped-API note as a parenthetical. Nothing is wasted, though the sentence is thin on the information an agent needs.

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 one-parameter read with readOnlyHint and full schema coverage, the description is adequate but not complete: it never clarifies how it relates to get_udf_lists, and with no output schema it says nothing about what an 'item' contains.

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% for the single UDFLISTKEY parameter, so the schema already carries the semantics. The description restates that the key selects a single list but adds no format or syntax detail beyond the schema, which is the expected baseline.

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+resource: returning the items of a single UDF list keyed by UDFLISTKEY, and names the upstream API it wraps. However, it never distinguishes itself from the sibling get_udf_lists, which an agent could easily confuse with this one.

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 explicit when-to-use statement, no mention of when not to use it, and no reference to the sibling get_udf_lists as the alternative for enumerating lists. Only the phrase 'for a given UDFLISTKEY' hints at the required prerequisite.

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