MCP Harbor

🚀 MCP Harbor Terminal

MCP Harbor Terminal is a Node.js-based application that provides a Model Context Protocol (MCP) server for interacting with the Harbor container registry.

🚀 Quick Start

MCP Harbor Terminal offers a seamless way to interact with Harbor container registry through the MCP protocol. It simplifies the management of container images, including uploading, downloading, and error handling.

✨ Features

• Provides an MCP protocol interface for interacting with the Harbor registry.
• Supports uploading, downloading, and managing container images.
• Offers detailed error handling and logging.

📦 Installation

1. Clone the repository:

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

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

💻 Usage Examples

Basic Usage

Run the server:

npm start

Advanced Usage

Run with debug mode:

npm start -- --debug

Set the following environment variables to configure the application:

• HARBOR_URL: The URL of the Harbor registry, default is http://localhost:80
• HARBOR_USERNAME: The Harbor username
• HARBOR_PASSWORD: The Harbor password
• DEBUG: Enable debug mode, set the value to true

Example:

export HARBOR_URL=http://harbor.example.com
export HARBOR_USERNAME=admin
export HARBOR_PASSWORD=secret

📚 Documentation

Project Structure

mcp-harbor
├── src
│   ├── app.ts                 # Application main entry (MCP server)
│   ├── definitions
│   │   └── tool.definitions.ts # Tool definition file (MCP)
│   ├── services
│   │   └── harbor.service.ts  # Harbor service implementation
│   └── types
│       └── index.ts           # TypeScript type definitions
├── test
│   └── harbor.test.ts         # Test cases (Harbor service)
├── .env.example              # Example file for environment variables
├── .gitignore               # Git ignore file
├── .eslintrc.json           # ESLint configuration
├── package.json            # Project dependency management
├── jest.config.js           # Jest test framework configuration
├── tsconfig.test.json      # TypeScript test configuration
├── tsconfig.json          # TypeScript main configuration
├── LICENSE                # Project license
└── README.md             # Project documentation

Troubleshooting

Common Issues

1. Connection Failure

   Error: Unable to connect to the Harbor instance
   

   • Check if HARBOR_URL is correct and accessible.
   • Ensure network connectivity.
   • Verify that the Harbor instance is running.

2. Authentication Failure

   Error: Invalid credentials
   

   • Check if HARBOR_USERNAME and HARBOR_PASSWORD are correct.
   • Ensure the user has the required permissions.

3. Build Error

   Error: TypeScript compilation failed
   

   • Run npm install to ensure all dependencies are installed.
   • Check if the TypeScript version is compatible.
   • Clear the dist directory and rebuild.

Debug Mode

Enable debug mode:

--debug

Or set the environment variable:

DEBUG=true

Support

For assistance, refer to the application logs.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.