List branch policies

veryfront__list_branch_policies

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
enabled_onlybooleanNoOnly return enabled policies
limitintegerNoPage size 1-100. Omit limit and cursor for the complete collection; cursor alone defaults to 20. Minimum: 1. Maximum: 100.
cursorstringNoOpaque continuation bound to collection, project, branch, principal, filters and page size. Minimum length: 1. Maximum length: 4096.

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_branch_policies",
    "arguments": {}
  }
}

Result

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

FieldTypeRequiredDescription and constraints
policiesobject[]YesPaged results use ID ascending order; omit limit and cursor for the complete collection.
page_infoobjectNoPagination cursor values for traversing the result set.

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "enabled_only": {
      "type": "boolean",
      "description": "Only return enabled policies"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Page size 1-100. Omit limit and cursor for the complete collection; cursor alone defaults to 20."
    },
    "cursor": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Opaque continuation bound to collection, project, branch, principal, filters and page size."
    }
  },
  "additionalProperties": false,
  "description": "Arguments for the list_branch_policies tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "policies": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the record."
          },
          "name": {
            "type": "string",
            "description": "Human-readable name for the record."
          },
          "is_enabled": {
            "type": "boolean",
            "description": "The is enabled associated with this record."
          },
          "required_approvals": {
            "type": "number",
            "description": "The required approvals associated with this record."
          },
          "allow_self_approval": {
            "type": "boolean",
            "description": "The allow self approval associated with this record."
          },
          "target_branch_pattern": {
            "type": [
              "string",
              "null"
            ],
            "description": "The target branch pattern associated with this record."
          }
        },
        "required": [
          "id",
          "name",
          "is_enabled",
          "required_approvals",
          "allow_self_approval",
          "target_branch_pattern"
        ],
        "additionalProperties": false,
        "description": "One policy item associated with this record."
      },
      "description": "Paged results use ID ascending order; omit limit and cursor for the complete collection."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor used for this page."
        },
        "first": {
          "type": "null",
          "description": "Omit cursor to request the first page."
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Next page cursor, or null on the last page."
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "Previous page cursor, or null on the first page."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Pagination cursor values for traversing the result set."
    }
  },
  "required": [
    "policies"
  ],
  "additionalProperties": false,
  "description": "Structured list policies output schema for MCP tools.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}