Getting Started

Quick Start Guide

Get up and running with MegaClaw V5 in under 5 minutes. Connect your first service and execute your first task via UI, REST API, or MCP Server.

ℹ️

MegaClaw is multi-tenant. Each company has its own isolated database, credentials, and API key. Your admin will provide your login URL.

Prerequisites

Before you begin, make sure you have:

✓ A MegaClaw account (contact your Super Admin)
✓ Your tenant URL (e.g. drx.megaclaw.de)
✓ Your API key if using REST (format: mc_xxxx)

🤖🔌

New: MCP Server Support — Claude Desktop, Claude Code, or any MCP-compatible AI can now connect directly to MegaClaw. Use endpoint mcp://mcp.megaclaw.de/mcp

Step 1 — Log in & explore

1

Open your tenant URL

Navigate to your company's MegaClaw URL and log in with your username and password. Demo: demo / demo123
2

Choose your language

MegaClaw supports English 🇬🇧, German 🇩🇪, Arabic 🇸🇦, and French 🇫🇷 — select from the top navigation bar.
3

Go to Integrations

Click Integrations in the sidebar. This is where you connect your external services.

Step 2 — Add an integration

Click + New Integration and describe what you want to connect in plain language:

Example prompt

Connect to Proxmox VE API using API Token authentication
Host: 192.168.1.50
Port: 8006
Node: pve

The AI detects the service type, asks for credentials, and saves the integration automatically.

Step 3 — Run a task

Select your integration from the list, choose a task, and hit Run ▶. Or use the REST API or MCP Server:

bash (REST API)

# Run node_status on Proxmox
curl https://api.megaclaw.de/task/run \
  -X POST \
  -H "X-API-Key: mc_your_key" \
  -H "Content-Type: application/json" \
  -d '{"service_id":1,"task_id":"node_status","inputs":{}}'

MCP Server (Claude)

# Configure Claude Desktop with:
{
  "mcpServers": {
    "megaclaw": {
      "url": "mcp://mcp.megaclaw.de/mcp",
      "headers": {
        "X-API-Key": "mc_your_key"
      }
    }
  }
}

# Then ask Claude: "Show me Proxmox node status"

What's next?

→ Explore the full API Reference
→ Browse available integrations
→ Understand the token system & dashboard

Next → API Reference

Developer

API Reference

Full REST API + MCP Server documentation. Base URL: https://api.megaclaw.de · MCP: mcp://mcp.megaclaw.de/mcp

Authentication

All requests must include your API key in the X-API-Key header.

Header

X-API-Key: mc_your_api_key_here

⚠️

API keys are scoped to a single tenant. A key for drx cannot access data from sva.

Rate Limits

requests/min per API key

100

requests/min per IP

When rate limit is exceeded, API returns 429 Too Many Requests. Retry after the specified time.

Endpoints

GET /integrations

Returns all connected services for the authenticated tenant.

Response

[{
  "id": 1,
  "service_name": "proxmox_ve_api_connection",
  "service_type": "proxmox",
  "description": "Connect to Proxmox VE REST API..."
}]

POST /task/run

Execute a task on a connected service. AI generates and runs the code automatically.

Request body

Field	Type	Required	Description
service_id	`integer`	✓	ID from `/integrations`
task_id	`string`	✓	Task identifier
inputs	`object`		Additional task inputs

bash

curl https://api.megaclaw.de/task/run \
  -X POST \
  -H "X-API-Key: mc_xxxx" \
  -d '{"service_id":1,"task_id":"node_status","inputs":{}}'

Response

{
  "success": true,
  "output": "CPU: 4.47% · RAM: 61.6% · Uptime: 7 days",
  "error": "",
  "service": "proxmox_ve_api_connection",
  "task": "node_status",
  "tokens_used": 3
}

GET /tokens/balance

Check current token balance for the authenticated tenant.

bash

curl https://api.megaclaw.de/tokens/balance \
  -H "X-API-Key: mc_xxxx"

Response

{
  "balance": 8472,
  "plan": "Pro",
  "monthly_limit": 10000,
  "reset_date": "2026-04-01"
}

GET /tokens/history

Get transaction history for token usage and recharge events.

POST /analyze

Step 1 of the AI pipeline. Analyze a natural language request and get an execution plan.

GET /

Health check. Returns platform status and version. No auth required.

MCP Server Endpoint

MCP mcp://mcp.megaclaw.de/mcp

Model Context Protocol endpoint for Claude Desktop, Claude Code, and MCP-compatible AI clients.

Claude Desktop Config

{
  "mcpServers": {
    "megaclaw": {
      "url": "mcp://mcp.megaclaw.de/mcp",
      "headers": {
        "X-API-Key": "mc_your_api_key"
      }
    }
  }
}

Error Codes

Status	Meaning
401	Missing X-API-Key header
403	Invalid or inactive API key
404	Service or session not found
429	Rate limit exceeded (60/min per key or 100/min per IP)
402	Insufficient tokens — recharge required
500	Internal execution error

← Previous Quick Start

Next → Integrations

Integrations

Integrations Guide

Connect MegaClaw to your existing services. Each integration is added once and reused for unlimited tasks. All credentials are encrypted with AES-256.

🔒

Credentials are encrypted with Fernet AES-256 and never exposed in API responses, logs, or the UI.

🖥️ Proxmox VE

🖥️

Proxmox VE API

service_type: proxmox

Manage VMs, containers, storage, and nodes via the Proxmox REST API with API Token authentication.

Required credentials

Field	Description
proxmox_host	IP of your Proxmox node
proxmox_port	Always `8006`
api_token_id	Format: `user@realm!tokenname`
api_token_secret	Token secret UUID
node	Node name e.g. `pve`

Available tasks

task_id	Description
node_status	CPU, RAM, disk, uptime
list_vms	List all virtual machines
list_containers	List all LXC containers
start_vm / stop_vm	Start or stop a VM by VMID
restart_vm	Restart a VM
clone_vm	Clone a VM to new VMID (requires `source_vmid` and `new_vmid`)
snapshot_vm	Create a snapshot (requires `vmid` and `snapshot_name`)
list_storage	List storage pools
next_vmid	Get next available VMID

🔵 SAP BTP / HANA

🔵

SAP Integration

service_type: http_api

Connect to SAP BTP APIs, SAP HANA on-premise via Cloud Connector, and SAP S/4HANA OData services.

🔄 n8n

🔄

n8n Workflows

service_type: http_api

Trigger and manage n8n workflows. List, execute, and monitor workflow status via REST API.

🐘 PostgreSQL

🐘

PostgreSQL

service_type: sql

Execute SQL queries, manage tables, and retrieve data from PostgreSQL databases.

🔒 SSH / Shell

🔒

SSH Remote Shell

service_type: shell

Execute shell commands on remote Linux servers via SSH. Supports password and key-based auth.

🔍 LinkUp Search

🔍

LinkUp Web Search

service_type: linkup

Real-time web search. Returns structured results with titles, URLs, and summaries.

ServiceNow

🎫

ServiceNow

service_type: http_api

Manage incidents, problems, change requests, and CMDB via natural language.

Field	Value
Instance URL	https://dev12345.service-now.com
Username	Admin username
Password	Admin password

Atlassian / Jira

📋

Atlassian Jira

service_type: http_api

Manage Jira issues and Confluence pages using natural language.

Field	Value
Site URL	https://yourcompany.atlassian.net
Email	Atlassian account email
API Token	From Atlassian security settings

⏰ Task Scheduler

⏰

Task Scheduler

feature_type: scheduler

Create and manage automated tasks using natural language. The scheduler runs workflows automatically at defined times (hourly, daily, custom cron).

🤖 AI Providers (Claude + Ollama)

🤖

AI Provider Selection

feature_type: ai_provider

MegaClaw supports multiple AI backends for different needs:

Provider	Description
Claude	Cloud-based AI with advanced reasoning and high-quality responses
Ollama	Local AI models running on your own infrastructure for full privacy — zero token consumption

💡 Use Cases

💡

Automation Use Cases

feature_type: examples

Real-world examples of how MegaClaw can automate workflows and operations.

Use Case	Description
Reports	Automate daily reports and send via email
Monitoring	System alerts via Telegram notifications
API Automation	Scheduled API calls and data synchronization
Infrastructure	Automated infrastructure tasks on schedule
AI-Powered Workflows	Generate and execute AI-powered workflows via Claude or Ollama

← Previous API Reference

Next → Pricing & Tokens

Billing & Admin

Plans, Tokens & Administration

MegaClaw uses a token-based model. Each AI task execution consumes tokens based on complexity. Choose the plan that fits your workload.

Plans

Starter

^€10

/month

1,000 tokens/month
Up to 5 integrations
REST API + MCP
Email support

Basic

^€40

/month

5,000 tokens/month
Up to 15 integrations
REST API + MCP
Token dashboard

Pro ⭐

^€70

/month

10,000 tokens/month
Unlimited integrations
SAP & Proxmox
Priority support
Email + Telegram alerts

Enterprise

^€300

/month

50,000 tokens/month
Dedicated infrastructure
On-premise deployment
Custom integrations
SLA guarantee
Ollama private AI

Token consumption

Tokens are consumed on each AI task execution. Viewing integrations or listing services is free.

ℹ️

Token costs are estimates. Complex tasks with multi-step execution or auto-retry consume more tokens.

Simple API query~1–3 tokens

Proxmox node status~2–5 tokens

LinkUp web search~3–8 tokens

SSH command~3–10 tokens

Multi-step task~10–30 tokens

SAP Terraform deploy~20–50 tokens

Token Dashboard

Real-time usage tracking available in the Admin Panel:

📊 Current token balance
📈 Transaction history with timestamps
📧 Low-balance email alerts (automatically sent at 20%, 10%, and 5%)
✅ Recharge confirmation emails

📧

Smart Alerts: Automatic emails when balance is low or depleted. Recharge confirmations sent instantly when tokens are added.

API Key Management

Super Admins and Admins can manage API keys from the UI:

🔑 View all tenant API keys
🔄 Revoke compromised keys
✨ Generate new API keys
📝 Audit logging for key actions

Role-Based Access Control

MegaClaw supports four roles with granular permissions:

Role	Permissions
Superadmin	Full system access, manage tenants, add tokens, view all data
Admin	Manage integrations, API keys, users within tenant
User	Execute tasks, view integrations, personal settings
Demo	Read-only access, cannot modify integrations or execute tasks

Managing tokens (Admin)

Super Admins can add tokens from the Admin Panel:

Admin panel

Super Admin → Manage Tenants
→ Select Company → Add Tokens
→ Enter amount + plan → Save

Token history records: amount, plan,
added_by, timestamp

System automatically sends:
- Confirmation email to tenant admin
- Low-balance alerts when threshold reached

FAQ

Can I buy tokens mid-month?

Yes. Contact your administrator or use the Super Admin panel. Unused tokens carry over.

What happens when tokens run out?

Task execution is paused. API calls return 402 Payment Required. Viewing services still works. Email alerts are sent automatically.

Is there a free trial?

New Starter accounts receive 1,000 tokens included. Contact alaa.alswedan@gmail.com to get started.

How do I use MCP with Claude?

Add the MCP server configuration to Claude Desktop. See the API Reference for configuration details.

Can I run AI locally?

Yes! MegaClaw supports Ollama for private, local AI execution with zero token consumption.

← Previous Integrations

Quick Start Guide

Prerequisites

Step 1 — Log in & explore

Open your tenant URL

Choose your language

Go to Integrations

Step 2 — Add an integration

Step 3 — Run a task

What's next?

API Reference

Authentication

Rate Limits

Endpoints

Request body

MCP Server Endpoint

Error Codes

Integrations Guide

🖥️ Proxmox VE

Required credentials

Available tasks

🔵 SAP BTP / HANA

🔄 n8n

🐘 PostgreSQL

🔒 SSH / Shell

🔍 LinkUp Search

ServiceNow

Atlassian / Jira

⏰ Task Scheduler

🤖 AI Providers (Claude + Ollama)

💡 Use Cases

Plans, Tokens & Administration

Plans

Token consumption

Token Dashboard

API Key Management

Role-Based Access Control

Managing tokens (Admin)

FAQ

Can I buy tokens mid-month?

What happens when tokens run out?

Is there a free trial?

How do I use MCP with Claude?

Can I run AI locally?