Skip to main content
Glama

List Fhrp_group_assignments

netbox_list_fhrp_group_assignments
Read-onlyIdempotent

Retrieve FHRP group-to-interface assignments from NetBox with support for pagination, fuzzy text search, and filtering by group ID, tags, or creation date.

Instructions

List FHRP group to interface assignments from NetBox.

Supports pagination and filtering. Common patterns:

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

  • Lookup by id: use netbox_get_fhrp_group_assignment 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:

  • group_id:

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).
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.
group_idNo
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.
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 read-only, open-world, idempotent, and non-destructive behavior. The description adds crucial behavioral context: pagination (limit, offset, has_more, next_offset), auto-truncation of large responses to stay under character limits, and the availability of JSON output for chaining. No contradiction with annotations.

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?

The description is well-structured with clear sections and front-loaded with the main purpose. Each sentence adds value, but the incomplete 'group_id' note slightly detracts from overall conciseness. Still efficient overall.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a list tool with 8 parameters, pagination, and multiple filter types, the description covers most aspects: purpose, usage patterns, pagination mechanics, filters, and return format. The lack of description for the 'group_id' filter is a gap, but otherwise complete. No output schema exists, but return shape is explained.

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 high (88%), but the description adds value by grouping filters into resource-specific and universal categories, explaining pagination parameters, and suggesting how to combine filters (e.g., 'q' with others). However, the 'group_id' parameter description is incomplete (just 'group_id:' with no details), missing an opportunity to fully compensate for the schema gap.

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 tool lists FHRP group to interface assignments from NetBox, specifying the verb (list) and resource (FHRP group assignments). It also distinguishes from a sibling tool (netbox_get_fhrp_group_assignment) by advising its use when an ID is already 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 usage patterns are provided: discovery with no filters, lookup by ID using an alternative tool, and narrow scanning with filters. Pagination behavior with limit, offset, has_more, and next_offset is detailed, guiding the agent on how to handle large result sets.

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