Skip to content

MCP Server

The deploybase MCP (Model Context Protocol) server lets AI coding assistants manage deployments, projects, and domains through natural language. It exposes 26 tools that map to the deploybase REST API.

TransportAuthUse Case
stdio (default)API keyLocal IDE integration (Claude Code, Cursor, etc.)
HTTPOAuth JWTRemote/hosted MCP server

Add to your project’s .mcp.json:

{
"mcpServers": {
"deploybase": {
"command": "deploybase-mcp",
"args": ["--transport", "stdio"],
"env": {
"DEPLOYBASE_API_KEY": "dbk_your_api_key",
"DEPLOYBASE_API_URL": "https://api.deploybase.eu"
}
}
}
}

The MCP server binary is deploybase-mcp. It reads configuration from environment variables:

VariableRequiredDescription
DEPLOYBASE_API_KEYYes (stdio)API key with dbk_ prefix
DEPLOYBASE_API_URLNoAPI base URL. Default: https://api.deploybase.eu
ToolTypeDescription
list_projectsReadList all projects. Supports search filter by name. Returns name, slug, framework, production URL, latest deployment status.
get_projectReadGet full project details: git URL, framework, build command, output directory, production URL, live deployment ID.
create_projectWriteCreate a new project. Accepts: name, framework, git_repo_url, git_provider, git_token, build_command, output_dir, default_branch.
update_projectWritePartial update of project settings. Only provided fields are changed.
delete_projectDestructivePermanently delete a project and all its deployments, domains, and share links. Irreversible.
check_subdomainReadCheck if a subdomain is available for sites.deploybase.eu.
validate_git_repoReadTest whether a git repository is accessible with given credentials. Run before creating a project.
ToolTypeDescription
list_deploymentsReadList deployments, filtered by project_id and/or status. Supports pagination.
get_deploymentReadFull deployment details: status, branch, commit, CDN URL, build times. Poll every 5–10s after triggering to track progress.
get_build_logsReadFull build log output. Available for building, deployed, or failed deployments. Errors appear near the end.
trigger_deploymentWriteTrigger a build from a git branch. Returns immediately with deployment_id. Default branch deploys auto-promote to production.
cancel_deploymentWriteCancel a pending, queued, or building deployment. Returns 409 for terminal statuses.
promote_deploymentDestructivePromote a deployment to production (instant re-alias). Also how rollback works. Only deployed status allowed.
ToolTypeDescription
list_domainsReadList custom domains with verification and SSL status.
get_domain_statusReadFull domain details including DNS verification instructions and TXT record value.
add_domainWriteAdd a custom domain to a project. Returns verification token for DNS TXT record.
verify_domainWriteTrigger DNS verification. Rate limited: once per 60s per domain. SSL provisioned automatically after success.
get_dns_instructionsReadGet DNS records to configure: TXT for verification, CNAME for traffic routing.
remove_domainDestructiveRemove domain, SSL certificate, and CDN mapping. Traffic falls back to default URL.
ToolTypeDescription
create_share_linkWriteCreate a proxied share URL for any deployment. Optional password (min 8 chars) and expiry (24h, 7d, 30d).
revoke_share_linkDestructiveInstantly revoke a share link. Viewers lose access immediately.
ToolTypeDescription
analyze_project_configReadParse a hosting platform config file (vercel.json, netlify.toml, wrangler.toml) and return deploybase-equivalent settings.
migrate_from_vercelWriteOne-step migration: parse config, create project, trigger first deployment.
migrate_from_netlifyWriteOne-step migration: parse config, create project, trigger first deployment.
migrate_from_cloudflareWriteOne-step migration: parse config, create project, trigger first deployment.

Migration tools return analysis results, project info, deployment info, and any manual steps needed (e.g. environment variables to set, unsupported features).

ToolTypeDescription
get_billing_planReadCurrent plan, usage (bandwidth, build minutes, project count), limits, and billing period dates.
1. validate_git_repo → confirm access
2. create_project → get project_id
3. trigger_deployment → get deployment_id
4. get_deployment (poll) → wait for status=deployed
5. get_build_logs → inspect if failed
1. analyze_project_config → preview migration (optional)
2. migrate_from_vercel → creates project + triggers deployment
3. get_deployment (poll) → track build
4. add_domain → set up custom domain
1. list_deployments (project_id, status=deployed) → find previous
2. promote_deployment → instant rollback