Skip to main content
Glama
J-MaFf

s2-netbox-mcp

by J-MaFf
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

list_events

Read-only

Retrieve event types and definitions from a LenelS2 S2 NetBox access-control system, optionally enriching each result with its resolved partition name.

Instructions

Lists the event types/definitions known to the NetBox system (wraps NBAPI ListEvents). RESOLVEPARTITIONNAMES defaults to true — on by default, the same inverted opt-out default used by this codebase's other fixed-cost enrichments: each returned event is enriched with a PARTITIONNAME field resolved from its PARTITIONID via one GetPartitions fetch per call, not per event (GetPartitions costs the same whether it resolves one event or a thousand). Set RESOLVEPARTITIONNAMES: false to skip it.

Input Schema

NameRequiredDescriptionDefault
RESOLVEPARTITIONNAMESNoOptional (default true — on by default; an opt-out, not opt-in, default). Enriches each returned event with PARTITIONNAME resolved from its PARTITIONID via one GetPartitions fetch per call (not per event). Set to false to skip it and get the plain ListEvents response.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.3.0
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / RESOLVEPARTITIONNAMES
      Added value: +{
+  "description": "Optional (default true — on by default; an opt-out, not opt-in, default). Enriches each returned event with PARTITIONNAME resolved from its PARTITIONID via one GetPartitions fetch per call (not per event). Set to false to skip it and get the plain ListEvents response.",
+  "type": "boolean"
+}
  2. First observedv0.2.3

TDQS

A3.6/5.0
Behavior4/5

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

Beyond the readOnlyHint annotation, the description adds genuinely useful operational context: it wraps NBAPI ListEvents and the enrichment costs exactly one GetPartitions fetch per call regardless of event count. That per-call cost model is real behavioral information an agent cannot get from annotations or schema.

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 well, but the body is repetitive: 'defaults to true — on by default', 'inverted opt-out default', and 'not per event' are each restated, and the GetPartitions cost point is made twice. The content is correct but padded.

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 single-optional-parameter read-only list tool with no output schema, the description covers purpose, the enrichment default and its cost, and how to opt out. It is close to complete, missing only what the plain ListEvents response actually 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%, so the sole parameter is already fully documented, and the description's explanation of RESOLVEPARTITIONNAMES largely restates the schema text. The added 'not per event' cost framing is helpful but does not meaningfully extend semantics beyond the 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?

The first sentence names a specific verb and resource ('Lists the event types/definitions known to the NetBox system') and identifies the underlying API call (NBAPI ListEvents). It does not distinguish itself from nearby siblings like get_event_history or get_partitions, so the agent must infer which listing tool it actually wants.

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?

The description gives clear guidance on the RESOLVEPARTITIONNAMES parameter (when to set it false to skip enrichment), which is effectively usage instruction for the one option. However, it offers no tool-selection guidance — nothing says when to call list_events versus get_event_history or get_partitions.

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