Skip to main content
Glama

Get Module_bay

netbox_get_module_bay
Read-onlyIdempotent

Retrieve a single module bay from NetBox by its numeric ID. Use after listing module bays or when you already have the ID.

Instructions

Get a single module_bay from NetBox by numeric id.

Use after netbox_list_module_bays 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 declare readOnlyHint=true, idempotentHint=true, openWorldHint=true, destructiveHint=false, establishing a safe, read-only behavior. The description adds that the tool returns 'Markdown detail (default) or JSON with the full NetBox object including nested references,' which is useful extra context. It does not contradict annotations and adds value, though error handling (e.g., if id not found) is not mentioned, but not critical given 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 sentences, front-loaded with purpose and usage, no wasted words. Every sentence adds value: purpose, usage guidance, return format. Highly concise and well-structured.

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' tool with rich annotations (safety, idempotency) and complete schema coverage, the description covers the return format and usage flow. No output schema exists, but the description adequately describes the return. Complete given tool complexity.

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 input schema already documents both parameters. The description adds marginal value by specifying 'numeric id' and advising when to use 'json' for chaining, but does not significantly expand beyond the schema. 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?

The description clearly states the action ('Get'), the resource ('module_bay'), and the required input ('numeric id'). It distinguishes from sibling tools like netbox_list_module_bays, netbox_create_module_bay, and netbox_update_module_bay, fulfilling the criteria for a specific verb+resource with sibling differentiation.

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 states when to use this tool: 'Use after netbox_list_module_bays has located the object, or when you already have the id.' This provides clear context and implicitly excludes other tools for different purposes.

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