Preview branch merge

veryfront__preview_branch_merge

Shows entities that will be modified, added, deleted, and any that have conflicts requiring auto-merge. can_merge combines the merge eligibility policies (same check as check_merge_eligibility) with the conflict scan; the preview is advisory and merge_branch rechecks both at merge time.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources. Call type: Read-only.

Arguments

Field	Type	Required	Description and constraints
`branch_id`	`string`	Yes	Branch ID to merge Format: `uuid`.
`target_branch_id`	`string or null`	No	Target branch ID (null for main branch)

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.

request.json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__preview_branch_merge",
    "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.

Field	Type	Required	Description and constraints
`can_merge`	`boolean`	Yes	Returns true only when `blocked_reason` is null, merge eligibility policies pass, and no entity has conflicts. This preview is advisory; `merge_branch` checks these conditions again at merge time.
`has_conflicts`	`boolean`	Yes	Returns true when at least one entity has conflicts that block an automatic merge.
`blocked_reason`	`string or null`	Yes	Identifies a blocking precondition such as an already merged or closed branch, an invalid target, or a closed target. Returns null when no precondition blocks the merge.
`summary`	`object`	Yes	Structured summary details associated with this record.
`entities`	`object[]`	Yes	List of entities associated with this record.

Full schemas

{
  "type": "object",
  "properties": {
    "branch_id": {
      "type": "string",
      "format": "uuid",
      "description": "Branch ID to merge"
    },
    "target_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target branch id."
        },
        {
          "type": "null",
          "description": "Provide the target branch id."
        }
      ],
      "description": "Target branch ID (null for main branch)"
    }
  },
  "required": [
    "branch_id"
  ],
  "additionalProperties": false,
  "description": "Arguments for the preview_branch_merge tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "can_merge": {
      "type": "boolean",
      "description": "Returns true only when blocked_reason is null, merge eligibility policies pass, and no entity has conflicts. This preview is advisory; merge_branch checks these conditions again at merge time."
    },
    "has_conflicts": {
      "type": "boolean",
      "description": "Returns true when at least one entity has conflicts that block an automatic merge."
    },
    "blocked_reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "Identifies a blocking precondition such as an already merged or closed branch, an invalid target, or a closed target. Returns null when no precondition blocks the merge."
    },
    "summary": {
      "type": "object",
      "properties": {
        "modified": {
          "type": "number",
          "description": "The modified associated with this record."
        },
        "added": {
          "type": "number",
          "description": "The added associated with this record."
        },
        "deleted": {
          "type": "number",
          "description": "The deleted associated with this record."
        },
        "conflicts": {
          "type": "number",
          "description": "The conflicts associated with this record."
        }
      },
      "required": [
        "modified",
        "added",
        "deleted",
        "conflicts"
      ],
      "additionalProperties": false,
      "description": "Structured summary details associated with this record."
    },
    "entities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "entity_id": {
            "type": "string",
            "description": "The entity id associated with this record."
          },
          "entity_type": {
            "type": "string",
            "description": "The entity type associated with this record."
          },
          "status": {
            "type": "string",
            "enum": [
              "modified",
              "added",
              "deleted",
              "conflict"
            ],
            "description": "Lifecycle status for the record."
          }
        },
        "required": [
          "entity_id",
          "entity_type",
          "status"
        ],
        "additionalProperties": false,
        "description": "One entity item associated with this record."
      },
      "description": "List of entities associated with this record."
    }
  },
  "required": [
    "can_merge",
    "has_conflicts",
    "blocked_reason",
    "summary",
    "entities"
  ],
  "additionalProperties": false,
  "description": "Structured merge preview output schema for MCP tools.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Get started

APIs

REST API

GraphQL API

MCP API

Preview branch merge

Access

Arguments

Example request

Result

Full schemas

​Access

​Arguments

​Example request

​Result

​Full schemas

Access

Arguments

Example request

Result

Full schemas