Git MCP Server

@cyanheads/git-mcp-server

A Git MCP server for AI agents. STDIO & Streamable HTTP.

28 Tools · 1 Resource · 1 Prompt

______________________________________________________________________

工具

28个git操作分为七类：

资源

提示

入门

运行时

适用于Bun和Node.js。自动检测运行时间。

MCP客户端配置

将以下内容添加到MCP客户端配置中（例如。， cline_mcp_settings.json).更新环境变量以匹配您的设置，尤其是git标识字段。

{
  "mcpServers": {
    "git-mcp-server": {
      "type": "stdio",
      "command": "npx",
      "args": ["@cyanheads/git-mcp-server@latest"],
      "env": {
        "MCP_TRANSPORT_TYPE": "stdio",
        "MCP_LOG_LEVEL": "info",
        "GIT_BASE_DIR": "~/Developer/",
        "LOGS_DIR": "~/Developer/logs/git-mcp-server/",
        "GIT_USERNAME": "cyanheads",
        "GIT_EMAIL": "casey@caseyjhand.com",
        "GIT_SIGN_COMMITS": "true"
      }
    }
  }
}

Bun用户：更换 "command": "npx" 和 "command": "bunx".

对于流式HTTP，设置 MCP_TRANSPORT_TYPE=http 和 MCP_HTTP_PORT=3015.

特性

建立在 mcp-ts-template.

安全

• 所有文件路径都经过验证和清理，以防止目录遍历。
• 可选的 GIT_BASE_DIR 将操作限制在多租户沙盒的特定目录树中。
• Git命令通过进程生成使用经过验证的参数——没有shell插值。
• JWT和OAuth支持经过身份验证的部署。
• 通过DI管理的可选速率限制 RateLimiter 服务。
• 所有操作都会记录请求上下文以供审核。

配置

所有配置在启动时均已验证 src/config/index.ts.关键环境变量：

运行服务器

通过软件包管理器（无需安装）

npx @cyanheads/git-mcp-server@latest

通过环境变量或MCP客户端配置进行配置。

本地开发

# Build and run
npm run rebuild
npm run start:stdio   # or start:http

# Dev mode with hot reload
npm run dev:stdio     # or dev:http

# Checks and tests
npm run devcheck      # lint, format, typecheck
npm test

Cloudflare Workers

npm run build:worker   # Build the worker bundle
npm run deploy:dev     # Run locally with Wrangler
npm run deploy:prod    # Deploy to Cloudflare

项目结构

响应格式

通过配置输出格式和详细程度 MCP_RESPONSE_FORMAT 和 MCP_RESPONSE_VERBOSITY.

JSON格式（默认，针对LLM消费进行了优化）：

{
  "success": true,
  "branch": "main",
  "staged": ["src/index.ts", "README.md"],
  "unstaged": ["package.json"],
  "untracked": []
}

Markdown格式（人类可读）：

# Git Status: main

## Staged (2)
- src/index.ts
- README.md

## Unstaged (1)
- package.json

LLM始终通过以下方式接收完整的结构化数据 responseFormatter --完整的文件列表、元数据、时间戳——无论客户端显示什么。详细程度控制着包含多少细节： minimal （仅核心字段）， standard （平衡），或 full （一切）。

发展指南

看 AGENTS.md 架构、工具开发模式和贡献规则。

测试

测试使用 邦氏试跑器 具有Vitest兼容性。

bun test              # Run all tests
bun test --coverage   # With coverage
bun run devcheck      # Lint, format, typecheck, audit

路线图

服务器使用基于提供者的架构进行git操作：

• CLI提供程序 （当前）--通过本机git CLI全面覆盖28个工具。需要安装本地git。
• 同构git提供者 （计划中）——用于边缘部署的纯JS实现（Cloudflare Workers、Vercel edge、Deno Deploy）。用途 同构git.
• GitHub API提供程序 （也许）——通过GitHub REST/GraphQL API进行云原生操作，不需要本地仓库。

贡献

欢迎问题和拉取请求。提交前运行检查：

npm run devcheck
npm test

许可证

Apache 2.0。看 许可证.

______________________________________________________________________

Built with the mcp-ts-template

Sponsor this project · Buy me a coffee