Git操作协议服务器

一个基于Spring Boot (WebFlux)的轻量级本地Git操作协议服务器,支持Java 17和Maven构建。

  • by JoeAhava
  • Java
  • 本地部署
  • 更新于
在 GitHub 查看 JoeAhava/local-git-mcp

使用说明

本地Git MCP

用于本地Git操作的轻量级Spring Boot(WebFlux)MCP(模型控制协议)服务器。


快速概览

使用Java 17和Spring Boot(WebFlux)构建。使用Spring AI MCP服务器启动器。包括一个用于可重复构建的Maven包装器。


快速入门

克隆、生成和运行(Windows-cmd.exe):

git clone git@github.com:JoeAhava/local-git-mcp.git
cd local-git-mcp
mvnw.cmd clean package
mvnw.cmd spring-boot:run

macOS/Linux:

git clone git@github.com:JoeAhava/local-git-mcp.git
cd local-git-mcp
./mvnw clean package
./mvnw spring-boot:run

打包运行:

# Windows
mvnw.cmd -DskipTests package
java -jar target/local-git-mcp-0.0.1-SNAPSHOT.jar

先决条件

  • JDK 17(设置JAVA_HOME)
  • Git(SSH密钥,如果推送到GitHub)
  • 推荐IDE:IntelliJ(启用龙目插件和注释处理)

构建和测试

使用附带的Maven包装器:

# Run tests
mvnw.cmd test

# Build
mvnw.cmd -DskipTests package

在dev中运行:

mvnw.cmd spring-boot:run

配置

主要设置位于 src/main/resources/application.properties.用env变量重写或 -D 系统属性(例如。 -Dserver.port=8080).


开发笔记

  • 在IDE中作为Maven项目打开。
  • 为龙目岛启用注释处理。
  • 使用Maven包装器进行CI奇偶校验。

CI/发布

建议的CI步骤:结账→ 设置JDK 17→ ./mvnw -B -DskipTests=false test → ./mvnw -B -DskipTests package根据需要考虑Docker镜像构建和工件发布。


贡献

  1. Fork → 分支→ 实施→ 本地测试→ push → PR to main.
  2. 保持提交的重点,并使用命令式提交消息(例如。 feat: …, fix: …).

许可证

不包括许可证文件。添加一个 LICENSE (例如Apache-2.0或MIT)使使用条款明确。


故障排除

  • Java版本错误:验证 java -version 和 JAVA_HOME.
  • 龙目IDE问题:启用龙目插件+注释处理。
  • SSH推送错误:确保您的SSH密钥已添加到GitHub,并且代理正在运行。

下一步

根据需要添加许可证、CI工作流、CONTRIBUTING.md、Dockerfile和集成测试。


如有疑问,请打开问题或联系维护人员。