Command Palette

Search for a command to run...

UnylyUnyly
Browse all

Pterodactyl Panel

FreeNot checked

MCP server inside the Pterodactyl panel (v2 extension): let Claude, ChatGPT or Cursor manage servers, files, consoles and schedules as you, over OAuth 2.1.

GitHubEmbed

About

MCP server inside the Pterodactyl panel (v2 extension): let Claude, ChatGPT or Cursor manage servers, files, consoles and schedules as you, over OAuth 2.1.

README

Panel MCP: let AI assistants run your Pterodactyl servers, as you

Latest release Pterodactyl v2 MCP PHP 8.3+ MIT license

Panel MCP is a Pterodactyl Panel extension that puts an MCP server inside your panel.
Connect Claude, ChatGPT, Cursor or any MCP client with your normal panel sign-in, and let it read consoles,
edit configs, restart servers and manage schedules, with exactly the permissions your account already has.

Install · Connect a client · Tools · Security · Configuration · Extend it


✨ Why

Running game servers means a lot of small, careful jobs: "why did the lobby crash at 3am?", "bump view-distance on survival and restart it after the countdown", "which plugin is spamming this error?". Panel MCP lets an AI assistant do those jobs through your panel, not around it:

  • No API keys to paste anywhere. The client signs in with OAuth 2.1, the same way you sign in to the panel (password, 2FA, passkeys), and you pick what it may do on a consent screen.
  • Never more than you. Every tool checks the same panel permission as the matching API endpoint. A subuser with console-only access gets console-only tools.
  • Everything on the record. Each action lands in the panel's activity log once, as you, under the panel's own event names. It reads exactly like your own clicks.
  • One click to cut it off. Account → Connected Apps lists every app with its access and last use. Remove one and its tokens die instantly.
  • Runs in the panel process. No extra service, port, container or database: install the extension and add the URL to your client.

The consent screen: Connect Claude? with Read, Control and Change files checkboxes   Connected apps page listing Claude, ChatGPT and Cursor with their access and last use

🧭 How it works

AI client connects, the user signs in and approves scopes, gets OAuth tokens, then calls tools on /mcp which check scope and panel permission and run the panel's own actions against Wings

  1. Your MCP client finds the authorization server through /.well-known/oauth-protected-resource and registers itself (dynamic client registration).
  2. You sign in to the panel and approve the connection on a consent page that shows where you will be sent back to and lets you choose Read, Control and Change files and settings.
  3. The client receives an access token (1 hour) and a rotating refresh token (30 days) and calls tools on /mcp (Streamable HTTP, JSON responses).
  4. Each tool call is checked against the scopes you granted and your panel permissions, then runs through the panel's own action classes, so anything that hooks those actions (other extensions, activity logging) sees MCP calls too.

📦 Install

[!IMPORTANT] Panel MCP is an extension for Pterodactyl Panel v2 (the 2.0-develop branch and its extension SDK). It does not run on 1.x.

From a release (recommended). Download panel-mcp.pteroext from the latest release, then on the panel host:

cd /var/www/pterodactyl
php artisan p:extension:install /path/to/panel-mcp.pteroext --enable

That runs the extension's migration (four ext_panel_mcp_oauth_* tables) and publishes its frontend. Reload the panel in your browser.

From source. Build it against your panel's SDK (from a panel checkout where npm ci && npm run build has run):

git clone https://github.com/jackh54/pterodactyl-panel-mcp.git && cd pterodactyl-panel-mcp
mkdir -p .sdk && (cd /path/to/panel/packages/sdk && npm pack --pack-destination "$OLDPWD/.sdk")
mv .sdk/pterodactyl-sdk-*.tgz .sdk/pterodactyl-sdk.tgz
npm install && npm run build && npm test
cd /var/www/pterodactyl
php artisan p:extension:pack /path/to/pterodactyl-panel-mcp --output=/tmp/panel-mcp.pteroext
php artisan p:extension:install /tmp/panel-mcp.pteroext --enable

Behind nginx, make sure /.well-known/ requests reach PHP (the stock Pterodactyl nginx config already sends everything that is not a file to index.php). Behind Cloudflare or another proxy, keep request timeouts at 100 seconds or more: wait_for_console waits up to 90.

🔌 Connect an AI client

Your MCP server URL is your panel address plus /mcp:

https://panel.example.com/mcp
Client Where to add it
Claude (claude.ai, Desktop, mobile) Settings → Connectors → Add custom connector → paste the URL
Claude Code claude mcp add --transport http panel https://panel.example.com/mcp
ChatGPT Settings → Connectors (developer mode) → add a custom connector with the URL
Cursor ~/.cursor/mcp.json → {"mcpServers": {"panel": {"url": "https://panel.example.com/mcp"}}}
VS Code Command palette → MCP: Add Server → HTTP → paste the URL
Anything else Any client that supports remote MCP servers with OAuth

The client opens your panel, you sign in (if you aren't already) and approve. Connections show up under Account → Connected Apps.

The panel account page with the Connected Apps card added by the extension

🧰 Tools

33 built-in tools. Each one needs the scope shown and the panel permission the equivalent API endpoint requires. Admin tools only exist for root administrators; nobody else even sees them listed.

ReadControlChange files and settings

list_servers · servers you can see, with live state
get_server · details, limits, allocations, variables
get_console · recent console output
wait_for_console · wait for a line (e.g. Done ()
list_files · read_file · search_files
download_file · any file, base64 or a link
inspect_archive · look inside a jar/zip, read plugin.yml, outline a .class
list_schedules · get_activity
get_ops_guide 🛡️ · your team's runbook
query_database 🛡️ · read-only SQL

power_action · start, stop, restart, kill
send_command · run a console command and return the new output
run_schedule · trigger a schedule now

edit_file · exact search-and-replace edits
write_file · create_folder
rename_file · copy_file · delete_files
compress_files · decompress_file
pull_file · download a URL to the server
upload_file · any file up to 4 MB
create_upload_link · for bigger files
set_startup_variable
save_schedule · delete_schedule
save_schedule_task · delete_schedule_task
update_server_config 🛡️ · limits, startup, image

🛡️ = root administrators only. query_database exists only when you configure a read-only database account; get_ops_guide answers once you install a guide.

Every client also receives short instructions when it connects: read before changing, confirm before restarts or deletes, never run a plugin's reload command, never echo secrets. Add your own house rules under Admin → Extensions → Panel MCP.

🔒 Security

Panel MCP was written to be safe to point an AI at a production network.

Authorization OAuth 2.1 with mandatory PKCE (S256), exact redirect URI matching, RFC 8707 resource checks, dynamic client registration for public clients only.
Consent Only from a real panel session (password + 2FA or passkey), CSRF protected, single use, and it names the site you will be sent back to, because client names are self-chosen.
Tokens Random, stored only as SHA-256 hashes, bound to one connection. Codes live 2 minutes and work once; reusing a code revokes the connection. Refresh tokens rotate, and replaying an old one after a short retry window revokes the connection.
Permissions A scope can only narrow what your account can already do. Tools run the panel's own permission checks for the server and action, and refuse suspended servers. The panel's "require 2FA" setting applies to MCP connections too.
Isolation /mcp takes bearer tokens only: no cookies, no session, no CSRF surface, so a signed-in browser tab can't drive it. Per-connection rate limit (120 requests/minute by default).
Audit Every change is written to the activity log as the user who connected; a connection email goes to the account owner; connections and removals are logged too.
Files Path traversal is refused; uploads report size and SHA-256; overwrites need an explicit overwrite: true; request bodies are read raw so file contents are never altered by input middleware.
SQL query_database uses a separate database account you create with SELECT only, plus a statement filter, a read-only transaction and a 15-second limit. Point it at game or plugin databases, never at the panel's own.

Found a vulnerability? Please read SECURITY.md and report it privately.

⚙️ Configuration

Everything is optional. Settings go in the panel's .env (then php artisan config:clear).

Variable Default What it does
PANEL_MCP_OPS_GUIDE_PATH storage/app/panel-mcp/ops-guide.md Markdown file served by get_ops_guide. Install one with php artisan panel-mcp:guide /path/to/guide.md.
PANEL_MCP_SQL_HOST / _PORT 127.0.0.1 / 3306 Database server for query_database.
PANEL_MCP_SQL_USERNAME / _PASSWORD (empty = tool off) A SELECT-only account.
PANEL_MCP_SQL_DATABASES Comma-separated databases the tool may query.
PANEL_MCP_BRAND_ICON the panel's favicon Icon on the consent and Connected Apps pages.
PANEL_MCP_REQUESTS_PER_MINUTE 120 Per-connection rate limit.
PANEL_MCP_TABLE_PREFIX ext_panel_mcp_ Prefix of the four OAuth tables. Only change it before installing, or to reuse tables from an earlier install.

In the admin area, Extensions → Panel MCP → Assistant holds extra instructions sent to every client.

The operations guide

Give your AI the same runbook your staff use. Write it as Markdown with numbered ## sections:

## 1. Ground rules
## 4. Restarts
## 7. Dangerous commands

Install it with php artisan panel-mcp:guide ops-guide.md. Clients are told to read it before changing anything; they can list the sections, open one (section: "4"), or search it. Never put passwords, tokens or keys in it.

Read-only SQL

CREATE USER 'panel_mcp_ro'@'127.0.0.1' IDENTIFIED BY 'a-long-random-password';
GRANT SELECT ON `luckperms`.* TO 'panel_mcp_ro'@'127.0.0.1';
GRANT SELECT ON `litebans`.* TO 'panel_mcp_ro'@'127.0.0.1';
PANEL_MCP_SQL_USERNAME=panel_mcp_ro
PANEL_MCP_SQL_PASSWORD=a-long-random-password
PANEL_MCP_SQL_DATABASES=luckperms,litebans

🧩 Add your own tools

Other extensions can add tools to the MCP server. Implement PanelMcp\Contracts\ProvidesTools and tag the class:

use PanelMcp\Contracts\ProvidesTools;
use Pterodactyl\Models\User;

class NetworkTools implements ProvidesTools
{
    public function tools(): array
    {
        return [
            'get_player_count' => [
                'scope' => 'panel:read',
                'admin' => false,
                'title' => 'Player count',
                'description' => 'Players online across the network right now.',
                'properties' => [],
                'required' => [],
                'run' => fn (array $args, User $user, object $grant) => ['online' => 42],
            ],
        ];
    }
}
// In your extension provider's register() or boot():
$this->app->tag([NetworkTools::class], 'panel-mcp.tools');

Tagging only stores the class name, so your extension keeps working when Panel MCP isn't installed. Built-in tool names always win, malformed tools are skipped and logged, and your tool does its own permission checks (throw PanelMcp\ToolException to return an error).

🧪 Development

npm install && npm run build   # frontend (Connected Apps card)
npm test && npx tsc            # unit tests and types

tests/e2e holds an end-to-end suite of about 300 checks that drives the OAuth flow and every tool over real HTTP against a local dev panel with a fake Wings node. See tests/e2e/README.md.

📄 License

MIT © PandaScript. Not affiliated with or endorsed by Pterodactyl Software.

Looking for a standalone MCP server for Pterodactyl 1.x that uses API keys? See jackh54/pterodactyl-mcp.

from github.com/jackh54/pterodactyl-panel-mcp

Installing Pterodactyl Panel

This server has no published package — it is built from source. Open the repository and follow its README.

▸ github.com/jackh54/pterodactyl-panel-mcp

FAQ

Is Pterodactyl Panel MCP free?

Yes, Pterodactyl Panel MCP is free — one-click install via Unyly at no cost.

Does Pterodactyl Panel need an API key?

No, Pterodactyl Panel runs without API keys or environment variables.

Is Pterodactyl Panel hosted or self-hosted?

Self-hosted: the server runs locally on your machine via the install command above.

How do I install Pterodactyl Panel in Claude Desktop, Claude Code or Cursor?

Open Pterodactyl Panel on unyly.org, pick your client tab (Claude Desktop, Claude Code, Cursor) and press Install — the config is generated automatically, no JSON editing.

Related MCPs