Skip to main content
Glama

List Vlan_translation_policies

netbox_list_vlan_translation_policies
Read-onlyIdempotent

List and filter VLAN translation policies from NetBox. Supports pagination, text search, and filtering by name, tags, or creation date.

Instructions

List VLAN translation policies from NetBox.

Supports pagination and filtering. Common patterns:

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

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

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.
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 readOnlyHint, idempotentHint, and no destructive hint. The description adds auto-truncation of large lists and pagination mechanics (has_more, next_offset), which provides valuable behavioral context beyond annotations.

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-organized with sections for general usage, pagination, filters, and returns. Every sentence is informative and there is no redundancy. It is appropriately front-loaded with the primary purpose.

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?

Given 8 parameters and no output schema, the description covers pagination behavior, filter semantics, and return format. It explains auto-truncation and pagination tokens. However, it omits a description for the 'name' parameter and does not explain what a VLAN translation policy is, which could be inferred from context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is high (88%), so the description's value is reduced. It provides usage patterns for 'q' and tag, but the 'name' parameter is listed without explanation in both the schema and description, missing an opportunity to add clarity.

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 'List VLAN translation policies from NetBox' and explicitly distinguishes from sibling tools by advising 'use netbox_get_vlan_translation_policy instead when you already have an id.' This provides a specific verb+resource and differentiation.

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?

The description outlines common patterns: discovery (no filters), lookup by ID (alternate tool), and narrow scan (with filters). It includes pagination instructions and when to use JSON format for chaining, giving explicit when-to-use and when-not-to-use guidance.

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