> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update branch status check

> Create or replace one named status check on a branch.

`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

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `status` | `string` | Yes | State to report: pending, success or failure. Values: `"pending"`, `"success"`, `"failure"`. |
| `description` | `string` | No | Description of the result. |
| `external_url` | `string` | No | Link to the external result. |
| `branch_id` | `string` | Yes | Branch the check reports on. A missing branch and one you cannot read are both not found. Format: `uuid`. |
| `check_name` | `string` | Yes | Check 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](https://veryfront.com/docs/cloud/getting-started/connect-mcp.md).

```json title="request.json" theme={null}
{
  "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.

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `id` | `string` | Yes | Status check ID. Format: `uuid`. |
| `branch_id` | `string` | Yes | Branch the check reports on. Format: `uuid`. |
| `check_name` | `string` | Yes | Check name; the key of the check on its branch. |
| `status` | `string` | Yes | Reported state. Values: `"pending"`, `"success"`, `"failure"`. |
| `description` | `string or null` | Yes | Result description, or null. |
| `external_url` | `string or null` | Yes | Link to the external result, or null. |
| `started_at` | `string or null` | Yes | Start time, or null when unavailable. |
| `completed_at` | `string or null` | Yes | Completion time, or null while pending. |
| `created_at` | `string` | Yes | Creation time. |
| `updated_at` | `string` | Yes | Last update time. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "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 title="output-schema.json" theme={null}
{
  "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#"
}
```

<details>
  <summary>Try this tool</summary>

  Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.

  MCP tool call

  Call `veryfront__update_branch_status_check` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run this tool with these arguments.

  Run tool

  Output JSON

  <pre />
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.