Skip to main content
Glama
J-MaFf

s2-netbox-mcp

by J-MaFf
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_portal_group

Retrieve details of a single portal group by its key, optionally resolving unlock time spec group names for easier interpretation.

Instructions

Returns the details of a single portal group for a given PORTALGROUPKEY (wraps NBAPI GetPortalGroup). RESOLVEGROUPNAMES defaults to true — an inverted, opt-out default (unlike most optional booleans in this codebase): the raw response carries only a bare UNLOCKTIMESPECGROUPKEY foreign key, so this resolves it into a new sibling UNLOCKTIMESPECGROUPNAME field via one full-table GetTimeSpecGroups fetch per call — a fixed cost regardless of anything else, since a single portal group carries exactly one UNLOCKTIMESPECGROUPKEY. THREATLEVELGROUPKEY is never resolved (no NBAPI read command exists for threat level groups). Set RESOLVEGROUPNAMES: false to skip the fetch and return the response exactly as GetPortalGroup provides it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
PORTALGROUPKEYYesRequired. The unique PORTALGROUPKEY of the portal group to retrieve.
RESOLVEGROUPNAMESNoOptional (default true — on by default; the inverse of this codebase's usual optional-boolean default). Resolves UNLOCKTIMESPECGROUPKEY into a new UNLOCKTIMESPECGROUPNAME sibling field via one full-table GetTimeSpecGroups fetch per call (skipped when UNLOCKTIMESPECGROUPKEY is empty/absent, 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 the response exactly as GetPortalGroup provides it.

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 UNLOCKTIMESPECGROUPKEY into a new UNLOCKTIMESPECGROUPNAME sibling field via one full-table GetTimeSpecGroups fetch per call (skipped when UNLOCKTIMESPECGROUPKEY is empty/absent, 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 the response exactly as GetPortalGroup provides it.",
+  "type": "boolean"
+}
  2. First observedv0.2.3

TDQS

A4.6/5.0
Behavior5/5

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

With no annotations, the description carries the full behavioral burden and discharges it exceptionally: it discloses the inverted opt-out default, the per-call full-table GetTimeSpecGroups fetch cost and why it is fixed, the empty-key behavior (yielding ''), that THREATLEVELGROUPKEY is never resolved and why, and the exact effect of setting RESOLVEGROUPNAMES to false. This is model-level transparency about side effects and costs.

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?

The description is dense and longer than typical, but every clause carries information: the inverted default is surprising, the cost implication is decision-relevant, and the threat-level caveat prevents a natural false assumption. Purpose is front-loaded. It could be lightly trimmed, but there is no fluff or redundancy.

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

Completeness5/5

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

For a 2-parameter, single-record getter with no output schema and no annotations, the description covers everything an agent needs: what is returned, the resolved vs raw response shapes, the cost condition, the non-resolvable field, and the escape hatch. Nothing needed for correct invocation is missing.

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?

Schema coverage is 100% and the schema's own parameter descriptions are unusually rich, so the baseline is 3. The description adds genuinely new meaning beyond the schema: the 'inverted, opt-out default unlike most optional booleans in this codebase' framing and the 'fixed cost regardless of anything else' rationale. These explain why the default matters in practice rather than restating the mechanic.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb-resource pair — 'Returns the details of a single portal group for a given PORTALGROUPKEY' — and the word 'single' cleanly distinguishes it from the plural sibling get_portal_groups. The NBAPI GetPortalGroup wrapper reference adds grounding. An agent can tell exactly what this does without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies when to use it (retrieve one portal group by key, versus the plural sibling) and gives explicit parameter-level guidance: set RESOLVEGROUPNAMES to false when you want the raw GetPortalGroup response and want to skip the full-table fetch. It does not name alternative siblings or state explicit when-not-to-use conditions, but the context is clear enough that exclusions are inferable.

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