使用说明

ispconfig-mcp

MCP (Model Context Protocol) server for ISPConfig 3 — manage DNS zones, mail domains, websites, databases, FTP users, cron jobs, and more through AI assistants like Claude.

Features

DNS Management — zones, A/AAAA/CNAME/MX/NS/TXT/SRV/PTR records
Mail Management — domains, mailboxes, aliases, forwards, catchall, spamfilter
Site Management — web domains, subdomains, alias domains
Database Management — create/delete MySQL databases
FTP & Shell Users — create and manage access accounts
Cron Jobs — schedule and manage cron tasks
Client Management — create/update/delete ISPConfig clients
Server Info — query server details by ID or IP
Generic API Call — escape hatch for any of the ~246 ISPConfig API methods
Server Migration — export/import DNS zones, mail domains, websites, databases between ISPConfig instances

Prerequisites

Node.js 18+
An ISPConfig 3 installation with the Remote API enabled
API user credentials (ISPConfig → System → Remote Users)

Installation

# Via npx (no install needed)
npx ispconfig-mcp

# Or install globally
npm install -g ispconfig-mcp

Configuration

Claude Code

claude mcp add ispconfig -- npx ispconfig-mcp

Then set environment variables in your shell or .env:

export ISPCONFIG_URL="https://your-server:8080"
export ISPCONFIG_USER="api_user"
export ISPCONFIG_PASSWORD="your_password"
# Optional: run without any create/update/delete/import tools
export ISPCONFIG_READONLY="true"
# Optional (NOT recommended): skip TLS verification for self-signed certs.
# Only affects this server's own connection, but you should use a valid
# certificate instead — credentials are sent over this connection.
# export ISPCONFIG_INSECURE="true"

Claude Desktop / Cursor / Windsurf

Add to your MCP config file:

{
  "mcpServers": {
    "ispconfig": {
      "command": "npx",
      "args": ["-y", "ispconfig-mcp"],
      "env": {
        "ISPCONFIG_URL": "https://your-server:8080",
        "ISPCONFIG_USER": "api_user",
        "ISPCONFIG_PASSWORD": "your_password"
      }
    }
  }
}

ISPConfig Setup

Log into ISPConfig panel → System → Remote Users
Create a new remote user with API access
Grant only the functions this integration needs — do not grant all. The api_call escape hatch and the write tools can only reach methods this remote user is permitted to use, so a narrow permission set is your main guardrail. Combine with ISPCONFIG_READONLY=true for read-only use.
Use these credentials as ISPCONFIG_USER / ISPCONFIG_PASSWORD

Available Tools

DNS

Tool	Description
`dns_zone_list`	List all DNS zones
`dns_zone_get`	Get zone details by ID
`dns_zone_add`	Create a new zone
`dns_zone_update`	Update zone settings
`dns_zone_delete`	Delete a zone
`dns_record_get`	Get a record by type and ID
`dns_record_add`	Add a DNS record (A, AAAA, CNAME, MX, TXT, etc.)
`dns_record_update`	Update a DNS record
`dns_record_delete`	Delete a DNS record

Mail

Tool	Description
`mail_domain_list`	List all mail domains
`mail_domain_get`	Get mail domain details
`mail_domain_add`	Create a mail domain
`mail_domain_delete`	Delete a mail domain
`mail_user_get`	Get mailbox details
`mail_user_add`	Create a mailbox
`mail_user_update`	Update mailbox settings
`mail_user_delete`	Delete a mailbox
`mail_alias_add`	Create a mail alias
`mail_alias_delete`	Delete a mail alias
`mail_forward_add`	Create a mail forward
`mail_forward_delete`	Delete a mail forward
`mail_catchall_add`	Create a catchall
`mail_spamfilter_whitelist_add`	Add to spamfilter whitelist
`mail_spamfilter_blacklist_add`	Add to spamfilter blacklist

Sites & Hosting

Tool	Description
`web_domain_list`	List all websites
`web_domain_get`	Get website details
`web_domain_add`	Create a website
`web_domain_update`	Update website settings
`web_domain_delete`	Delete a website
`web_subdomain_add`	Create a subdomain
`web_subdomain_delete`	Delete a subdomain
`web_aliasdomain_add`	Create an alias domain
`ftp_user_list`	List FTP users
`ftp_user_add`	Create an FTP user
`ftp_user_update`	Update FTP user
`ftp_user_delete`	Delete an FTP user
`shell_user_add`	Create a shell user
`shell_user_delete`	Delete a shell user
`database_list`	List databases
`database_add`	Create a database
`database_delete`	Delete a database
`cron_list`	List cron jobs
`cron_add`	Create a cron job
`cron_update`	Update a cron job
`cron_delete`	Delete a cron job

Admin

Tool	Description
`client_get`	Get client details
`client_add`	Create a client
`client_update`	Update a client
`client_delete`	Delete a client
`server_get`	Get server info
`server_get_by_ip`	Find server by IP
`api_call`	Call any ISPConfig API method directly

Migration

Tool	Description
`migrate_plan`	Inventory all DNS/mail/sites on source — dry run, no changes
`migrate_export_dns_zone`	Export a DNS zone + all records as JSON bundle
`migrate_export_mail_domain`	Export a mail domain + mailboxes/aliases/forwards as JSON
`migrate_export_web_domain`	Export a website + FTP/shell users/databases/cron as JSON
`migrate_export_client`	Export a client account + associated domains as JSON
`migrate_import_dns_zone`	Import a DNS zone bundle into destination instance
`migrate_import_mail_domain`	Import a mail domain bundle (config only — rsync maildir separately)
`migrate_import_web_domain`	Import a website bundle (config only — rsync files separately)
`migrate_data_commands`	Generate rsync/mysqldump commands for actual data transfer

Migration Between Servers

The MCP supports migrating accounts between ISPConfig instances. The workflow:

Plan — migrate_plan inventories everything on the source
Export — migrate_export_* dumps config as portable JSON bundles
Import — migrate_import_* recreates config on the destination
Data — migrate_data_commands generates rsync/mysqldump commands for actual files/mail/databases

Migration Config

For direct source→destination migration, configure both instances:

{
  "mcpServers": {
    "ispconfig": {
      "command": "npx",
      "args": ["-y", "ispconfig-mcp"],
      "env": {
        "ISPCONFIG_URL": "https://old-server:8080",
        "ISPCONFIG_USER": "api_user",
        "ISPCONFIG_PASSWORD": "password",
        "ISPCONFIG_DEST_URL": "https://new-server:8080",
        "ISPCONFIG_DEST_USER": "api_user",
        "ISPCONFIG_DEST_PASSWORD": "password"
      }
    }
  }
}

Without ISPCONFIG_DEST_URL, export tools still work — you can save the JSON and import later.

What gets migrated (config)

DNS zones + all record types
Mail domains + mailboxes + aliases + forwards + catchall
Web domains + subdomains + alias domains
FTP and shell users
Database definitions
Cron jobs
Client accounts

What needs manual transfer (data)

The ISPConfig API manages configuration, not file data. These must be transferred separately:

Mail spools — rsync /var/vmail/domain/
Website files — rsync /var/www/domain/
Database content — mysqldump / pg_dump

The migrate_data_commands tool generates the exact commands needed.

Example Prompts

Once connected, you can ask your AI assistant things like:

"List all DNS zones on my server"
"Add an A record for app.example.com pointing to 1.2.3.4"
"Create a mailbox info@example.com with 1GB quota"
"Add a mail forward from sales@example.com to team@example.com"
"Show me all websites and their domains"
"Create a cron job that runs /usr/local/bin/backup.sh every night at 2am"
"Find all zones missing SPF records"
"Export everything from the old server and show me a migration plan"
"Migrate the DNS zone for example.com to the new server"
"What rsync commands do I need to transfer mail data for example.com?"

Development

git clone https://github.com/DayZAnder/ispconfig-mcp.git
cd ispconfig-mcp
npm install
npm run build

License

BSD 3-Clause — same license as ISPConfig 3.