Skip to main content
Glama

List Contact_roles

netbox_list_contact_roles
Read-onlyIdempotent

List NetBox contact roles with pagination and filters for name, slug, tags, and creation date. Use fuzzy search to find roles quickly.

Instructions

List contact roles from NetBox.

Supports pagination and filtering. Common patterns:

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

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

  • name:

  • slug:

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).
nameNo
slugNo
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.
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
Behavior4/5

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

Annotations already cover readOnlyHint, openWorldHint, idempotentHint, destructiveHint. Description adds useful behavioral details: pagination behavior (limit cap, auto-truncation, next_offset), response format options (markdown or JSON), and the fact that large lists auto-truncate. This goes beyond the annotations without contradicting them.

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?

Well-organized into sections with bullet points. Every sentence adds value: purpose, patterns, pagination details, filter groups, return format. No fluff. Front-loaded with the core action and key differentiator.

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?

Given no output schema, description explains response shape (total, count, offset, limit, items, has_more, next_offset) and format options. Covers all common usage patterns and filter combinations. For a simple list tool with many filters, this is complete and actionable.

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 78% (7 of 9 params have descriptions). Description groups filters into 'resource-specific' and 'universal', and explains the role of 'q' vs 'name'/'slug'. It also explains pagination parameters (limit/offset) in context. This adds value beyond the schema's parameter descriptions, especially for the two undocumented params (name, slug) which are implied.

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?

Description starts with 'List contact roles from NetBox' and distinguishes from sibling netbox_get_contact_role by saying 'use netbox_get_contact_role instead when you already have an id.' It also outlines patterns (discovery, lookup, narrow scan) that clarify the tool's role relative to other listing and CRUD tools.

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 vs netbox_get_contact_role ('use...instead when you already have an id'). Provides clear patterns for discovery, narrow scan, and pagination advice. This helps an agent decide between this and other netbox_list_* tools in the sibling list.

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