使用说明

项目简介

本项目是一个 MCP (Model Context Protocol) 服务器，专注于提供 Git 版本控制操作。它基于 FastMCP 库构建，允许 LLM 客户端通过调用预定义的工具函数来执行各种 Git 命令，例如仓库初始化、状态查看、文件添加、提交、分支管理、远程仓库操作等。该服务旨在为 LLM 应用集成 Git 功能，实现代码仓库的自动化管理和操作。

主要功能点

Git 仓库操作: 支持常用的 Git 操作，包括初始化、克隆、添加、提交、推送、拉取、分支管理、查看日志等。
远程仓库管理: 允许添加、删除、修改远程仓库，方便 LLM 客户端进行远程协作。
凭证管理: 提供 Git 凭证存储功能，支持用户名和密码/令牌的配置，简化认证流程。
用户配置: 支持设置 Git 用户名和邮箱，满足基本的 Git 配置需求。
工具化调用: 所有 Git 操作均以 MCP 工具的形式暴露，方便 LLM 客户端通过标准化的协议进行调用。

安装步骤

环境准备: 确保已安装 Python 3.10 或更高版本。
安装 FastMCP 库: 如果尚未安装 FastMCP 库，请运行以下命令安装：
```
pip install fastmcp
```
（请注意，虽然文档中提到了 FastMCP 库，但仓库本身没有提供 'requirements.txt' 文件，这里假设 FastMCP 库需要手动安装）

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到此 MCP 服务器：

{
  "server_name": "git_option",  // 服务名称，与 git_option.py 中 FastMCP 实例化的名称一致
  "command": "python",        // 启动服务器的命令，这里使用 python 解释器
  "args": [                   // 启动服务器的参数列表
    "git_option.py",         // 运行 git_option.py 文件
    "transport",             // 指定传输协议参数名
    "stdio"                  // 使用 stdio 传输协议，与 git_option.py 中 mcp.run(transport='stdio') 一致
  ]
}

基本使用方法

启动 MCP 服务器: 在安装 FastMCP 库和配置好 Python 环境后，MCP 服务器可以通过 MCP 客户端根据上述配置信息启动。
客户端调用工具: LLM 客户端连接到 MCP 服务器后，可以调用 'git_option' 服务器提供的各种 Git 工具，例如 'git_init', 'git_status', 'git_commit' 等。
参数传递: 调用工具时，需要根据工具的定义传递相应的参数，例如 'git_init' 工具需要 'path' 参数指定仓库路径，'git_commit' 工具需要 'path' 和 'message' 参数。
查看结果: 工具执行后，MCP 服务器会将执行结果以 JSON-RPC 响应的形式返回给客户端。

注意: 此 MCP 服务器依赖 Git 命令行工具，请确保运行服务器的环境已安装 Git 并配置到环境变量中。

关键词