Create branch policy

veryfront__create_branch_policy

Requires project.settings.manage.

Access

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

Call type: Can change resources.

Arguments

FieldTypeRequiredDescription and constraints
namestringYesPolicy name
is_enabledbooleanNoEnable the policy (default: true).
required_approvalsintegerNoRequired approvals (default: 1). REST/GraphQL default to 0. Minimum: 0.
allow_self_approvalbooleanNoAllow the merger’s approval to count (default: false). REST/GraphQL default to true.
target_branch_patternstring or nullNoPattern to match branches (e.g., "main", "release/*"). Omit or send null to match every branch.
required_reviewer_idsstring[]NoUser IDs who must approve before a matching branch can merge.
project_referencestringNoProject ID or slug

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__create_branch_policy",
    "arguments": {
      "name": "example"
    }
  }
}

Result

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

FieldTypeRequiredDescription and constraints
idstringYesUnique identifier for the returned record. Format: uuid.
project_idstringYesProject identifier associated with this result.
namestringYesHuman-readable name for the returned record.
is_enabledbooleanYes
target_branch_patternstring or nullYes
required_approvalsnumberYes
allow_self_approvalbooleanYes
required_reviewer_idsstring[] or nullYesReviewer UUIDs required for merge. Null and omission impose no specific reviewers; an empty list is accepted.
created_atstringYesCreation timestamp in ISO 8601 format.
updated_atstringYesLast update timestamp in ISO 8601 format.

Full schemas

json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Policy name"
    },
    "is_enabled": {
      "type": "boolean",
      "description": "Enable the policy (default: true)."
    },
    "required_approvals": {
      "type": "integer",
      "minimum": 0,
      "description": "Required approvals (default: 1). REST/GraphQL default to 0."
    },
    "allow_self_approval": {
      "type": "boolean",
      "description": "Allow the merger’s approval to count (default: false). REST/GraphQL default to true."
    },
    "target_branch_pattern": {
      "type": [
        "string",
        "null"
      ],
      "description": "Pattern to match branches (e.g., \"main\", \"release/*\"). Omit or send null to match every branch."
    },
    "required_reviewer_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "description": "One required reviewer id item supplied to the tool."
      },
      "description": "User IDs who must approve before a matching branch can merge."
    },
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "description": "Arguments for the create_branch_policy tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier for the returned record."
    },
    "project_id": {
      "$ref": "#/properties/id",
      "description": "Project identifier associated with this result."
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for the returned record."
    },
    "is_enabled": {
      "type": "boolean"
    },
    "target_branch_pattern": {
      "type": [
        "string",
        "null"
      ]
    },
    "required_approvals": {
      "type": "number"
    },
    "allow_self_approval": {
      "type": "boolean"
    },
    "required_reviewer_ids": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of required reviewer ids associated with this tool result."
        },
        {
          "type": "null",
          "description": "The required reviewer ids returned by the tool."
        }
      ],
      "description": "Reviewer UUIDs required for merge. Null and omission impose no specific reviewers; an empty list is accepted."
    },
    "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",
    "project_id",
    "name",
    "is_enabled",
    "target_branch_pattern",
    "required_approvals",
    "allow_self_approval",
    "required_reviewer_ids",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the create_branch_policy tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}