zerobyte-mcp
by Rhonstin
README.md
# Zerobyte MCP Server
MCP (Model Context Protocol) server for [Zerobyte](https://github.com/nicotsx/zerobyte) backup automation tool.
## Features
- List and manage backup repositories
- View and restore snapshots
- Trigger and manage backup schedules
- Monitor system health
- Manage backup source volumes
## Installation
```bash
npm install zerobyte-mcp
# or
bun add zerobyte-mcp
```
## Configuration
Set environment variables:
```bash
export ZEROBYTE_URL=http://localhost:4096
export ZEROBYTE_TOKEN=your-api-token
```
## Usage with Claude Desktop
Add to your `claude_desktop_config.json`:
```json
{
"mcpServers": {
"zerobyte": {
"command": "node",
"args": ["/path/to/zerobyte-mcp/dist/index.js"],
"env": {
"ZEROBYTE_URL": "http://your-zerobyte:4096",
"ZEROBYTE_TOKEN": "your-token"
}
}
}
}
```
## Usage with Cursor / VS Code
Add to your MCP configuration:
```json
{
"mcp": {
"servers": {
"zerobyte": {
"command": "node",
"args": ["./dist/index.js"],
"env": {
"ZEROBYTE_URL": "http://localhost:4096",
"ZEROBYTE_TOKEN": "xxx"
}
}
}
}
}
```
## Available Tools
| Tool | Description |
|------|-------------|
| `list_repositories` | List all backup repositories |
| `get_repository` | Get repository details + stats |
| `list_snapshots` | List snapshots in repository |
| `get_snapshot` | Get snapshot details |
| `restore_snapshot` | Restore from snapshot |
| `delete_snapshot` | Delete a snapshot |
| `list_backup_schedules` | List all backup jobs |
| `trigger_backup` | Manually start backup |
| `delete_backup_schedule` | Delete a backup schedule |
| `list_volumes` | List backup sources |
| `get_volume` | Get volume details |
| `delete_volume` | Delete a volume |
| `get_system_info` | System health & status |
| `check_health` | Check API connectivity |
## Development
```bash
# Install dependencies
bun install
# Run in development mode
bun run dev
# Build for production
bun run build
```
## License
MIT
This server cannot be deployed
Maintenance
ActivityInactive
ResponsivenessNo issues