veryfront__list_branchesAccess
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 |
|---|---|---|---|
limit | integer | No | Page size 1-100. Omit limit and cursor for the complete collection; cursor alone defaults to 20. Minimum: 1. Maximum: 100. |
cursor | string | No | Opaque continuation bound to collection, project, branch, principal, filters and page size. Minimum length: 1. Maximum length: 4096. |
search | string | No | Case-insensitive partial branch-name match. |
status | string | No | Branch status filter; defaults to all. Default: "all". Values: "active", "merged", "closed", "all". |
project_reference | string | No | Project 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.request.json
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "veryfront__list_branches",
"arguments": {}
}
}
Result
The published output shape is summarized below. Inspect both the MCP response content andisError when handling a call.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
branches | object[] | Yes | Persisted project branches, including the root branch. Paged results use ID ascending order; omit limit and cursor for the complete collection. |
page_info | object | No | Pagination cursor values for traversing the result set. |
Full schemas
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Page size 1-100. Omit limit and cursor for the complete collection; cursor alone defaults to 20."
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Opaque continuation bound to collection, project, branch, principal, filters and page size."
},
"search": {
"type": "string",
"description": "Case-insensitive partial branch-name match."
},
"status": {
"type": "string",
"enum": [
"active",
"merged",
"closed",
"all"
],
"description": "Branch status filter; defaults to all.",
"default": "all"
},
"project_reference": {
"type": "string",
"description": "Project ID or slug"
}
},
"additionalProperties": false,
"description": "Arguments for the list_branches tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}
{
"type": "object",
"properties": {
"branches": {
"type": "array",
"items": {
"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": "Persisted project branches, including the root branch. Paged results use ID ascending order; omit limit and cursor for the complete collection."
},
"page_info": {
"type": "object",
"properties": {
"self": {
"type": [
"string",
"null"
],
"description": "Cursor used for this page."
},
"first": {
"type": "null",
"description": "Omit cursor to request the first page."
},
"next": {
"type": [
"string",
"null"
],
"description": "Next page cursor, or null on the last page."
},
"prev": {
"type": [
"string",
"null"
],
"description": "Previous page cursor, or null on the first page."
}
},
"required": [
"self",
"first",
"next",
"prev"
],
"additionalProperties": false,
"description": "Pagination cursor values for traversing the result set."
}
},
"required": [
"branches"
],
"additionalProperties": false,
"description": "Structured result returned by the list_branches tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}