Skip to main content
Glama

git_status

Check the status of a Git repository to see staged, unstaged, and untracked files. Use this tool to review changes before committing in your workflow.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNo.

Implementation Reference

  • The main execution logic for the git_status tool: runs 'git status --porcelain', retrieves current branch, parses output, and returns JSON-formatted MCP content.
    async ({ path: gitPath }) => {
      return wrapToolExecution(async () => {
        const { stdout } = await execAsync(`git status --porcelain`, { cwd: gitPath });
        const branch = await getCurrentBranch(gitPath);
        const result = parseGitStatus(stdout, branch);
    
        return {
          content: [{
            type: "text" as const,
            text: JSON.stringify(result, null, 2)
          }]
        };
      }, {
        errorCode: ERROR_CODES.GIT_OPERATION,
        context: "Failed to get git status"
      });
    }
  • Type definitions for input parsing and output structure of git_status tool (GitStatusEntry and GitStatusResult).
    export interface GitStatusEntry {
      status: string;
      file: string;
    }
    
    export interface GitCommit {
      hash: string;
      author: string;
      date: string;
      message: string;
    }
    
    export interface GitStatusResult {
      branch: string;
      changes: GitStatusEntry[] | string;
    }
  • Registers the git_status tool on the MCP server with input schema and handler function.
    function registerGitStatus(server: McpServer): void {
      server.tool("git_status",
        {
          path: z.string().optional().default(".")
        },
        async ({ path: gitPath }) => {
          return wrapToolExecution(async () => {
            const { stdout } = await execAsync(`git status --porcelain`, { cwd: gitPath });
            const branch = await getCurrentBranch(gitPath);
            const result = parseGitStatus(stdout, branch);
    
            return {
              content: [{
                type: "text" as const,
                text: JSON.stringify(result, null, 2)
              }]
            };
          }, {
            errorCode: ERROR_CODES.GIT_OPERATION,
            context: "Failed to get git status"
          });
        }
      );
    }
  • Helper function to parse git status porcelain output into structured GitStatusResult.
    function parseGitStatus(stdout: string, branch: string): GitStatusResult {
      const lines = stdout.trim().split('\n').filter(line => line);
      const changes = lines.map(line => ({
        status: line.substring(0, 2).trim(),
        file: line.substring(3)
      }));
    
      return {
        branch,
        changes: changes.length > 0 ? changes : "No changes"
      };
    }
  • Helper function to retrieve the current git branch name.
    async function getCurrentBranch(cwd: string): Promise<string> {
      const { stdout } = await execAsync(`git rev-parse --abbrev-ref HEAD`, { cwd });
      return stdout.trim();
    }
Behavior1/5

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

Tool has no description.

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

Conciseness1/5

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

Tool has no description.

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

Completeness1/5

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

Tool has no description.

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

Parameters1/5

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

Tool has no description.

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

Purpose1/5

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

Tool has no description.

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

Usage Guidelines1/5

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

Tool has no description.

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

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/ishuru/open-mcp'

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