List environments

veryfront__list_environments

Requires project.read.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Read-only.

Arguments

FieldTypeRequiredDescription and constraints
project_referencestringNoProject ID or slug
cursorstringNoCursor for pagination: an environment ID from this project. An unknown cursor is rejected.
limitintegerNoPage size, 1 to 100. Defaults to 20. Default: 20. Minimum: 1. Maximum: 100.
sort_bystringNoSort field: "name" or "updated_at". Values: "name", "updated_at".
sort_orderstringNoSort order: "asc" or "desc". Values: "asc", "desc".

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__list_environments",
    "arguments": {}
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
dataobject[]YesPrimary result records returned by the tool.
page_infoobjectYesPagination cursor values for traversing the result set.

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "cursor": {
      "type": "string",
      "description": "Cursor for pagination: an environment ID from this project. An unknown cursor is rejected."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Page size, 1 to 100. Defaults to 20.",
      "default": 20
    },
    "sort_by": {
      "type": "string",
      "enum": [
        "name",
        "updated_at"
      ],
      "description": "Sort field: \"name\" or \"updated_at\"."
    },
    "sort_order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ],
      "description": "Sort order: \"asc\" or \"desc\"."
    }
  },
  "additionalProperties": false,
  "description": "Arguments for the list_environments tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Unique identifier for the returned record."
          },
          "name": {
            "type": "string",
            "description": "Human-readable name for the returned record."
          },
          "project_id": {
            "$ref": "#/properties/data/items/properties/id",
            "description": "Project identifier associated with this result."
          },
          "protected": {
            "type": "boolean"
          },
          "domains": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Custom domains attached to the environment."
          }
        },
        "required": [
          "id",
          "name",
          "project_id",
          "protected",
          "domains"
        ],
        "additionalProperties": false
      },
      "description": "Primary result records returned by the tool."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor that refers to the current page."
        },
        "first": {
          "type": "null"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the next page when pagination is available."
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the previous page when pagination is available."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Pagination cursor values for traversing the result set."
    }
  },
  "required": [
    "data",
    "page_info"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the list_environments tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}