list_branches
Retrieves a complete list of all branches in a SysML v2 project with detailed hierarchy and relationship information.
Purpose
Retrieves a complete list of all branches in a SysML v2 project with detailed hierarchy and relationship information, including parent-child relationships and full ancestry paths. This tool is essential for understanding version control structure, identifying branch lineage, and discovering available development streams. Each branch includes metadata such as creator, timestamps, privacy settings, archive status, and head commit IDs, enabling informed decisions about which version to work with.
Tags: AM Read Standard
Input parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id |
string | Yes | Project name or UUID |
Output schema
| Field | Type | Description |
|---|---|---|
| summary.project_id | string | UUID of the project |
| summary.total_branches | integer | Total number of branches in the project |
| summary.default_branches | integer | Number of default branches (typically 1) |
| summary.public_branches | integer | Number of public (non-private) branches |
| summary.private_branches | integer | Number of private branches |
| summary.archived_branches | integer | Number of archived branches |
| summary.default_branch | string | Name of the default branch |
| summary.default_branch_id | string | UUID of the default branch |
| branches[].name | string | Name of the branch |
| branches[].branch_id | string | Unique identifier for the branch |
| branches[].description | string | Description of the branch purpose |
| branches[].path | string | Full ancestry path showing branch lineage (e.g., "main → development → feature/power-system") |
| branches[].parent | string | Name of the parent branch |
| branches[].head_commit_id | string | UUID of the latest commit on this branch |
| branches[].creator | string | UUID of the user who created the branch |
| branches[].lastModifiedBy | string | UUID of the user who last modified the branch |
| branches[].isDefault | boolean | Indicates if this is the default branch |
| branches[].isPrivate | boolean | Indicates if the branch is private |
| branches[].isArchived | boolean | Indicates if the branch is archived |
| branches[].created | string | ISO 8601 timestamp when the branch was created |
| branches[].lastModified | string | ISO 8601 timestamp when the branch was last modified |
Common use cases
- Branch discovery
- Find all available branches for version exploration. For example: What branches are available in this project?
- Branch hierarchy
- Understand branch relationships and ancestry. For example: Show me the branch hierarchy.
- Branch selection
- Get branch IDs for use in other operations. For example: What is the ID of the feature or power-system branch?