article
README
🚀 aira-mcp-server Git 提交服务器
aira-mcp-server 是一个模型上下文协议服务器,可从已暂存的 Git 文件创建提交消息。它基于 TypeScript 构建,能演示核心 MCP 概念,具备获取 Git 状态信息、生成约定式提交消息、初始化和管理 Gitflow 以及进行分支操作等功能。
🚀 快速开始
aira-mcp-server 是一个强大的工具,能帮助您更高效地管理 Git 提交和工作流。以下是使用它的基本步骤:
- 安装依赖并构建项目(具体安装步骤见“📦 安装指南”)。
- 在您的设置中配置 MCP 服务器(具体配置方法见“💻 使用示例”)。
✨ 主要特性
- 📝 约定式提交消息生成:自动使用约定式提交格式生成提交消息,使提交记录更加规范。
- 🌳 Gitflow 工作流支持:支持初始化和管理 Gitflow 工作流,方便团队协作。
- 🔍 Git 状态检查:可获取 Git 状态信息,让您随时了解仓库状态。
- 🔄 分支管理:提供创建、合并、列出分支等操作,轻松管理分支。
📦 安装指南
您可以按照以下步骤安装 aira-mcp-server:
npm install
npm run build
💻 使用示例
基础用法
在您的设置中配置 MCP 服务器:
{
"mcpServers": {
"aira": {
"command": "node",
"args": ["path/to/aira-mcp-server/build/index.js"]
}
}
}
📚 详细文档
🔧 可用工具
get_status
获取 Git 状态信息。
create_commit
为指定文件创建并执行提交。
init_gitflow
初始化 Gitflow。
create_branch
创建新分支。
merge_branch
根据 Gitflow 合并分支。
list_branches
列出所有 Gitflow 分支。
📄 许可证
本项目采用 MIT License 许可协议。
微信扫一扫