Skip to main content
Glama

retrieve_instances_list

Read-onlyIdempotent

List and filter all Contabo compute instances by name, status, region, IP, or other fields to find and manage instances in your account.

Instructions

List instances [GET /v1/compute/instances] List and filter all instances in your account

Input Schema

NameRequiredDescriptionDefault
nameNoThe name of the instance
pageNoNumber of page to be fetched.
sizeNoNumber of elements per page.
regionNoThe Region of the instance
searchNoFull text search when listing the instances. Can be searched by `name`, `displayName`, `ipAddress`
statusNoThe status of the instance
orderByNoSpecify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC|DESC`.
addOnIdsNoIdentifiers of Addons the instances have
ipConfigNoFilter instances that have an ip config
tenantIdNoFilter by tenant ID
suspendedNoFilter instances by suspension state. When set to false, suspended instances are excluded from the response. Any other value returns all instances (default behavior).
customerIdNoFilter by customer ID
dataCenterNoThe data center of the instance
instanceIdNoThe identifier of the instance (deprecated)
productIdsNoIdentifiers of the instance products
x-trace-idNoIdentifier to trace group of requests.
displayNameNoThe display name of the instance
instanceIdsNoComma separated instances identifiers
productTypesNoComma separated instance's category depending on Product Id

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=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is fully covered structurally. The description adds only the account-scoping note and says nothing about pagination behavior or default result volume, which for a 19-filter listing endpoint is the missing behavioral context.

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?

Two short lines, front-loaded with the operation and the route. There is mild redundancy between 'List instances' and 'List and filter all instances', but no wasted exposition.

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 19 optional parameters, no output schema, and no pagination or default-ordering guidance, the description leaves the agent to discover behavior from the schema alone. Annotations cover safety, but the result-shape and paging story is thin for an endpoint of this complexity.

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%, with page, size, search syntax, orderBy format and the situationally tricky 'suspended' flag all documented in the schema. The description's 'filter' wording adds nothing new, so baseline 3 applies.

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?

States a specific verb and resource ('List instances') plus the scope restriction 'in your account', and the HTTP route disambiguates it from the mutating siblings. It does not explicitly name the singular 'retrieve_instance' sibling, but the list-vs-single distinction is clear from the wording.

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?

'List and filter all instances in your account' implies the use case (bulk enumeration with filters), but there is no explicit when-to-use, when-not, or pointer to alternatives such as retrieve_instance for a single lookup. Usage must be inferred.

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