article
README
🚀 aira-mcp-server MCP 服务器
一个用于从已暂存的文件生成提交信息的 Model Context Protocol 服务器。该服务器基于 TypeScript 实现,演示了核心 MCP 概念,具备获取 Git 状态信息、使用约定式提交格式创建提交消息、初始化和管理 Gitflow 以及进行分支操作(创建、合并、列出)等功能。
🚀 快速开始
本 MCP 服务器可帮助你高效处理 Git 相关操作,如生成提交消息、管理分支等。以下是使用前的准备步骤和使用示例。
✨ 主要特性
- 📝 约定式提交消息生成:自动生成符合约定式提交规范的提交消息。
- 🌳 Gitflow 工作流支持:支持初始化和管理 Gitflow 工作流。
- 🔍 Git 状态检查:可获取当前 Git 仓库的状态信息。
- 🔄 分支管理:提供创建、合并和列出分支等操作。
📦 安装指南
在使用本服务器前,你需要进行安装和构建,具体命令如下:
npm install
npm run build
💻 使用示例
基础用法
在你的设置中配置 MCP 服务器,示例配置如下:
{
"mcpServers": {
"aira": {
"command": "node",
"args": ["path/to/aira-mcp-server/build/index.js"]
}
}
}
高级用法
本服务器提供了多个工具,可满足不同的 Git 操作需求。以下是各工具的详细说明:
get_status
获取 Git 状态信息。
create_commit
为指定文件创建并执行提交。
init_gitflow
初始化 Gitflow。
create_branch
创建新分支。
merge_branch
根据 Gitflow 合并分支。
list_branches
列出所有 Gitflow 分支。
📄 许可证
本项目采用 MIT License 进行许可。
微信扫一扫