article
README
🚀 GitHub Actions MCP 服务器
本仓库实现了用于管理 GitHub Actions 工作流和资源的模型上下文协议(MCP)服务器。该服务器旨在与 GitHub 仓库进行交互,提供工具、资源与提示,以实现工作流的自动化管理。
🚀 快速开始
先决条件
- Docker
- Node.js(v16 或更高版本)
- GitHub 个人访问令牌(PAT)及其适当权限
设置步骤
- 克隆仓库:
git clone https://github.com/devopsier/github-actions-mcp.git
cd github-actions-mcp
- 安装依赖项:
npm install
- 构建 Docker 镜像:
docker build -t github-actions-mcp .
- 运行服务器:
docker run -i --rm -e GITHUB_TOKEN=<your_github_token> -e GITHUB_TYPE=cloud github-actions-mcp
配置
服务器可通过你的 VS Code 工作区中的 settings.json 文件进行配置。示例:
"mcp": {
"servers": {
"mcp-github-actions": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GITHUB_TOKEN",
"-e",
"GITHUB_TYPE",
"github-actions-mcp"
],
"env": {
"GITHUB_TOKEN": "<your_github_token>",
"GITHUB_TYPE": "cloud"
}
}
}
}
✨ 主要特性
- 资源管理:获取并管理 GitHub 仓库和工作流。
- 工具执行:触发工作流并管理 GitHub Actions 工具。
- 提示生成:创建问题、审查拉取请求等。
📦 项目结构
/app/github-actions-mcp-server
├── Dockerfile
├── package.json
├── tsconfig.json
├── src/
│ ├── http-server.ts
│ ├── server.backup.ts
│ ├── server.ts
│ ├── stdio-server.ts
│ ├── github/
│ │ └── client.ts
│ └── utils/
│ └── utils.ts
💻 贡献方式
我们欢迎对 GitHub Actions MCP Server 项目做出贡献!要进行贡献,请按照以下步骤操作:
- 在 GitHub 上 fork 该仓库。
- 创建新功能或修复错误的分支:
git checkout -b my-feature-branch
- 提交更改,使用清晰简洁的消息描述更改内容。
- 将你的分支推送到 forked 仓库:
git push origin my-feature-branch
- 打开到主仓库的 pull request,并详细说明你的更改。
有关更多细节,请参阅 CONTRIBUTING.md 文件。
📄 许可证
此项目根据 MIT License 授权。有关详细信息,请参阅 LICENSE 文件。
微信扫一扫