Skip to main content
Glama

branch_list

Retrieve a detailed list of all branches in a specified Git repository using an absolute path, enabling efficient branch management and repository navigation.

Instructions

List all branches

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoPath to repository. MUST be an absolute path (e.g., /Users/username/projects/my-repo)

Implementation Reference

  • The primary handler function for the 'branch_list' tool. It validates the repository path, executes 'git branch -a' via CommandExecutor, formats the output, and handles caching.
    static async branchList(options: BasePathOptions, context: GitToolContext): Promise<GitToolResult> {
      const path = this.getPath(options);
      return await this.executeOperation(
        context.operation,
        path,
        async () => {
          const { path: repoPath } = PathValidator.validateGitRepo(path);
          const result = await CommandExecutor.executeGitCommand(
            'branch -a',
            context.operation,
            repoPath
          );
    
          const output = result.stdout.trim();
          return {
            content: [{
              type: 'text',
              text: output || 'No branches found'
            }]
          };
        },
        {
          useCache: true,
          stateType: RepoStateType.BRANCH,
          command: 'branch -a'
        }
      );
    }
  • Registers the handler dispatch for 'branch_list' tool in the switch statement of the CallToolRequestSchema handler.
    case 'branch_list': {
      const validArgs = this.validateArguments(operation, args, isPathOnly);
      return await GitOperations.branchList(validArgs, context);
    }
  • Defines the tool schema including name, description, and input schema (path property) for 'branch_list' in the ListToolsRequestSchema response.
    {
      name: 'branch_list',
      description: 'List all branches',
      inputSchema: {
        type: 'object',
        properties: {
          path: {
            type: 'string',
            description: `Path to repository. ${PATH_DESCRIPTION}`,
          },
        },
        required: [],
      },
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. 'List all branches' implies a read-only operation but does not specify output format (e.g., list of names, details), pagination, sorting, or error handling (e.g., if the path is invalid). It lacks details on permissions, rate limits, or whether it includes remote branches, leaving significant gaps in transparency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise with just three words, front-loading the core action ('List all branches') without any unnecessary elaboration. Every word earns its place by directly conveying the tool's purpose, making it efficient and well-structured for quick understanding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the lack of annotations and output schema, the description is incomplete for a tool that interacts with a repository. It does not explain what 'branches' entails (e.g., local, remote, current), the return format, or error conditions. For a tool with one parameter and no structured output, more context is needed to guide effective use, especially among siblings like 'tag_list'.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 100% description coverage for its single parameter ('path'), so the description does not need to add parameter details. The description does not mention the 'path' parameter or provide any additional semantic context beyond what the schema offers. This meets the baseline for high schema coverage but adds no extra value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'List all branches' clearly states the verb ('List') and resource ('branches'), making the purpose understandable. However, it lacks specificity about scope (e.g., local vs. remote branches) and does not distinguish itself from sibling tools like 'tag_list' or 'remote_list', which follow a similar pattern. This makes it adequate but vague in differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It does not mention prerequisites (e.g., requiring a repository path), exclusions, or comparisons to siblings like 'status' (which might show branch info) or 'remote_list' (for remote branches). Without such context, users must infer usage from the tool name alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Sheshiyer/git-mcp-v2'

If you have feedback or need assistance with the MCP directory API, please join our Discord server