Skip to main content
Glama

Create Console_server_port

netbox_create_console_server_port

Add a console server port to a NetBox device by specifying device ID and port name; optional fields include type, speed, and tags.

Instructions

Create a new console_server_port in NetBox.

This adds a new row to NetBox. Ask before calling if the user wanted a dry-run.

Returns: Markdown summary of the newly created object (default) or JSON with the full NetBox response.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesPort name (required).
tagsNoOptional array of tag slugs to apply to the object.
typeNoConsole port type slug, e.g. 'rj-45', 'usb-a', 'usb-c', 'de-9', 'db-25'.
labelNo
speedNoSpeed in bps.
device_idYesDevice id (required). Exposed as device_id (not device) for the remote-devices bridge; mapped to the API field device on write.
descriptionNo
custom_fieldsNoOptional object of custom-field slugs -> values. Only include fields defined on your NetBox instance.
mark_connectedNo
response_formatNoOutput format: 'markdown' (default, human-readable) or 'json' (full structured payload). Use 'json' when chaining follow-up tool calls.markdown
Behavior3/5

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

Annotations already indicate this is a non-read-only, non-idempotent, non-destructive operation. The description adds that it adds a new row and specifies the return format (Markdown or JSON). It does not disclose potential side effects, error conditions, or required permissions beyond what annotations provide.

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 concise with three sentences, each serving a distinct purpose: stating the action, issuing a precaution, and describing the output format. It is efficient but could be better structured with explicit sections.

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 tool with 10 parameters and no output schema, the description provides the essential action and output format but lacks explanation of the resource context (e.g., what 'device_id' refers to) and how to decide among sibling create tools. The dry-run instruction adds some safety context.

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 70%, so most parameters already have descriptions. The description does not add any parameter-specific details, only mentioning the return format. It does not compensate for the 30% undocumented parameters (e.g., description, label, speed).

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 description clearly states 'Create a new console_server_port in NetBox', specifying the verb and resource. The name and resource type distinguish it from sibling tools like netbox_create_console_port, but no additional context is provided about what a console_server_port is.

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?

The description advises asking the user for a dry-run confirmation but provides no guidance on when to use this tool versus alternatives like netbox_update_console_server_port or when to prefer netbox_list_console_server_ports. No selection criteria are mentioned.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ZenixSolutions/netbox-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server