使用说明
GitHub企业MCP服务器
一 MCP(模型上下文协议)服务器 用于GitHub Enterprise API。将其与Claude Desktop、Cursor或任何MCP客户端一起使用,以查看和管理存储库、问题、PR、分支、提交、存储库内容和git操作(标签、引用)。
特性
- 仅限GitHub企业版 –支持自托管的GitHub Enterprise API
- MCP标准 – 模型上下文协议 基于工具
- HTTPS和令牌验证 –端点和令牌格式检查,以及启动身份验证
- 包中没有凭据 –未提供身份验证信息(适用于本地/内部使用)
项目结构
.
├── README.md # This file (repository overview)
├── .gitignore
├── docs/ # Project documentation
│ └── tools-and-api.md # MCP tool list and GitHub API mapping
└── mcp-server/ # MCP server package
├── README.md # Installation, configuration, tools, publishing
├── package.json
└── src/
对于 安装、MCP设置(Claude Desktop/Cursor)、可用工具、安全性和npm发布,请参阅 mcp服务器/README.md.
快速开始
需求
- Node.js 18+
- GitHub企业版 端点(HTTPS) 和 个人访问令牌
安装并运行
cd mcp-server
npm install
npm run build
运行(建议使用环境变量):
export GITHUB_ENTERPRISE_ENDPOINT="https://your-ghe.example.com/api/v3"
export GITHUB_ENTERPRISE_TOKEN="ghp_YOUR_TOKEN"
node dist/index.js
或者在不安装的情况下运行(npx):
npx -y github-enterprise-mcp-server --endpoint https://your-ghe.example.com/api/v3 --token ghp_YOUR_TOKEN
这 工具列表 和 GitHub API 映射记录在 docs/tools-and-api.md。有关设置和使用方法,请参阅 mcp服务器/README.md.
安全
- 仅限HTTPS –只接受HTTPS端点。
- 令牌格式 -代币必须符合GitHub格式(
ghp_,ghs_等等)。 - 没有数据发送到其他地方 –服务器发送数据 仅 到您配置的GitHub端点。它不会向其他服务器或第三方传输任何数据。
- 更喜欢 环境变量 对于代币;避免将其放入配置文件中。
- 如果令牌被泄露,请立即在GitHub Enterprise中撤销它并创建一个新的令牌。
npm包名称(发布到公共注册表)
名称 github-enterprise-mcp-server 已在上注册 公共npm注册表(npmjs.com).致 将此存储库发布到npmjs.com的其他列表下,您必须使用 不同的包名称.
- 推荐: 使用作用域包--更改
name在package.json例如。@<org-or-username>/github-enterprise-mcp-server,然后运行npm publish --access public. - 或者使用另一个全球唯一的名称(例如。
github-enterprise-mcp-server-ghe,your-org-mcp-github).
使用相同名称发布将导致npm“包名已存在”错误。
发展
这个项目的所有开发都完成了 100% 使用:
许可证
麻省理工学院