Skip to main content
Glama
J-MaFf

s2-netbox-mcp

by J-MaFf
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_portal_groups

Read-only

Lists portal groups configured on NetBox. Resolves group names by default, adding UNLOCKTIMESPECGROUPNAME from a single time spec fetch; set RESOLVEGROUPNAMES false to return raw keys.

Instructions

Lists portal groups configured on the NetBox system (wraps NBAPI GetPortalGroups). RESOLVEGROUPNAMES defaults to true — an inverted, opt-out default (unlike most optional booleans in this codebase): each returned group's UNLOCKTIMESPECGROUPKEY is a bare foreign key, so this resolves it into a new sibling UNLOCKTIMESPECGROUPNAME field on every group. Costs at most one full-table GetTimeSpecGroups fetch per call — not per group — built once and skipped entirely when every group on the page has an empty/absent UNLOCKTIMESPECGROUPKEY. THREATLEVELGROUPKEY is never resolved (no NBAPI read command exists for threat level groups). Set RESOLVEGROUPNAMES: false to skip the fetch and return groups exactly as GetPortalGroups provides them.

Input Schema

NameRequiredDescriptionDefault
STARTFROMKEYNoOptional. Pagination cursor to continue listing from a previous call.
RESOLVEGROUPNAMESNoOptional (default true — on by default; the inverse of this codebase's usual optional-boolean default). Resolves each group's UNLOCKTIMESPECGROUPKEY bare foreign key into a new sibling UNLOCKTIMESPECGROUPNAME field, via at most one full-table GetTimeSpecGroups fetch per call (not per group) — built once and skipped entirely when every group on the page has an empty/absent UNLOCKTIMESPECGROUPKEY, yielding '' for the name. THREATLEVELGROUPKEY is never resolved — no NBAPI read command exists for threat level groups. Set to false to skip the fetch and return groups exactly as GetPortalGroups provides them.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.0
    • addedInput schema / properties / RESOLVEGROUPNAMES
      Added value: +{
+  "description": "Optional (default true — on by default; the inverse of this codebase's usual optional-boolean default). Resolves each group's UNLOCKTIMESPECGROUPKEY bare foreign key into a new sibling UNLOCKTIMESPECGROUPNAME field, via at most one full-table GetTimeSpecGroups fetch per call (not per group) — built once and skipped entirely when every group on the page has an empty/absent UNLOCKTIMESPECGROUPKEY, yielding '' for the name. THREATLEVELGROUPKEY is never resolved — no NBAPI read command exists for threat level groups. Set to false to skip the fetch and return groups exactly as GetPortalGroups provides them.",
+  "type": "boolean"
+}
  2. First observedv0.2.3

TDQS

A3.8/5.0
Behavior5/5

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

With readOnlyHint already covering the safety profile, the description goes well beyond the annotations: it discloses the inverted opt-out default, the at-most-one-full-table GetTimeSpecGroups fetch per call (not per group), the skip path when all keys are empty, the injected sibling field, and the fact that THREATLEVELGROUPKEY is never resolved. That is unusually rich behavioral context for a read tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose is front-loaded in sentence one, but the remainder is a dense single block that largely duplicates the schema's RESOLVEGROUPNAMES text. Much of the length re-covers material already structured elsewhere rather than earning new space.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter read tool with full schema coverage and no output schema, the description is nearly complete on the resolution behavior and its cost. It omits any mention of pagination or how to continue via STARTFROMKEY, which is the one notable gap.

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 coverage is 100%, and the description's account of RESOLVEGROUPNAMES is essentially a restatement of the schema's own parameter description. It adds framing but little genuinely new parameter meaning beyond the schema, so the 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?

The first sentence gives a specific verb+resource ('Lists portal groups configured on the NetBox system') and names the underlying API call. It is distinguishable from the singular get_portal_group and from get_portals, though it never states that distinction explicitly.

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. The description explains when to flip RESOLVEGROUPNAMES to false, but gives no explicit guidance on when to choose this over siblings like get_portal_group or find_portals, nor any prerequisite conditions.

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

Deploy Server

Other Tools