Skip to main content
Glama

Get Circuit

netbox_get_circuit
Read-onlyIdempotent

Retrieve a single circuit from NetBox by its numeric ID. Returns details in Markdown or full JSON format.

Instructions

Get a single circuit from NetBox by numeric id.

Use after netbox_list_circuits 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
Behavior4/5

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

Annotations already provide read-only, idempotent, non-destructive hints. The description adds value by detailing the return format ('Markdown detail or JSON with full object including nested references') and that it returns a single circuit, which is not covered by annotations.

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 precise sentences: purpose, usage context, and return format. No superfluous words, well-structured, and front-loaded with key information.

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 get-by-id tool with no output schema, the description covers purpose, usage, parameter guidance, and return format. It is complete given the annotations and schema richness.

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%, baseline 3. The description adds semantic value by explaining the response_format parameter in context ('Use json when chaining follow-up tool calls'), which goes beyond the schema's enum description.

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 clearly states the action 'Get a single circuit from NetBox by numeric id' and distinguishes from sibling tools like netbox_list_circuits and netbox_create_circuit. It also explains the use case context.

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 advises 'Use after netbox_list_circuits has located the object, or when you already have the id.' This provides clear when-to-use and implies when-not-to-use. Additionally, guidance on response_format is given for follow-up tool calls.

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