vyliox-mcp

v0.0.1

Published

17 days ago

Vyliox MCP Server — Zero-touch deployment PaaS for AI agents via Model Context Protocol

0High
0Medium
0Low

vyliox

mcp model-context-protocol vyliox deployment paas ai-agent claude cursor

Vyliox MCP Server

Zero-touch deployment PaaS for AI agents via Model Context Protocol.

The Vyliox MCP Server lets AI agents — Claude, GPT-5, Gemini, Cursor, Windsurf, VS Code, JetBrains AI — deploy and manage sites on Vyliox directly through the MCP standard. It translates MCP tool calls over stdin/stdout into HTTP requests to the Vyliox API.

🆕 What's New in v2.0

Vyliox MCP v2.0 adds MCP Resources and Prompts — the biggest differentiator from v1.0:

| Feature | v1.0 | v2.0 | |---------|:----:|:----:| | Tools | 6 deployment & management tools | 18 tools — full PaaS lifecycle management | | Resources | — | 3 resource URIs (vyliox://sites, site detail, file tree) | | Prompts | — | 4 prompt templates (deploy-static, deploy-nextjs, deploy-github, debug-deploy) | | Validation | Basic server-side only | Client-side Zod validation on all 18 tools | | Schemas | JSON Schema only | Zod + JSON Schema dual validation |

Installation

Global install (recommended)

npm install -g vyliox-mcp

Run on-demand with npx

npx vyliox-mcp@latest

Requires Node.js >= 18 (uses built-in fetch).

Configuration

Set your Vyliox API key as an environment variable:

export VYLIOX_API_KEY="your-api-key-here"

Get your API key at https://vyliox.live/settings.

| Mode | VYLIOX_API_KEY | Deploy Tools | Management Tools | |------|:-----------------:|:------------:|:----------------:| | Authenticated | ✅ Set | ✅ | ✅ | | Anonymous | ❌ Not set | ✅ | ❌ (clear error returned) |

MCP Client Configuration

Claude Desktop

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "vyliox": {
      "command": "npx",
      "args": ["-y", "vyliox-mcp@latest"],
      "env": {
        "VYLIOX_API_KEY": "your-api-key-here"
      }
    }
  }
}

Cursor

Add to .cursor/mcp.json in your project root:

{
  "mcpServers": {
    "vyliox": {
      "command": "npx",
      "args": ["-y", "vyliox-mcp@latest"],
      "env": {
        "VYLIOX_API_KEY": "your-api-key-here"
      }
    }
  }
}

Windsurf

Add to your windsurf_config.json:

{
  "mcpServers": {
    "vyliox": {
      "command": "npx",
      "args": ["-y", "vyliox-mcp@latest"],
      "env": {
        "VYLIOX_API_KEY": "your-api-key-here"
      }
    }
  }
}

VS Code / Cline / Roo Code

In your MCP settings (.vscode/mcp.json or Cline/Roo settings):

{
  "mcpServers": {
    "vyliox": {
      "command": "npx",
      "args": ["-y", "vyliox-mcp@latest"],
      "env": {
        "VYLIOX_API_KEY": "your-api-key-here"
      }
    }
  }
}

Tools Reference

1. `vyliox_deploy_files`

Deploy static or dynamic files directly to Vyliox Edge.

| Parameter | Type | Required | Description | |-----------|------|:--------:|-------------| | files | array | ✅ | Array of {path, content} objects | | slug | string | ❌ | Custom URL slug (e.g., my-app → my-app.vyliox.live) |

Example input:

{
  "files": [
    { "path": "index.html", "content": "<!DOCTYPE html><html>..." },
    { "path": "style.css", "content": "body { margin: 0; }" }
  ],
  "slug": "my-landing-page"
}

Example response:

{
  "slug": "my-landing-page",
  "url": "https://my-landing-page.vyliox.live",
  "type": "static",
  "message": "Deployment successful"
}

2. `vyliox_deploy_github`

Deploy a public GitHub repository. The server clones, builds, and hosts automatically.

| Parameter | Type | Required | Description | |-----------|------|:--------:|-------------| | repoUrl | string | ✅ | GitHub repository URL | | slug | string | ❌ | Custom URL slug | | isDynamic | boolean | ❌ | Force Node.js/dynamic mode (auto-detected if omitted) |

Example input:

{
  "repoUrl": "https://github.com/user/my-portfolio",
  "isDynamic": false
}

Example response:

{
  "slug": "cozy-frog-123",
  "url": "https://cozy-frog-123.vyliox.live",
  "type": "static",
  "message": "Repository cloned and deployed"
}

3. `vyliox_list_sites`

List all your deployed sites with their status, URLs, and types.

🔒 Requires authentication (VYLIOX_API_KEY)

| Parameter | Type | Required | Description | |-----------|------|:--------:|-------------| | (none) | — | — | — |

Example response:

[
  {
    "slug": "cozy-frog-123",
    "type": "static",
    "port": null,
    "created_at": "2026-05-13T12:00:00.000Z",
    "status": "online",
    "url": "https://cozy-frog-123.vyliox.live"
  },
  {
    "slug": "neon-kiwi-456",
    "type": "dynamic",
    "port": 9001,
    "created_at": "2026-05-12T08:30:00.000Z",
    "status": "online",
    "url": "https://neon-kiwi-456.vyliox.live"
  }
]

4. `vyliox_delete_site`

Permanently delete a deployed site by its slug.

🔒 Requires authentication (VYLIOX_API_KEY)

| Parameter | Type | Required | Description | |-----------|------|:--------:|-------------| | slug | string | ✅ | The site slug to delete |

Example input:

{
  "slug": "cozy-frog-123"
}

Example response:

{
  "message": "Site 'cozy-frog-123' deleted successfully"
}

5. `vyliox_get_logs`

Retrieve build logs for a deployed site. Useful for debugging failed deployments.

🔒 Requires authentication (VYLIOX_API_KEY)

| Parameter | Type | Required | Description | |-----------|------|:--------:|-------------| | slug | string | ✅ | The site slug to get logs for | | tail | number | ❌ | Return only the last N lines |

Example input:

{
  "slug": "cozy-frog-123",
  "tail": 50
}

Example response:

{
  "slug": "cozy-frog-123",
  "logs": "[2026-05-13T12:00:00] Cloning repository...\n[2026-05-13T12:00:05] Installing dependencies...\n[2026-05-13T12:00:15] Build complete\n[2026-05-13T12:00:16] Site deployed successfully"
}

6. `vyliox_site_status`

Check the deployment status of any site (online, building, or error).

🌐 Public endpoint — no authentication required

| Parameter | Type | Required | Description | |-----------|------|:--------:|-------------| | slug | string | ✅ | The site slug to check status for |

Example input:

{
  "slug": "cozy-frog-123"
}

Example response:

{
  "slug": "cozy-frog-123",
  "status": "online",
  "type": "static",
  "url": "https://cozy-frog-123.vyliox.live"
}

7. `vyliox_claim_site` 🆕

Claim an anonymous deployment to your account using the claim token. Makes the site permanent and prevents auto-deletion after 72 hours.

🔒 Requires authentication (VYLIOX_API_KEY)

| Parameter | Type | Required | Description | |-----------|------|:--------:|-------------| | token | string | ✅ | Claim token received from the deploy response |

Example input:

{
  "token": "claim_abc123xyz"
}

Example response:

{
  "message": "Site claimed successfully",
  "slug": "cozy-frog-123"
}

MCP Resources 🆕

Vyliox MCP v2.0 exposes 3 resource URIs that allow AI agents to browse deployments like a filesystem.

| URI | Description | Auth Required | |-----|-------------|:-------------:| | vyliox://sites | List of all your Vyliox deployments | ✅ | | vyliox://sites/{slug} | Metadata for a specific site (type, status, URL, created date, size) | ✅ | | vyliox://sites/{slug}/files | File tree of a deployed site | ✅ |

Resources are read via the resources/read MCP method. The VYLIOX_API_KEY environment variable must be set for all resource reads.

MCP Prompts 🆕

Vyliox MCP v2.0 provides 4 prompt templates that guide AI agents through deployment workflows:

| Prompt Name | Description | Argument | |-------------|-------------|----------| | vyliox/deploy-static | Step-by-step guide for deploying static HTML/CSS/JS sites | projectName (required) | | vyliox/deploy-nextjs | Guide for deploying Next.js apps with build configuration | projectName (required) | | vyliox/deploy-github | Guide for deploying from GitHub repositories | repoUrl (optional) | | vyliox/debug-deploy | Systematic troubleshooting guide for failed deployments | slug (optional) |

Prompts are invoked via the prompts/get MCP method. Each prompt returns structured messages that instruct the AI agent on the exact deployment steps, tool calls, and best practices.

How It Works

┌──────────────┐     stdio (MCP)     ┌────────────────┐     HTTP/HTTPS     ┌─────────────────┐
│  AI Agent    │ ◄──────────────────► │  vyliox-mcp    │ ◄───────────────► │  api.vyliox.live │
│  (Claude,    │    JSON-RPC 2.0     │  (this pkg)    │   REST + JSON     │  (Vyliox API)    │
│   Cursor,    │                     │                │                   │                 │
│   etc.)      │                     │                │                   │                 │
└──────────────┘                     └────────────────┘                   └─────────────────┘

The AI agent sends an MCP tool call over stdin/stdout (JSON-RPC 2.0)
vyliox-mcp translates it into an HTTP request to the Vyliox API
The Vyliox API processes the request and returns a JSON response
vyliox-mcp wraps the response in MCP format and sends it back to the agent

Authentication Modes

Authenticated (Recommended)

Set VYLIOX_API_KEY to your API key from https://vyliox.live/settings. All 7 tools work, including site management (list, delete, logs, claim).

Anonymous

Leave VYLIOX_API_KEY unset. Deploy tools (vyliox_deploy_files, vyliox_deploy_github) and vyliox_site_status still work. Management tools return a clear error directing you to set the API key.

Error Handling

All errors are returned as structured JSON:

{
  "error": "Descriptive error message"
}

Network errors, HTTP errors (4xx/5xx), and JSON parse failures are all caught and returned in this format. Internal errors are logged to stderr (so they don't interfere with the MCP stdio protocol).

Development

# Clone and install
git clone https://github.com/vyliox/vyliox-mcp.git
cd vyliox-mcp
npm install

# Run locally
node bin/index.js

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Vyliox MCP Server

🆕 What's New in v2.0

Installation

Global install (recommended)

Run on-demand with npx

Configuration

MCP Client Configuration

Claude Desktop

Cursor

Windsurf

VS Code / Cline / Roo Code

Tools Reference

1. vyliox_deploy_files

2. vyliox_deploy_github

3. vyliox_list_sites

4. vyliox_delete_site

5. vyliox_get_logs

6. vyliox_site_status

7. vyliox_claim_site 🆕

MCP Resources 🆕

MCP Prompts 🆕

How It Works

Authentication Modes

Authenticated (Recommended)

Anonymous

Error Handling

Development

License

1. `vyliox_deploy_files`

2. `vyliox_deploy_github`

3. `vyliox_list_sites`

4. `vyliox_delete_site`

5. `vyliox_get_logs`

6. `vyliox_site_status`

7. `vyliox_claim_site` 🆕