What is the difference between the remote and local MCP server?

Both expose the same tool set over the same v1 API. The remote server runs on Dplooy infrastructure at https://api.dplooy.com/mcp, authenticates over OAuth 2.1 with PKCE, needs no install, and is the only option for claude.ai and ChatGPT on the web. The local server is the @dplooy/mcp-server npm package run via npx, authenticates with a dpk_live_ API key, and can additionally read files from your disk to deploy a local folder.

Do I need an API key for the remote MCP server?

No. Remote connections use OAuth, so no key is created, copied or stored. You approve the connection on a Dplooy consent screen and can revoke it from Settings then Connections. API keys are required for the REST API and for local MCP installs.

How do I deploy a website from the command line?

POST your HTML to https://api.dplooy.com/api/v1/deploy with an Authorization Bearer header containing your dpk_live_ API key. For multi-file sites, POST a ZIP archive to /api/v1/deploy/zip. Both return a live URL immediately.

Can I edit a deployed site through the API instead of redeploying it?

Yes. GET /api/v1/projects/:id/files returns the live source, and PATCH /api/v1/projects/:id/files applies targeted string edits. Only the files and text you name change; deletions require an explicit deletePaths list, so nothing is removed by omission.

Which MCP specification does Dplooy implement?

The MCP authorization specification with stateless Streamable HTTP transport, OAuth 2.1 with mandatory PKCE S256, RFC 9728 protected-resource metadata, RFC 8414 authorization-server metadata, RFC 8707 resource indicators, RFC 9207 issuer identification, and Client ID Metadata Documents with RFC 7591 dynamic client registration as a fallback.

Developer Tools

Website hosting with an API your agents can use

A REST API and a spec-compliant MCP server over the same surface. Deploy a site, read its live files back, patch a single line, and attach a form backend, booking widget, JSON content or a chatbot — from code, CI or any AI assistant.

RESThttps://api.dplooy.com/api/v1

MCPhttps://api.dplooy.com/mcp

OAuth 2.1 + PKCEStateless Streamable HTTPFree tierNo credit card

MCP ServerGitHub Actions

From your terminal

curl -X POST https://api.dplooy.com/api/v1/deploy \
  -H "Authorization: Bearer dpk_live_..." \
  -d '{"html":"<h1>Hello</h1>","name":"demo"}'

From your AI

Ship a landing page for my demo, then change the headline

deploy_websitelive

get_project_filesread

update_project_files1 edit

Same API, same resultdemo.dplooy.com

Deploy in 3 Steps

From zero to live website in under a minute.

Get Your API Key

Go to Settings → API Keys and create a new key. Copy the key — it's shown only once.

dpk_live_aBcDeFgHiJkLmNoPqRsTuVwX

Deploy Your Site

Send your HTML to the deploy endpoint. Optionally include CSS and JS as separate strings.

bash

curl -X POST https://api.dplooy.com/api/v1/deploy \
  -H "Authorization: Bearer dpk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"html":"<h1>Hello</h1>","name":"demo"}'

It's Live!

The API responds with your live URL. That's it — your site is deployed with SSL.

json

{
  "success": true,
  "url": "https://my-site.dplooy.com",
  "projectId": "a1b2c3d4-...",
  "isRedeploy": false,
  "plan": "pro",
  "expiresAt": null
}

Authentication

All API requests require a valid API key sent as a Bearer token in the Authorization header.

HTTP Header

Authorization: Bearer dpk_live_your_key_here

Getting a Key

Sign in to Dplooy and go to Settings
Open the API Keys tab
Click Create API Key, give it a name, and copy the key

Your raw API key is shown only once after creation. Store it securely — you cannot retrieve it later. If lost, revoke the key and create a new one.

Hashed Storage

Keys are SHA-256 hashed, never stored in plain text

Rate Limited

30 requests per minute per IP address

Revocable

Revoke any key instantly from the dashboard

API Reference

Six endpoints to deploy, manage, and inspect your hosted projects.

POST/deploy

Deploy an HTML website from code strings. Optionally include separate CSS and JS — they'll be auto-injected into the HTML as linked files.

Request Body (JSON)

Parameter	Type	Status	Description
`html`	string	Required	HTML content for the page
`css`	string	Optional	CSS styles — saved as style.css and linked in <head>
`js`	string	Optional	JavaScript — saved as script.js and linked before </body>
`name`	string	Optional	Project name for the URL (e.g. 'my-site' → my-site.dplooy.com)

Response — 201 Created

json

{
  "success": true,
  "url": "https://my-site.dplooy.com",
  "projectId": "a1b2c3d4-e5f6-...",
  "isRedeploy": false,
  "plan": "pro",
  "expiresAt": null
}

Example

bash

curl -X POST https://api.dplooy.com/api/v1/deploy \
  -H "Authorization: Bearer dpk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<!DOCTYPE html><html><head><title>My Site</title></head><body><h1>Hello World</h1></body></html>",
    "css": "h1 { color: teal; font-family: sans-serif; }",
    "name": "my-site"
  }'

POST/deploy/zip

Deploy a complete website from a ZIP archive. The ZIP must contain an index.html at the root. Subdirectories, CSS, JS, images, and fonts are all preserved.

Request Body (multipart/form-data)

Parameter	Type	Status	Description
`file`	file	Required	ZIP file containing the website (max 500 MB)
`name`	string	Optional	Display name for the project
`projectName`	string	Optional	URL slug (e.g. 'my-site' → my-site.dplooy.com)

Response — 201 Created

json

{
  "success": true,
  "url": "https://my-site.dplooy.com",
  "projectId": "a1b2c3d4-e5f6-...",
  "isRedeploy": false,
  "plan": "pro",
  "expiresAt": null,
  "fileCount": 12,
  "warnings": []
}

Example

bash

curl -X POST https://api.dplooy.com/api/v1/deploy/zip \
  -H "Authorization: Bearer dpk_live_your_key_here" \
  -F "file=@website.zip" \
  -F "name=my-website" \
  -F "projectName=my-website"

Code Examples

Copy-paste examples to get started in your language of choice.

Deploy HTML + CSS

deploy.sh

curl -X POST https://api.dplooy.com/api/v1/deploy \
  -H "Authorization: Bearer dpk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<!DOCTYPE html><html><head><title>My Site</title></head><body><h1>Hello World</h1></body></html>",
    "css": "h1 { color: teal; font-family: sans-serif; }",
    "name": "my-site"
  }'

Deploy ZIP

deploy-zip.sh

curl -X POST https://api.dplooy.com/api/v1/deploy/zip \
  -H "Authorization: Bearer dpk_live_your_key_here" \
  -F "file=@website.zip" \
  -F "name=my-website" \
  -F "projectName=my-website"

List Projects

list.sh

curl https://api.dplooy.com/api/v1/projects \
  -H "Authorization: Bearer dpk_live_your_key_here"

GitHub Actions

Auto-deploy on every push. Same project URL, updated content, analytics preserved. Most repos need no manual setup at all.

Webhook auto-deploy

Static repos — no build step

Connect the repo, then turn on Deploy on every push in the project's GitHub dialog → Deploys tab. Dplooy installs a signed webhook; every push pulls the repo and redeploys.

No workflow file in your repo
No API key anywhere
Nothing to maintain

Actions build pipeline

React, Next.js, Vite, Astro

Set up build & deploy in the GitHub Deploy dialog. Dplooy detects the framework from your package.json and fills in the build command and output folder — confirm them and it does the rest.

Creates a dedicated API key for the repo
Installs it as an encrypted repo secret
Commits the workflow file

You never paste a key for either path. The build pipeline mints its own key, seals it with the repo's public key before it leaves our server, and rolls it back automatically if any step of the setup fails. Need the workflow scope? Reconnect GitHub when prompted. You can also trigger a rebuild any time with Rebuild & deploy on the project's Deploys tab, and watch the run status live.

Custom workflow (optional)

Only needed if you want to write your own pipeline instead of using the one-click setup above — for a monorepo, a custom build, or deploying from a non-GitHub CI.

Manual setup

Go to your GitHub repo → Settings → Secrets and variables → Actions
Click New repository secret
Name: DPLOOY_API_KEY
Value: paste your dpk_live_... key
Add the workflow file below to your repo

For repos that are already plain HTML/CSS/JS — no build step needed.

.github/workflows/deploy.yml

# .github/workflows/deploy.yml
name: Deploy to Dplooy

on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Deploy to Dplooy
        run: |
          zip -r site.zip . -x ".git/*" ".github/*" "node_modules/*" "README.md"
          curl -X POST https://api.dplooy.com/api/v1/deploy/zip \
            -H "Authorization: Bearer ${{ secrets.DPLOOY_API_KEY }}" \
            -F "name=${{ github.event.repository.name }}" \
            -F "file=@site.zip"

How redeploy works: When you deploy with the same project name, Dplooy automatically updates the existing project. Your URL stays the same, analytics are preserved, and the response includes "isRedeploy": true so your CI pipeline knows it was an update.

AI Integration

MCP Server

Build and deploy complete websites from claude.ai, ChatGPT, Claude Code, Cursor, Windsurf and any client that speaks Model Context Protocol. Two ways to connect — remote over OAuth with nothing to install, or the local npm package. Both expose the same tool set.

Remote — OAuth, no install

The only option for claude.ai and ChatGPT on the web

Recommended

Add one custom connector URL. The client discovers everything else itself and runs the OAuth flow — no API key is created, copied or stored.

Settings → Connectors → Add custom connector

https://api.dplooy.com/mcp

Standards implemented

Stateless Streamable HTTP, OAuth 2.1 + PKCE (S256 required), RFC 9728 protected-resource metadata, RFC 8414 server metadata, RFC 8707 resource indicators, RFC 9207 issuer identification, Client ID Metadata Documents with RFC 7591 DCR fallback.

Good to know

Custom connectors on claude.ai need a paid Claude plan; Team and Enterprise workspaces may be admin-gated. In ChatGPT they live in developer mode. Clients cache the tool list at connect time — refresh the connector to pick up newly added tools.

Manage or revoke connected apps in Settings → Connections. Revoking takes effect on the connection's next request.

Local install (stdio)

The MCP server is published on npm as @dplooy/mcp-server. It runs locally on your machine and talks to the Dplooy API using your key.

Run this single command in your terminal:

Terminal

claude mcp add -t stdio \
  -e DPLOOY_API_KEY=dpk_live_your_key_here \
  dplooy -- npx -y @dplooy/mcp-server

Restart Claude Code after adding. The dplooy tools will appear automatically.

Available Tools

Tool	Description
`deploy_website`	Deploy HTML/CSS/JS to a live URL
`deploy_files`	Deploy a multi-page site by passing each file inline (remote only)
`deploy_folder`	Deploy a local folder, zipped automatically (local only)
`list_projects`	List all your deployed projects
`get_project`	Get details about a specific project
`get_project_files`	Read a deployed site's live source files
`update_project_files`	Patch a live site — targeted string edits, explicit deletes
`delete_project`	Delete a project permanently
`get_account`	Plan, usage, limits and the per-feature availability matrix
`get_guide`	Canonical rules for any feature, read by the AI itself
`create_form`	Create a form endpoint and get the HTML snippet
`list_forms`	List form endpoints and their usage
`create_data_collection`	Create a content collection from 20 presets
`get_data_collection`	Fields, rows, public URL and fetch snippet
`list_data_collections`	List collections and their assignments
`update_data_rows`	Row-level edits, appends and deletes, or a full replace
`create_booking_page`	Create a booking calendar and get the widget embed
`list_booking_pages`	List booking widgets and pending requests
`upload_media`	Add up to 16 images per call, ingested by URL
`list_media`	List images in the media library
`assign_to_project`	Bind forms, collections and bookings to a project
`configure_chatbot`	Enable and configure the server-injected AI chatbot

Example Usage

Once installed, just chat with your AI assistant naturally:

"Build a minimal portfolio site with my name, a bio, and links to my social profiles. Deploy it as my-portfolio."

I'll create that for you and deploy it now...

Website deployed successfully!
URL: https://my-portfolio.dplooy.com

Remote connections authenticate over OAuth — no API key is created or stored, and you revoke them in Settings → Connections. Local installs use the same API key as the REST API; it stays on your machine and is never sent to the AI provider. Both hit the same v1 endpoints, so plan limits, security scanning and rate limits apply identically.

Rate Limits & Plans

API limits are based on your plan. Upgrade anytime for higher limits.

Limit	Free	Plus$4.99/mo	Pro$12.99/mo
Projects	3	25	Unlimited
Max File Size	5 MB	50 MB	100 MB
Total Storage	50 MB	500 MB	5 GB
Project Expiry	3 days	Never	Never
Rate Limit	30 req/min	30 req/min	30 req/min
API Access	✓	✓	✓

Rate limiting is per IP address (30 requests/minute). If you hit the limit, the API returns 429 Too Many Requests. Wait 60 seconds and retry.

Error Handling

All errors return JSON with an error message and a machine-readable code.

Error Response

{
  "error": "Invalid or revoked API key",
  "code": "INVALID_API_KEY"
}

Status	Code	Description
400	`VALIDATION_FAILED`	Missing or invalid request parameters
400	`PROJECT_LIMIT_REACHED`	You've hit your plan's project limit
400	`FILE_TOO_LARGE`	Content exceeds your plan's file size limit
400	`SECURITY_THREAT_DETECTED`	Malicious content detected in HTML
400	`NO_INDEX_HTML`	ZIP file must contain an index.html at root
400	`INVALID_FILE_TYPE`	Only ZIP files are accepted for /deploy/zip
401	`INVALID_API_KEY`	Missing, invalid, or revoked API key
404	`NOT_FOUND`	Project does not exist or isn't yours
429	`RATE_LIMITED`	Too many requests — wait 60 seconds
500	`DEPLOY_FAILED`	Internal error during deployment

Ready to Build?

Start deploying in seconds

Create a free account, grab an API key, and ship your first project with a single command.

No credit card required · Free plan includes 3 projects · Upgrade anytime