MCP 服务器

MCP Harbor

一个 Node.js 应用程序，提供模型上下文协议 (Model Context Protocol) 服务器，用于与 Harbor 容器镜像仓库交互，支持项目、仓库、标签和 Helm Chart 的操作。

README

MCP Harbor

MCP Harbor 是一个 Node.js 应用程序，它提供了一个模型上下文协议 (MCP) 服务器，用于与 Harbor 容器镜像仓库进行交互。

特性

MCP 服务器: 通过模型上下文协议暴露与 Harbor 交互的工具
Harbor 操作: 支持项目、仓库、标签和 Helm chart 的操作
TypeScript: 使用 TypeScript 编写，以获得更好的类型安全性和开发者体验
自动化测试: 包含全面的测试套件，以保证功能的可靠性

前提条件

在安装 MCP Harbor 之前，请确保您已具备以下条件：

Node.js 18.x 或更高版本
npm 8.x 或更高版本
可以访问 Harbor 镜像仓库实例
Git (用于克隆仓库)

安装

克隆仓库：

git clone https://github.com/nomagicln/mcp-harbor.git

导航到项目目录：
```
cd mcp-harbor
```
安装依赖项：
```
npm install
```
构建项目：
```
npm run build
```

使用

命令行参数

该应用程序接受以下命令行参数：

Options:
  --url       Harbor API URL                     [string] [required]
  --username  Harbor 用户名                    [string] [required]
  --password  Harbor 密码                    [string] [required]
  --debug     启用调试模式          [boolean] [default: false]
  --help      显示帮助                                  [boolean]

环境变量

除了命令行参数，您还可以使用环境变量。在根目录中创建一个 .env 文件：

# Harbor API 配置
HARBOR_URL=https://harbor.example.com
HARBOR_USERNAME=admin
HARBOR_PASSWORD=Harbor12345

# 调试模式 (true/false)
DEBUG=false

MCP 工具

MCP 服务器暴露了以下工具：

工具名称	描述	参数
`list_projects`	列出 Harbor 中的所有项目	无
`get_project`	按 ID 获取项目详细信息	`projectId: string`
`create_project`	创建一个新项目	`project_name: string, metadata?: object`
`delete_project`	删除一个项目	`projectId: string`
`list_repositories`	列出项目中的仓库	`projectId: string`
`delete_repository`	删除一个仓库	`projectId: string, repositoryName: string`
`list_tags`	列出仓库中的标签	`projectId: string, repositoryName: string`
`delete_tag`	删除一个标签	`projectId: string, repositoryName: string, tag: string`
`list_charts`	列出 Helm charts	`projectId: string`
`list_chart_versions`	列出 chart 版本	`projectId: string, chartName: string`
`delete_chart`	删除 chart 版本	`projectId: string, chartName: string, version: string`

开发

在开发模式下运行

npm run dev

运行测试

# 运行所有测试
npm test

# 运行带有覆盖率的测试
npm run test:coverage

项目结构

mcp-harbor
├── src
│   ├── app.ts                 # 主应用程序入口点 (MCP 服务器)
│   ├── definitions
│   │   └── tool.definitions.ts # MCP 的工具定义
│   ├── services
│   │   └── harbor.service.ts  # Harbor 服务实现
│   └── types
│       └── index.ts           # TypeScript 类型定义
├── test
│   └── harbor.test.ts         # Harbor 服务的测试
├── .env.example              # 示例环境变量
├── .gitignore               # Git 忽略文件
├── .eslintrc.json           # ESLint 配置
├── package.json            # 项目依赖项
├── jest.config.js           # Jest 配置
├── tsconfig.test.json      # 用于测试的 TypeScript 配置
├── tsconfig.json          # TypeScript 配置
├── LICENSE                # 项目许可证
└── README.md             # 项目文档

故障排除

常见问题

连接失败
```
Error: Unable to connect to Harbor instance
```
- 验证 HARBOR_URL 是否正确且可访问
- 检查网络连接
- 确保 Harbor 实例正在运行
身份验证失败
```
Error: Invalid credentials
```
- 验证 HARBOR_USERNAME 和 HARBOR_PASSWORD 是否正确
- 检查用户是否具有所需的权限
构建错误
```
Error: TypeScript compilation failed
```
- 运行 npm install 以确保已安装所有依赖项
- 检查 TypeScript 版本兼容性
- 清除 dist 目录并重新构建