Content
# AtomGit MCP Server
[](https://smithery.ai/server/@kaiyuanxiaobing/atomgit-mcp-server)
[English](./README_EN.md) | [中文](./README.md)
AtomGit MCP Server is specifically designed to implement the Model Context (MCP) service for the AtomGit open-source collaboration platform. It provides a range of methods that allow AI to manage repositories, issues, pull requests, branches, labels, and more on the AtomGit open-source collaboration platform.
## Installation and Usage
### Build from Source Code
#### Prerequisites (Skip this step if using npx)
- nodejs v18.20.2 or higher
- pnpm 10.9.0
- Access token for AtomGit account, [how to obtain](https://docs.atomgit.com/user/pats)
#### Clone the Repository
``` bash
git clone https://atomgit.com/atomgit-open-source-ecosystem/atomgit-mcp-server.git
cd mcp-server-atomgit
```
#### Build the Project
```bash
pnpm build
```
#### View Build Location
```bash
pwd
```
#### Starting the claude Executable
stdio mode:
```json
{
"mcpServers": {
"command": "node",
"args": [
"/home/user/work/mcp-server-atomgit/dist/index.js"
],
"env": {
"ATOMGIT_PERSONAL_ACCESS_TOKEN": "<your-atomgit-api-key-here>"
},
}
}
```
### MCP Hosts Configuration
#### claude
##### Starting with npx
```json
{
"mcpServers": {
"atomgit-mcp-server": {
"command": "npx",
"args": [
"-y",
"atomgit-mcp-server@latest"
],
"env": {
"ATOMGIT_PERSONAL_ACCESS_TOKEN": "<your-atomgit-api-key-here>"
}
}
}
}
```
#### vscode
NPX
``` json
{
"mcp": {
"inputs": [
{
"type": "promptString",
"id": "your-atomgit-api-key",
"description": "AtomGit Personal Access Token",
"password": true
}
],
"servers": {
"atomgit-mcp-server": {
"command": "npx",
"args": [
"-y",
"atomgit-mcp-server@latest"
],
"env": {
"ATOMGIT_PERSONAL_ACCESS_TOKEN": "<your-atomgit-api-key-here>"
}
}
}
}
}
```
### Available Tools
The mcp-server-atomgit server provides various tools for interacting with AtomGit, which will be continuously improved:
| Tool | Category | Description |
|-----------------------------|---------------|-----------------------------------|
| **get_user_repository** | repo | List the repositories authorized by the user |
| **get_user_repositories** | repo | List all repositories authorized by the user |
| **get_org_repositories** | repo | List all repositories authorized by the organization |
| **create_issue** | issue | Create an issue for a specific repository |
| **create_issue_comment** | issue | Create a comment for a specific issue |
| **delete_issue_comment** | issue | Delete a comment from a specific issue |
| **get_issue_comment** | issue | Get comments for a specific issue |
| **list_issue_comments** | issue | List all comments for a specific issue |
| **list_issues** | issue | List all issues for a specific repository |
| **get_issue** | issue | Get detailed information about a specific issue |
| **set_assignees** | issue | Set the assignees for a specific issue |
| **list_issue_assignees** | issue | List the assignees for a specific issue |
| **check_if_user_is_assignable** | issue | Check if a user can be assigned as an issue assignee |
| **create_pull_request** | pull | Create a new pull request |
| **get_pull_request_details** | pull | Get detailed information about a specific pull request |
| **create_pull_request_comment** | pull | Create a comment for a specific pull request |
| **create_pull_request_reply** | pull | Reply to a comment on a specific pull request |
| **get_pull_request_comment** | pull | Get detailed information about a comment on a specific pull request |
| **list_repository_branches** | branch | Get the list of branches |
| **get_repository_branch_details** | branch | Get information about a branch |
| **get_repository_labels** | label | Get all labels in the repository |
| **create_issue_labels** | label | Add labels to an issue |
| **get_issue_labels** | label | Get all labels for an issue |
| **delete_issue_label** | label | Remove a label from an issue |
| **get_label_by_name** | label | Get a single label in the repository by name |
### Contribution
We welcome contributions from developers who love open source! If you would like to contribute to this project, please follow these guidelines:
1. Visit the repository [https://atomgit.com/atomgit-open-source-ecosystem/atomgit-mcp-server](https://atomgit.com/atomgit-open-source-ecosystem/atomgit-mcp-server)
2. Fork this [repository](https://atomgit.com/atomgit-open-source-ecosystem/atomgit-mcp-server)
3. Create a new branch for your feature or bug fix.
4. Make your changes and ensure that the code is well documented.
5. Submit a pull request with a clear description of the changes.
If you have any questions, please submit an [issue](https://atomgit.com/atomgit-open-source-ecosystem/atomgit-mcp-server/issues), and we will review the feedback promptly and address it actively~
### Mulan Permissive License, Version 2
[Mulan Permissive License, Version 2](./license)
