List deployments

veryfront__list_deployments

Requires project.deployments.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
environment_idstringNoProvide the environment id. Format: uuid.
cursorstringNoOpaque pagination cursor returned by a previous response.
limitintegerNoMaximum number of entries to return. Defaults to 20 and is capped at 100. Default: 20. Minimum: 1. Maximum: 100.
sort_bystringNoProvide the sort by. Default: "created_at". Values: "created_at".
sort_orderstringNoProvide the sort order. Default: "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_deployments",
    "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"
    },
    "environment_id": {
      "type": "string",
      "format": "uuid",
      "description": "Provide the environment id."
    },
    "cursor": {
      "type": "string",
      "description": "Opaque pagination cursor returned by a previous response."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Maximum number of entries to return. Defaults to 20 and is capped at 100.",
      "default": 20
    },
    "sort_by": {
      "type": "string",
      "enum": [
        "created_at"
      ],
      "description": "Provide the sort by.",
      "default": "created_at"
    },
    "sort_order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ],
      "description": "Provide the sort order.",
      "default": "desc"
    }
  },
  "additionalProperties": false,
  "description": "Arguments for the list_deployments 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."
          },
          "release_id": {
            "type": "string",
            "format": "uuid",
            "description": "Release identifier associated with this result."
          },
          "environment_id": {
            "type": "string",
            "format": "uuid"
          },
          "user_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null",
                "description": "The user id returned by the tool."
              }
            ]
          },
          "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",
          "release_id",
          "environment_id"
        ],
        "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_deployments tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}