Skip to main content
Glama
NetBox MCP Server

NetBox MCP Server

by mhajder

Netbox Connect Cable

netbox_connect_cable

Connect two network ports with a new cable by specifying device and port names or IDs; it validates ports before writing and blocks missing, ambiguous, or already-cabled endpoints.

Instructions

Connect ports with a new cable.

Ports can be given by device and name - no ID lookups needed. Fails before writing if a port is not found, is ambiguous or is already cabled. Use netbox_trace_cable afterwards to check the path.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "a_terminations": "<a_terminations>",
      "b_terminations": "<b_terminations>"
    },
    "name": "netbox_connect_cable"
  }
}

Input Schema

NameRequiredDescriptionDefault
cableNoCable attributes, e.g. {'type': 'cat6', 'status': 'connected', 'label': 'C-101', 'color': 'ff0000', 'length': 3, 'length_unit': 'm'}.
a_terminationsYesPorts on this end, usually one, e.g. [{'object_type': 'dcim.interface', 'device': 'sw01', 'name': 'eth1'}] or [{'object_type': 'dcim.frontport', 'object_id': 42}].
b_terminationsYesPorts on this end, usually one, e.g. [{'object_type': 'dcim.interface', 'device': 'sw01', 'name': 'eth1'}] or [{'object_type': 'dcim.frontport', 'object_id': 42}].

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.3.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare write, non-idempotent, non-destructive, open-world behavior; the description adds meaningful detail beyond that by stating the tool validates before writing and fails atomically when a port is missing, ambiguous, or already cabled — which also explains the practical non-idempotency. It does not cover permissions or whether an existing cable can be replaced.

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

Conciseness5/5

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

Three short sentences, front-loaded with the action, then the addressing shortcut, then the failure condition, then the follow-up. No filler or repetition of schema content.

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?

With a full output schema and 100% parameter coverage, the description only needs to carry behavior; it does that well via preconditions and post-call verification. Minor gaps remain on permissions and how multi-termination (up to 8 ports) ends are handled, but nothing essential to calling it correctly 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%, so the baseline is 3, but the description adds workflow-relevant meaning: terminations can be specified by device+name so no prior ID lookup is required, which tells the agent it can skip a search step. It adds no semantics for the optional 'cable' attributes object beyond what the schema shows.

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?

States a specific verb and resource ('Connect ports with a new cable') and immediately clarifies the distinguishing capability: ports are addressed by device and name rather than requiring ID lookups, which separates it from generic netbox_create_object cable creation.

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?

Gives explicit follow-up guidance ('Use netbox_trace_cable afterwards to check the path') and states preconditions under which the call aborts. It does not explicitly contrast with netbox_create_object or netbox_bulk_create_objects for cable creation, so the alternative routing is only implied.

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