Skip to main content
Glama

retrieve_private_network_list

Read-onlyIdempotent

List and filter all private networks in your account by name, region, data center, or instance IDs to manage network configurations.

Instructions

List Private Networks [GET /v1/private-networks] List and filter all Private Networks in your account

Input Schema

NameRequiredDescriptionDefault
nameNoThe name of the Private Network
pageNoNumber of page to be fetched.
sizeNoNumber of elements per page.
regionNoThe slug of the region where your Private Network is located
orderByNoSpecify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC|DESC`.
dataCenterNoThe data center where your Private Network is located
x-trace-idNoIdentifier to trace group of requests.
instanceIdsNoComma separated instances identifiers

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false. The description adds that this is a GET endpoint and that it lists account-wide Private Networks, but it does not explain pagination, ordering behavior, or response shape. 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 short and front-loads the purpose, with the GET endpoint in brackets. There is slight redundancy between 'List Private Networks' and 'List and filter all Private Networks,' but no significant waste.

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?

For an eight-parameter list tool with no output schema, rich annotations, and full schema coverage, the description is adequate but leaves gaps around pagination and ordering behavior. It does not need to explain return values, but it could do more to clarify how filtering and listing behave.

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 100%, so all eight parameters are already documented in the schema. The description references filtering generally but adds no parameter-specific semantics such as how name, region, dataCenter, or orderBy interact. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb and resource: list and filter Private Networks. The word 'all' helps distinguish it from the singular retrieve_private_network sibling, though no sibling is named explicitly.

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

Usage Guidelines3/5

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

It implies this is the tool for browsing and filtering all Private Networks in the account, but it does not say when to use it instead of retrieve_private_network or other list tools, nor does it state any exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools