使用说明

项目简介

'aira-mcp-server' 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 LLM 客户端提供 Git 版本控制相关的工具。通过此服务器，LLM 应用可以获取 Git 仓库的状态信息，并辅助开发者创建符合 Conventional Commits 规范的代码提交信息，从而提升代码管理的效率和规范性。

主要功能点

获取 Git 状态: 允许 LLM 客户端查询指定 Git 仓库的当前状态，包括已暂存、未暂存和未跟踪的文件列表，以及文件的修改状态。
创建提交信息: 支持根据用户指定的提交类型、emoji 表情、标题和内容，自动生成符合 Conventional Commits 规范的提交消息，并执行 'git commit' 命令，完成代码提交。

安装步骤

前提条件: 确保已安装 Node.js 和 npm (Node 包管理器)。

克隆仓库: 使用 Git 命令克隆 'aira-mcp-server' 仓库到本地：

git clone https://github.com/Sunwood-ai-labs/aira-mcp-server.git

进入目录: 导航到克隆下来的项目目录：
```
cd aira-mcp-server
```
安装依赖: 使用 npm 安装项目所需的依赖包：
```
npm install
```
构建项目: 编译 TypeScript 代码并生成可执行的 JavaScript 文件：
```
npm run build
```

服务器配置

要将 'aira-mcp-server' 配置为 MCP 服务器，您需要在 MCP 客户端的配置文件中添加如下服务器配置信息。通常，客户端需要指定服务器的启动命令 ('command') 和参数 ('args')。

{
  "mcpServers": {
    "aira": {
      "command": "node",
      "args": ["path/to/aira-mcp-server/build/index.js"] // 将 "path/to/aira-mcp-server" 替换为项目 build 目录下 index.js 文件的实际路径
    }
  }
}

请注意:

'"path/to/aira-mcp-server/build/index.js"' 需要替换为您本地 'aira-mcp-server' 项目构建后 'build/index.js' 文件的绝对路径。例如，如果您的 'aira-mcp-server' 项目位于 '/Users/yourname/aira-mcp-server'，则应配置为 '"args": ["/Users/yourname/aira-mcp-server/build/index.js"]'。

基本使用方法

启动服务器: 在 MCP 客户端中配置好上述服务器信息后，当客户端需要与 'aira-mcp-server' 交互时，会自动启动该服务器。服务器将在后台运行，并通过 Stdio (标准输入输出) 与客户端进行通信。
调用工具: 客户端通过 MCP 协议向服务器发送 JSON-RPC 请求来调用可用的工具。
- 'get_status' 工具: 用于获取 Git 仓库状态。客户端需要提供 'path' 参数，指定 Git 仓库的绝对路径。
- 'create_commit' 工具: 用于创建代码提交。客户端需要提供 'file' (提交文件路径), 'path' (Git 仓库路径), 'type' (提交类型), 'emoji' (emoji表情), 'title' (提交标题) 等参数来生成和执行提交。
接收响应: 服务器执行工具后，会将结果封装在 JSON-RPC 响应中返回给客户端。响应内容会包含工具执行的具体信息，例如 Git 状态的 JSON 数据或提交操作的结果消息。

请参考仓库中的 'README.md' 和代码示例了解更详细的工具参数和使用方法。

关键词