Skip to main content
List all dedicated servers across all environments in a project

Tool details

FieldValue
Namelist_servers
GroupServers

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "limit": {
      "type": "number",
      "minimum": 1,
      "maximum": 100,
      "description": "Number of results per page (default: 20, max: 100)",
      "default": 20
    },
    "cursor": {
      "type": "string",
      "description": "Pagination cursor (server ID) from previous response"
    }
  },
  "required": [
    "project_reference"
  ],
  "additionalProperties": false,
  "description": "Input schema for the list_servers tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "servers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the returned record."
          },
          "short_id": {
            "type": "string",
            "description": "The short id associated with this tool result."
          },
          "user_id": {
            "type": "string",
            "description": "The user id associated with this tool result."
          },
          "environment_ids": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "One environment id item associated with this tool result."
            },
            "description": "List of environment ids associated with this tool result."
          },
          "hostname": {
            "type": "string",
            "description": "The hostname associated with this tool result."
          },
          "status": {
            "type": "string",
            "description": "Lifecycle status for the returned record."
          },
          "created_at": {
            "type": "string",
            "description": "Creation timestamp in ISO 8601 format."
          },
          "updated_at": {
            "type": "string",
            "description": "Last update timestamp in ISO 8601 format."
          }
        },
        "required": [
          "id",
          "short_id",
          "user_id",
          "environment_ids",
          "hostname",
          "status",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false,
        "description": "One server item associated with this tool result."
      },
      "description": "List of servers associated with this tool result."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "has_next_page": {
          "type": "boolean",
          "description": "The has next page associated with this tool result."
        },
        "next_cursor": {
          "type": [
            "string",
            "null"
          ],
          "description": "The next cursor associated with this tool result."
        }
      },
      "required": [
        "has_next_page",
        "next_cursor"
      ],
      "additionalProperties": false,
      "description": "Pagination cursor values for traversing the result set."
    }
  },
  "required": [
    "servers",
    "page_info"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the list_servers tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}