返回 MCP 目录
public公开dns本地运行

git-prompts-mcp-server

一个基于Git仓库内容生成提示的MCP服务器

article

README

🚀 Git 提示 MCP 服务器

此项目提供了一个模型上下文协议 (MCP) 服务器,该服务器可依据 Git 仓库的内容,提供多个命令来生成提示,为开发者在处理 Git 仓库时提供便利。

(本仓库从 MarkItDown MCP 服务器 和示例 Git MCP 服务器 中获取了大量灵感。)

🚀 快速开始

本服务器能依据 Git 仓库内容生成提示,下面为你介绍安装和使用方法。

📦 安装指南

手动安装

  1. 克隆此仓库。
  2. 安装依赖项:uv sync --frozen

💻 使用示例

作为 Zed 编辑器的 MCP 服务器

在你的 settings.json 中添加以下内容:

"context_servers": {
  "git_prompt_mcp": {
    "command": {
      "path": "uv",
      "args": [
        "--directory",
        "/path/to/local/git_prompts_mcp_server",
        "run",
        "git-prompts-mcp-server",
        "/path/to/repo/", // .git 文件夹的父文件夹路径
        "--excludes", // 从 diff 结果中排除文件和目录
        "**/uv.lock",
        "--excludes",
        "**/.gitignore",
        "--format", // diff 结果的格式
        "json"  // 选项:json、text
      ]
    },
    "settings": {}
  }
}

命令

该服务器响应以下命令:

  1. /git-diff <ancestor_branch_or_commit>:根据 HEAD 和指定的祖先分支或提交生成 diff 结果。
  2. /generate-pr-desc <ancestor_branch_or_commit>:根据 HEAD 和指定的祖先分支或提交之间的 diff 结果生成拉取请求描述。
  • 注意:此命令基本上与 /git-diff 相同,但末尾包含生成拉取请求描述的指令。
  1. /git-cached-diff:为已提交的变化和 HEAD 生成 diff 结果。

示例

  • /generate-pr-desc main
  • /git-diff dev
  • /git-cached-diff

📄 许可证

本项目采用 MIT License。有关详细信息,请参阅 LICENSE

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端