Skip to main content
Glama

List Services

netbox_list_services
Read-onlyIdempotent

List L4 services on devices and VMs from NetBox with pagination and filters for name, protocol, and date range.

Instructions

List L4 services on devices/VMs from NetBox.

Supports pagination and filtering. Common patterns:

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

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

  • protocol:

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
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.
protocolNo
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 declare read-only, idempotent, non-destructive. The description adds useful behavioral context: pagination auto-truncation and the need to continue with next_offset. No contradictions 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 sections (purpose, patterns, pagination, filters, returns). It is fairly concise given the complexity, but some lines could be slightly trimmed without loss.

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

Completeness3/5

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

With no output schema, the description explains the response shape (JSON fields) and pagination mechanics. However, it does not specify what fields are in each service item, which may require the agent to rely on external knowledge.

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%, and the description adds value by grouping filters (resource-specific vs universal) and explaining the response_format parameter (use json for chaining). However, name and protocol lack description in schema and are only listed without further details.

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 L4 services on devices/VMs from NetBox. It distinguishes from netbox_get_service by advising to use that tool when an ID is known. The verb 'List' is specific to the resource.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Common patterns cover discovery, lookup by id (with alternative tool), and narrow scan, providing guidance on when to use this tool. However, it does not explicitly mention when not to use it or compare to other listing tools beyond get_service.

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