Skip to main content
Glama

List Power_outlet_templates

netbox_list_power_outlet_templates
Read-onlyIdempotent

List power outlet templates from NetBox, filtered by device type, name, or other criteria. Supports pagination and fuzzy search for browsing or targeted queries.

Instructions

List power outlets defined on a device type (inherited by its devices) from NetBox.

Supports pagination and filtering. Common patterns:

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

  • Lookup by id: use netbox_get_power_outlet_template 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_type_id: Filter by device type id.

  • name: Exact template name.

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

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 template name.
limitNoMaximum number of items to return per page (1-1000, default 50).
offsetNoNumber of items to skip for pagination. Use next_offset from a previous response.
name__icNoTemplate name contains (case-insensitive).
created_afterNoISO-8601 date; only return objects created on or after this date (e.g. 2024-01-01).
created_beforeNoISO-8601 date; only return objects created on or before this date.
device_type_idNoFilter by device type id.
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?

Description adds pagination details (limit max 1000, default 50, has_more, next_offset), auto-truncation, output format options, and filter grouping. Annotations already indicate read-only, idempotent, non-destructive; description complements without contradiction.

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?

Well-structured with sections for common patterns, pagination, filters, and returns. Some redundancy with schema, but each part is relevant. Could be slightly shorter, but still effective.

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?

Despite no output schema, description explains return shape (Markdown or JSON with fields like total, count, has_more). Covers pagination behavior and filter usage thoroughly for a list tool with 10 parameters.

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%, but description adds value by grouping filters (universal vs resource-specific), explaining response_format usage, and providing pagination parameter details. The description organizes and contextualizes beyond schema descriptions.

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 it lists power outlet templates defined on a device type, inherited by devices. It distinguishes from sibling tools like netbox_get_power_outlet_template by specifying 'Lookup by id' alternative.

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 patterns: discovery with no filters, lookup by id should use get tool, narrow scan with filters. Alternative named: netbox_get_power_outlet_template.

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