# xns-cloud/relayer-mcp [Health: Active]

**Category:** ☁️ Cloud Platforms  
**Repository:** https://github.com/xns-cloud/relayer-mcp  
**GitHub Stars:** 3  
**npm Downloads (last month):** 935  
**Views:** 0  
**Installs:** 0  
**Upvotes:** 0  
**Directory Page:** https://allmcps.com/mcp/xns-cloud-relayer-mcp

## Description
Install and manage a self-hosted XNS Relayer, S3-compatible object storage on a decentralized provider network: setup, health, configuration and backups.

## Claude Desktop Quick Installation
Install path detected from listing signals. Uses `npx` (confidence: high):

```json
"mcpServers": {
  "relayer-mcp": {
    "command": "npx",
    "args": ["@xns-cloud/relayer-mcp@latest"]
  }
}
```

## Documentation

## What xns-cloud/relayer-mcp MCP server does

The xns-cloud/relayer-mcp MCP server gives an AI agent a structured interface to set up and operate XNS Relayer, which provides S3-compatible object storage on a decentralized provider network. Its 15 tools cover the installation flow and selected ongoing administration rather than exposing an unrestricted shell or the full Relayer configuration catalog.

The onboarding sequence checks the host, provides browser URLs for account registration and claim confirmation, waits for email verification, installs the Relayer containers, checks service health, configures host selection, and verifies an S3 round trip. Operators still complete the browser-based account, email, and claim actions.

After onboarding, the server supports selected settings changes, service restarts, CLI credential setup, and configuration backup operations. Restore and restart actions are disruptive or destructive and are identified as such in the tool behavior.

## How it works

The server communicates with the MCP client over stdio. It uses Docker on the same machine to run the Relayer and its monitoring components. The installation tool retrieves the canonical release compose file and environment file, adds the required ports, and starts the containers. If either release file cannot be fetched, it can use a bundled service-parity copy. A custom compose URL can be supplied for custom installations.

Prerequisite checks cover Docker, the Compose plugin, Docker socket access, ports 8888, 9000, and 9443, disk space, network access, and existing installations. Health polling checks the user interface, S3 gateway, HostIO, and monitoring sidecars. A missing monitoring stack is reported as degraded rather than preventing the main flow.

Authentication-sensitive steps use browser URLs and OIDC sessions. S3 verification creates a temporary scoped IAM credential, performs bucket and object operations, then attempts cleanup. The tool reports a cleanup warning if it cannot remove a test resource.

## Setup and configuration

On Ubuntu 24.04 or Debian 12, the supplied installation script installs Docker Engine and its Compose plugin, starts the Relayer under `/opt/xns-relayer`, and waits for the dashboard on port 8888. It can also install Node.js 20 when Claude Code is present and register the MCP. Users must log out and back in for Docker group membership changes to take effect.

Without the script, the host needs Node.js 20 or newer and Docker Engine. The Docker daemon must be local to the machine running the MCP; remote Docker hosts are refused by `install_relayer`. macOS and Windows users are directed to Docker Desktop, but the script does not install software there.

Register the package with an MCP client using `npx @xns-cloud/relayer-mcp@latest`. Claude Code, Claude Desktop, and Cursor configurations are documented. A persistent Docker host is important because containers and their Docker volume data can be lost in sandboxes, CI runners, or temporary virtual machines.

## Tools and capabilities

The tool set includes:

- Checking prerequisites and existing installations.
- Starting registration and claim sessions, then polling their status.
- Reading host tags and applying VPD data/parity selections, with optional dry-run previews.
- Installing the Relayer and monitoring stack, then checking recovery and health.
- Testing S3 storage and provisioning CLI credentials in `~/.xns/credentials`.
- Reviewing and changing a curated set of worker, concurrency, backup schedule, and cost-center settings.
- Restarting individual services or all services.
- Listing, creating, restoring, and deleting configuration backups, with selective restore components.

The `update_settings` operation requires relayer-ui version 3.43.3 or newer. Installation is for fresh deployments only and does not upgrade an existing deployment in place.

_Full upstream README: https://allmcps.com/mcp/xns-cloud-relayer-mcp/readme_