Update branch status check

veryfront__update_branch_status_check

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
statusstringYesState to report: pending, success or failure. Values: "pending", "success", "failure".
descriptionstringNoDescription of the result.
external_urlstringNoLink to the external result.
branch_idstringYesBranch the check reports on. A missing branch and one you cannot read are both not found. Format: uuid.
check_namestringYesCheck name, such as "ci/build"; the key of the check on its branch. At most 100 characters. Minimum length: 1. Maximum length: 100.

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__update_branch_status_check",
    "arguments": {
      "status": "pending",
      "branch_id": "00000000-0000-4000-8000-000000000000",
      "check_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
idstringYesStatus check ID. Format: uuid.
branch_idstringYesBranch the check reports on. Format: uuid.
check_namestringYesCheck name; the key of the check on its branch.
statusstringYesReported state. Values: "pending", "success", "failure".
descriptionstring or nullYesResult description, or null.
external_urlstring or nullYesLink to the external result, or null.
started_atstring or nullYesStart time, or null when unavailable.
completed_atstring or nullYesCompletion time, or null while pending.
created_atstringYesCreation time.
updated_atstringYesLast update time.

Full schemas

json
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "success",
        "failure"
      ],
      "description": "State to report: pending, success or failure."
    },
    "description": {
      "type": "string",
      "description": "Description of the result."
    },
    "external_url": {
      "type": "string",
      "description": "Link to the external result."
    },
    "branch_id": {
      "type": "string",
      "format": "uuid",
      "description": "Branch the check reports on. A missing branch and one you cannot read are both not found."
    },
    "check_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "Check name, such as \"ci/build\"; the key of the check on its branch. At most 100 characters."
    }
  },
  "required": [
    "status",
    "branch_id",
    "check_name"
  ],
  "additionalProperties": false,
  "description": "Use this from CI or a review step to report one named status check as pending, success or failure. It creates the check or replaces the one with the same name, and returns the stored status check.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Status check ID."
    },
    "branch_id": {
      "type": "string",
      "format": "uuid",
      "description": "Branch the check reports on."
    },
    "check_name": {
      "type": "string",
      "description": "Check name; the key of the check on its branch."
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "success",
        "failure"
      ],
      "description": "Reported state."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Result description, or null."
    },
    "external_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "Link to the external result, or null."
    },
    "started_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Start time, or null when unavailable."
    },
    "completed_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Completion time, or null while pending."
    },
    "created_at": {
      "type": "string",
      "description": "Creation time."
    },
    "updated_at": {
      "type": "string",
      "description": "Last update time."
    }
  },
  "required": [
    "id",
    "branch_id",
    "check_name",
    "status",
    "description",
    "external_url",
    "started_at",
    "completed_at",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the update_branch_status_check tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}