Create branch

veryfront__create_branch

Requires project.files.write.

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
namestringYesBranch name (e.g., "feature-new-header"). Branch name may only contain letters, numbers, ".", "_", "/" and "-", and cannot start with "-". Minimum length: 1. Maximum length: 255.
base_branch_idstring or nullNoOmit to branch from the project root (created automatically if missing). Use null to create a root branch; rejected if a root already exists. A UUID must identify a base branch in this project.
descriptionstringNoBranch description.
auto_delete_on_mergebooleanNoDelete the branch after it merges (default: false).
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",
    "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.
namestringYesHuman-readable name for the returned record.
project_idstringYesProject identifier associated with this result.

Full schemas

json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[A-Za-z0-9._/][A-Za-z0-9._/-]*$",
      "description": "Branch name (e.g., \"feature-new-header\"). Branch name may only contain letters, numbers, \".\", \"_\", \"/\" and \"-\", and cannot start with \"-\"."
    },
    "base_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the base branch id."
        },
        {
          "type": "null",
          "description": "Provide the base branch id."
        }
      ],
      "description": "Omit to branch from the project root (created automatically if missing). Use null to create a root branch; rejected if a root already exists. A UUID must identify a base branch in this project."
    },
    "description": {
      "type": "string",
      "description": "Branch description."
    },
    "auto_delete_on_merge": {
      "type": "boolean",
      "description": "Delete the branch after it merges (default: false)."
    },
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "description": "Arguments for the create_branch tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the returned record."
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for the returned record."
    },
    "project_id": {
      "type": "string",
      "description": "Project identifier associated with this result."
    }
  },
  "required": [
    "id",
    "name",
    "project_id"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the create_branch tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}