Get branch

veryfront__get_branch

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
branch_idstringYesBranch ID Format: uuid.

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__get_branch",
    "arguments": {
      "branch_id": "00000000-0000-4000-8000-000000000000"
    }
  }
}

Result

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

FieldTypeRequiredDescription and constraints
idstringYesBranch ID.
namestringYesBranch name.
project_idstringYesID of the project the branch belongs to.
base_branch_idstring or nullYesID of the branch this branch was created from, or null.
created_atstring or nullYesWhen the branch was created.
created_bystring or nullYesID of the user who created the branch.
merged_atstring or nullYesWhen the branch was merged; null until merged.
merged_bystring or nullYesID of the user who merged the branch; null until merged.
versionnumberYesBranch version number.
statusstringYesBranch lifecycle status. Values: "active", "merged", "closed".
descriptionstring or nullYesBranch description.
auto_delete_on_mergebooleanYesWhether the branch is deleted after it merges.

Full schemas

json
{
  "type": "object",
  "properties": {
    "branch_id": {
      "type": "string",
      "format": "uuid",
      "description": "Branch ID"
    }
  },
  "required": [
    "branch_id"
  ],
  "additionalProperties": false,
  "description": "Arguments for the get_branch tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Branch ID."
    },
    "name": {
      "type": "string",
      "description": "Branch name."
    },
    "project_id": {
      "type": "string",
      "description": "ID of the project the branch belongs to."
    },
    "base_branch_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "ID of the branch this branch was created from, or null."
    },
    "created_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the branch was created."
    },
    "created_by": {
      "type": [
        "string",
        "null"
      ],
      "description": "ID of the user who created the branch."
    },
    "merged_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the branch was merged; null until merged."
    },
    "merged_by": {
      "type": [
        "string",
        "null"
      ],
      "description": "ID of the user who merged the branch; null until merged."
    },
    "version": {
      "type": "number",
      "description": "Branch version number."
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "merged",
        "closed"
      ],
      "description": "Branch lifecycle status."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Branch description."
    },
    "auto_delete_on_merge": {
      "type": "boolean",
      "description": "Whether the branch is deleted after it merges."
    }
  },
  "required": [
    "id",
    "name",
    "project_id",
    "base_branch_id",
    "created_at",
    "created_by",
    "merged_at",
    "merged_by",
    "version",
    "status",
    "description",
    "auto_delete_on_merge"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_branch tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}