AtomGit MCP Server

1# AtomGit MCP Server
2[![smithery badge](https://smithery.ai/badge/@kaiyuanxiaobing/atomgit-mcp-server)](https://smithery.ai/server/@kaiyuanxiaobing/atomgit-mcp-server)
3 
4[English](./README_EN.md) | [中文](./README.md)
5 
6AtomGit MCP 服务器是专门为 AtomGit 开源协作平台的模型上下文(MCP) 服务的实现。提供了一系列方法，允许 AI 管理 AtomGit 开源协作平台的仓库、issues、pull requests、branch、label等。
7 
8## 安装使用
9 
10### 从源代码构建
11 
12#### 前提条件（npx启动跳过该步骤）
13- nodejs v18.20.2 或者更高版本
14- pnpm 10.9.0
15- 拥有 AtomGit 账户的访问令牌，[获取方式](https://docs.atomgit.com/user/pats)
16 
17#### 克隆仓库
18``` bash
19git clone https://atomgit.com/atomgit-open-source-ecosystem/atomgit-mcp-server.git
20 
21cd mcp-server-atomgit
22```
23 
24#### 构建项目
25```bash
26pnpm build
27```
28 
29#### 查看构建位置
30```bash
31pwd
32```
33#### claude 可执行文件启动
34stdio mode:
35```json
36{
37  "mcpServers": {
38    "command": "node",
39    "args": [
40      "/home/user/work/mcp-server-atomgit/dist/index.js"
41    ],
42    "env": {
43      "ATOMGIT_PERSONAL_ACCESS_TOKEN": "<your-atomgit-api-key-here>"
44    },
45  }
46}
47```
48 
49### MCP Hosts配置
50 
51#### claude 
52##### npx 启动
53```json
54{
55  "mcpServers": {
56    "atomgit-mcp-server": {
57      "command": "npx",
58      "args": [
59        "-y",
60        "atomgit-mcp-server@latest"
61      ],
62      "env": {
63        "ATOMGIT_PERSONAL_ACCESS_TOKEN": "<your-atomgit-api-key-here>"
64      }
65    }
66  }
67}
68```
69#### vscode
70 
71NPX
72``` json
73{
74  "mcp": {
75    "inputs": [
76      {
77        "type": "promptString",
78        "id": "your-atomgit-api-key",
79        "description": "AtomGit Personal Access Token",
80        "password": true
81      }
82    ],
83    "servers": {
84      "atomgit-mcp-server": {
85        "command": "npx",
86        "args": [
87          "-y",
88          "atomgit-mcp-server@latest"
89        ],
90        "env": {
91          "ATOMGIT_PERSONAL_ACCESS_TOKEN": "<your-atomgit-api-key-here>"
92        }
93      }
94    }
95  }
96}
97```
98 
99### 可用工具
100 
101mcp-server-atomgit 服务器提供了多种与 AtomGit 交互的工具，后续会不断完善：
102 
103| 工具                         | 类别           | 描述            |
104|-----------------------------|-------------|------------------|
105| **get_user_repository**     | repo         | 列出用户授权某个的仓库   |
106| **get_user_repositories**   | repo         | 列出用户授权的所有仓库   |
107| **get_org_repositories**    | repo         | 列出组织授权的所有仓库   |
108| **create_issue**            | issue       | 为某个仓库创建issue     |
109| **create_issue_comment**    | issue        | 为某条issue创建评论    |
110| **delete_issue_comment**    | issue        | 删除某条issue的评论    |
111| **get_issue_comment**       | issue        | 获取某条issue的评论    |
112| **list_issue_comments**     | issue        | 列出某条issue的所有评论 |
113| **list_issues**             | issue        | 列出某个仓库的所有issues |
114| **get_issue**               | issue        | 获取某个issue的详细信息 |
115| **set_assignees**           | issue        | 设置某个issue的负责人   |
116| **list_issue_assignees**    | issue        | 列出某个issue的负责人   |
117| **check_if_user_is_assignable** | issue    | 检查某用户是否可分配为issue负责人 |
118| **create_pull_request**         | pull     | 创建一个新的变更请求            |
119| **get_pull_request_details**    | pull     | 获取某个变更请求的详细信息      |
120| **create_pull_request_comment** | pull     | 为某个变更请求创建评论          |
121| **create_pull_request_reply**   | pull     | 回复某个变更请求的评论          |
122| **get_pull_request_comment**    | pull     | 获取某个变更请求评论的详细信息  |
123| **list_repository_branches**    | branch   | 获取分支列表                 |
124| **get_repository_branch_details** | branch  | 获取分支信息                 |
125| **get_repository_labels**         |  label  | 获取仓库所有标签              |
126| **create_issue_labels**           |  label  | 为issue添加标签              |
127| **get_issue_labels**              | label   | 获取issue的所有标签           |
128| **delete_issue_label**            |  label  | 从issue中移除标签             |
129| **get_label_by_name**             |  label  | 根据名称获取仓库中的单个标签     |
130 
131### 贡献
132 
133我们欢迎热爱开源的开发者们的贡献！如果您想为这个项目做出贡献，请按照以下指南操作：
134 
1351. 访问仓库[https://atomgit.com/atomgit-open-source-ecosystem/atomgit-mcp-server](https://atomgit.com/atomgit-open-source-ecosystem/atomgit-mcp-server)
1362. Fork 此[仓库](https://atomgit.com/atomgit-open-source-ecosystem/atomgit-mcp-server)
1373. 为 feature 或 bug 修复创建一个新分支。
1384. 更改代码，并确保代码有良好的文档。
1395. 提交一个 pull request，并附上清晰的更改描述。
140 
141有任何问题，请给我们提交[issue](https://atomgit.com/atomgit-open-source-ecosystem/atomgit-mcp-server/issues)，我们会及时查看反馈，并积极解决~
142 
143### 木兰宽松许可证, 第2版
144[木兰宽松许可证, 第2版](./license)
145 
146