Skip to main content
Glama

List Power_outlets

netbox_list_power_outlets
Read-onlyIdempotent

List power outlets from NetBox with filter and pagination support to browse or narrow down results by device, name, type, or phase leg.

Instructions

List PDU power outlets from NetBox.

Supports pagination and filtering. Common patterns:

  • Discovery: call with no filters to browse the first power_outlets.

  • Lookup by id: use netbox_get_power_outlet instead when you already have an id.

  • Narrow scan: combine 'q' (fuzzy text) with resource-specific filters below.

Pagination:

  • 'limit' (max 1000, default 50) and 'offset'. Response includes 'has_more' and 'next_offset'.

  • Large list responses auto-truncate to keep under the character limit; keep calling with next_offset to continue.

Resource-specific filters:

  • device_id: Numeric device id.

  • device: Device name.

  • name: Exact outlet name.

  • name__ic: Outlet name contains (case-insensitive).

  • type: Power outlet type slug.

  • power_port_id: Filter by parent power port id.

  • feed_leg: Phase leg: A, B, or C.

Universal filters:

  • q (string) Fuzzy text search across searchable fields.

  • tag (string[]) AND-filter by tag slugs.

  • created_after (date) ISO-8601 lower bound on 'created'.

  • created_before (date) ISO-8601 upper bound on 'created'.

Returns: Markdown summary (default) or JSON with shape: { total, count, offset, limit, items: [...], has_more, next_offset? }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNoFuzzy full-text search across the object's searchable fields (name, description, etc.).
tagNoFilter to objects that have ALL of these tag slugs. Repeat for multiple tags (AND semantics in NetBox).
nameNoExact outlet name.
typeNoPower outlet type slug.
limitNoMaximum number of items to return per page (1-1000, default 50).
deviceNoDevice name.
offsetNoNumber of items to skip for pagination. Use next_offset from a previous response.
feed_legNoPhase leg: A, B, or C.
name__icNoOutlet name contains (case-insensitive).
device_idNoNumeric device id.
created_afterNoISO-8601 date; only return objects created on or after this date (e.g. 2024-01-01).
power_port_idNoFilter by parent power port id.
created_beforeNoISO-8601 date; only return objects created on or before this date.
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, idempotentHint, openWorldHint, and non-destructive. The description adds value by detailing pagination truncation, response format options, and the shape of JSON output.

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?

The description is well-structured with clear sections for common patterns, pagination, filters, and returns. It is front-loaded with purpose and includes only necessary details.

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 list tool with 14 parameters and no output schema, the description is comprehensive: it explains pagination fully, covers all filter categories, and describes both response formats. No gaps remain.

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 baseline is 3. The description adds organizing categories (resource-specific vs universal) and usage context for pagination parameters, which provides moderate extra value.

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 verb ('List') and resource ('PDU power outlets from NetBox'). It distinguishes from sibling tools like netbox_get_power_outlet by advising alternate usage when an ID is known.

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?

Explicit when-to-use patterns are provided: no filters for discovery, use get for single id, narrow scan with filters. Pagination behavior and continuation via next_offset are explained.

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