Skip to main content
Glama

Get Console_server_port

netbox_get_console_server_port
Read-onlyIdempotent

Retrieve a single console server port from NetBox by numeric ID. Get details in markdown or JSON format.

Instructions

Get a single console_server_port from NetBox by numeric id.

Use after netbox_list_console_server_ports has located the object, or when you already have the id.

Returns: Markdown detail (default) or JSON with the full NetBox object including nested references.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesNumeric object ID in NetBox.
response_formatNoOutput format: 'markdown' (default, human-readable) or 'json' (full structured payload). Use 'json' when chaining follow-up tool calls.markdown
Behavior5/5

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, destructiveHint. Description adds return format details (Markdown or JSON with nested references), which is valuable beyond annotations. No contradiction.

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 sentences, front-loaded with action, no waste. Returns section is separate and clear.

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 simple retrieval tool with 2 parameters, annotations covering safety, and no output schema, the description covers usage, parameters, and return formats completely.

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 descriptions are adequate (id as numeric ID, response_format with enum and default). Description adds no extra meaning beyond schema, so baseline 3 is appropriate.

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?

Description clearly states 'Get a single console_server_port from NetBox by numeric id' – specific verb and resource. Distinguishes from sibling netbox_list_console_server_ports by being the singular retrieval version.

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

Usage Guidelines5/5

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

Explicitly says 'Use after netbox_list_console_server_ports has located the object, or when you already have the id.' Provides clear context for when to use this tool vs its list counterpart.

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