@atomgit.com/atomgit-mcp-server
v2.0.1
Published
AtomGit MCP Server - Model Context Protocol server for AtomGit code hosting platform
Maintainers
Readme
AtomGit MCP Server
@atomgit.com/atomgit-mcp-server 是一个基于 Model Context Protocol (MCP) 的服务器实现,用于将 AtomGit 平台能力接入支持 MCP 的客户端,例如 Claude Desktop、Cursor、Trae 等。
主要特性
- 全量 MCP 工具接入:覆盖多个功能分类,提供 200+ 个工具。
- 默认安全模式:危险工具默认隐藏,需要时可显式开启。
- 基于 Access Token 认证:使用 AtomGit Personal Access Token 访问平台 API。
- 标准 MCP 协议:兼容基于 stdio 的 MCP 客户端集成方式。
- TypeScript 实现:包含类型定义、参数校验和构建产物。
功能模块
- 仓库管理:仓库查询、创建、删除、Fork、Star、Watch、文件操作。
- 分支与标签:分支管理、标签管理、受保护分支相关能力。
- 提交与发布:提交历史查询、版本发布管理。
- 合并请求:Pull Request 查询、创建、合并、Diff、评审相关能力。
- 工单管理:Issue 查询、创建、更新、评论、指派和状态管理。
- 项目规划:Milestone 与 Label 管理。
- 看板管理:组织看板与工作项管理。
- 用户与组织:用户信息、SSH 密钥、组织成员相关能力。
- 企业与成员:企业级资源和成员权限管理。
- 搜索与 Webhook:代码搜索、仓库搜索、用户搜索,以及 Webhook 管理。
- AIHub:AIHub 模型相关能力。
快速开始
前置要求
1. 获取 Access Token
- 登录 AtomGit。
- 打开 设置 -> 访问令牌。
- 创建新的 Personal Access Token。
- 根据实际使用场景分配权限;如需完整体验,可授予常用仓库和组织相关权限。
- 保存生成的 Token。
2. 通过 npx 运行
如采用 npm 包方式,可直接执行以下命令:
npx -y @atomgit.com/atomgit-mcp-server运行前请先设置环境变量 ATOMGIT_TOKEN。默认安全模式下,delete_*、remove_*、leave_*、archive_*、transfer_* 这类危险工具不会暴露给 MCP 客户端。
3. 安全模式与危险工具开关
- 默认值:
ATOMGIT_ENABLE_DANGEROUS_TOOLS=false - 默认行为:危险工具不会出现在
tools/list中,直接调用也会收到明确禁用提示 - 开启方式:设置
ATOMGIT_ENABLE_DANGEROUS_TOOLS=true后重启服务 - 当前文档与
docs/api_tool_map.md仍展示完整工具能力;运行时实际暴露的工具集合取决于该开关
例如,在临时 shell 中显式开启危险工具:
ATOMGIT_ENABLE_DANGEROUS_TOOLS=true npx -y @atomgit.com/atomgit-mcp-server4. 在 Claude Desktop 中配置
Claude Desktop 配置文件位置:
- Windows:
%APPDATA%\Claude\claude_desktop_config.json - macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
Windows 示例
Windows 环境建议将 command 设置为 npx.cmd:
{
"mcpServers": {
"atomgit": {
"command": "npx.cmd",
"args": [
"-y",
"@atomgit.com/atomgit-mcp-server"
],
"env": {
"ATOMGIT_TOKEN": "你的_ATOMGIT_TOKEN",
"ATOMGIT_ENABLE_DANGEROUS_TOOLS": "false"
}
}
}
}macOS / Linux 示例
{
"mcpServers": {
"atomgit": {
"command": "npx",
"args": [
"-y",
"@atomgit.com/atomgit-mcp-server"
],
"env": {
"ATOMGIT_TOKEN": "你的_ATOMGIT_TOKEN",
"ATOMGIT_ENABLE_DANGEROUS_TOOLS": "false"
}
}
}
}完成配置后,重启 Claude Desktop 使配置生效。
如需恢复当前全量行为,可把 ATOMGIT_ENABLE_DANGEROUS_TOOLS 改为 "true" 并重启客户端。
开发测试
如需参与开发、进行本地调试,或在 MCP 客户端中联调本地构建产物,可使用以下步骤:
git clone https://atomgit.com/zkxw2008/AtomGit-MCP-Server.git
cd AtomGit-MCP-Server
npm install
npm run build
node dist/index.js本地运行前至少需要提供:
ATOMGIT_TOKENATOMGIT_ENABLE_DANGEROUS_TOOLS=false
如需使用 .env,可先复制 .env.example 再填写;也可以直接通过 MCP 客户端或 shell 注入环境变量。
如需在 Claude Desktop 等 MCP 客户端中直接联调本地构建产物,可根据操作系统使用如下配置。
Windows 示例:
{
"mcpServers": {
"atomgit-dev": {
"command": "node.exe",
"args": [
"D:\\path\\to\\AtomGit-MCP-Server\\dist\\index.js"
],
"env": {
"ATOMGIT_TOKEN": "你的_ATOMGIT_TOKEN",
"ATOMGIT_ENABLE_DANGEROUS_TOOLS": "false"
}
}
}
}说明:
- Windows 路径中的反斜杠
\需要写成\\ - 如果
node.exe不在PATH中,可改为 Node.js 的绝对路径
macOS / Linux 示例:
{
"mcpServers": {
"atomgit-dev": {
"command": "node",
"args": [
"/path/to/AtomGit-MCP-Server/dist/index.js"
],
"env": {
"ATOMGIT_TOKEN": "你的_ATOMGIT_TOKEN",
"ATOMGIT_ENABLE_DANGEROUS_TOOLS": "false"
}
}
}
}开发说明
常用命令
| 命令 | 说明 |
|------|------|
| npm run dev | 使用 tsx 直接运行源码 |
| npm run build | 编译 TypeScript 代码到 dist/ |
| npm run start | 运行编译后的 dist/index.js |
| npm run typecheck | 执行 TypeScript 类型检查 |
| npm run clean | 清理 dist/ 目录 |
| npm run api:sync | 更新 API 定义来源数据 |
| npm run api:check | 检查 API 覆盖情况 |
| npm run api:scaffold | 为指定 API 生成工具和服务代码 |
| npm run api:map | 生成 API 与工具映射文档 |
项目结构
AtomGit-MCP-Server/
├── src/
│ ├── core/ # 核心基础设施
│ ├── services/ # API 服务层
│ ├── tools/ # MCP 工具层
│ ├── types/ # 类型定义
│ └── index.ts # 服务入口
├── scripts/ # 辅助脚本
├── docs/ # 文档与 API 映射
└── dist/ # 编译产物相关链接
- npm: @atomgit.com/atomgit-mcp-server
- AtomGit Repository: zkxw2008/AtomGit-MCP-Server
- GitHub Mirror: kylezhang/AtomGit-MCP-Server
- Release Guide: RELEASE.md
许可证
本项目采用 Apache 2.0 License。
