DeployxaDocs Portal
v1.10.4 STABLE
Deployxa MCP Server
AI & Agents

Deployxa MCP Server

Connect Claude, Claude Code, Codex, Cursor, Windsurf, Gemini, or any other MCP-capable agent to your Deployxa projects through one hosted Streamable HTTP endpoint. Every tool call goes through the same authentication, scopes, and RBAC as the REST API.

New to this? Set it up in about 2 minutes
  1. Open the AI assistant on your computer (for example Claude, Cursor, or VS Code).
  2. Copy the message below, paste it into the chat, and press send.
  3. When a Deployxa sign-in page opens, sign in and click Allow. If it asks which workspace to use, pick the one you want.
  4. Type “Show me my Deployxa projects” to check that it worked.
Message to copy
Please connect to my Deployxa account so you can help me with my projects and deployments.

Here is what you need:
- Service name: Deployxa
- Address: https://mcp.deployxa.com/mcp
- When a sign-in page opens, please open it for me in my browser.

If you can't add it yourself, tell me exactly where to click and what to paste, in simple steps.

Once you are connected, please:
1. Show me a list of my Deployxa projects.
2. Tell me which account and workspace you are connected to.

Very important: always ask me before you change anything (create, update, deploy,
restart, delete, or remove). Never delete or cancel anything without asking me first.

No technical steps needed — the assistant adds the connection for you. If it ever asks for an “API key”, create one in the API keys dashboard and paste it in.

For developers — full technical prompt
Connect the Deployxa MCP server to your tools, then verify it works.

- Name: deployxa
- Transport: Streamable HTTP
- URL: https://mcp.deployxa.com/mcp
- Auth: OAuth 2.1 (sign in when prompted), or send the header
  Authorization: Bearer dxa_...  (create a key at https://deployxa.com/dashboard/api-keys)

If you can read a config file, add this and restart:

{
  "mcpServers": {
    "deployxa": { "url": "https://mcp.deployxa.com/mcp" }
  }
}

After connecting, call deployxa_list_projects and summarize the projects you can see.
Ask me before running any write tool, and never run a dangerous tool
(delete, revoke, disconnect) without my explicit confirmation.

Client configuration

If you prefer to edit the client configuration yourself, add one of these to Claude Desktop, Cursor, Windsurf, VS Code, or any other MCP client.

OAuth 2.1 (recommended)
{
  "mcpServers": {
    "deployxa": {
      "url": "https://mcp.deployxa.com/mcp"
    }
  }
}
Deployxa API key (automation)
{
  "mcpServers": {
    "deployxa": {
      "url": "https://mcp.deployxa.com/mcp",
      "headers": {
        "Authorization": "Bearer dxa_..."
      }
    }
  }
}

What the agent can do

  • Inspect projects, deployments, logs, environments, domains, databases, artifacts, and billing.
  • Diagnose a failing or stuck deployment with deployxa_diagnose_deployment.
  • Create, cancel, roll back, and promote deployments, and manage project resources.

63 tools across 15 categories: 41 read, 16 write, 6 dangerous. Dangerous tools (delete, revoke, disconnect) require an explicit confirmed: true argument, and setting DEPLOYXA_MCP_ENABLE_MUTATIONS=false makes the server read-only.

Create an API key

Open the API keys dashboard, create a key for the organization the agent should work in, and keep it out of source control. API keys stay bound to that organization and never elevate your Deployxa permissions.