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

Sunwood-ai-labs_aira-mcp-server

一个基于TypeScript的MCP服务器,用于从git暂存文件生成提交信息,支持常规提交格式、Gitflow工作流和分支管理。

article

README

🚀 aira-mcp-server Git 提交服务器

aira-mcp-server 是一个模型上下文协议服务器,可从已暂存的 Git 文件创建提交消息。它基于 TypeScript 构建,能演示核心 MCP 概念,具备获取 Git 状态信息、生成约定式提交消息、初始化和管理 Gitflow 以及进行分支操作等功能。

🚀 快速开始

aira-mcp-server 是一个强大的工具,能帮助您更高效地管理 Git 提交和工作流。以下是使用它的基本步骤:

  1. 安装依赖并构建项目(具体安装步骤见“📦 安装指南”)。
  2. 在您的设置中配置 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 许可协议。

help

运行方式说明

cloud

托管运行

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

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

本地运行 / 其它方式

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

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