Using Mendix Deploy APIs with AI Agents (MCP)

Introduction

Model Context Protocol (MCP) enables AI coding assistants to connect to Mendix Cloud environments. Once connected, an AI assistant can manage deployments, environments, and the application lifecycle through natural language.

For example, you can ask the AI assistant to list your apps, deploy the latest package to an acceptance environment, or stop a production environment, without writing curl commands or navigating the Mendix Portal.

Prerequisites

Before you start, make sure you have the following:

• An MCP-compatible AI client that supports custom request headers, such as Claude Code or VS Code with GitHub Copilot
• A Mendix account with API access enabled
• A Personal Access Token (PAT) with the mx:deployment:write and mx:deployment:read scopes selected
• A Mendix API key

Connecting Your AI Assistant

Claude Code

To add the Mendix MCP server in Claude Code, run the following command in your terminal:

claude mcp add --scope user --transport http mendix-cloud-mcp \
https://mcp.home.mendix.com/ \
--header "Authorization: MxToken {GENERATED_PAT}" \
--header "Mendix-Username: {Mendix-Username}" \
--header "Mendix-ApiKey: {Mendix-ApiKey}"

Replace the following placeholders with your credentials:

• {GENERATED_PAT} – the generated Mendix Personal Access Token (PAT)
• {Mendix-Username} – the login name of the user making the request, with the required privileges in the Mendix Platform
• {Mendix-ApiKey} – the API key associated with that user

To verify the connection, run the following command:

claude mcp get mendix-cloud-mcp

A successful connection displays output similar to the following:

claude mcp get mendix-cloud-mcp
mendix-cloud-mcp:
  Scope: User config (available in all your projects)
  Status: ✔ Connected
  Type: http
  URL: https://mcp.home.mendix.com/
  Headers:
    Authorization: MxToken {GENERATED_PAT}
    Mendix-Username: {Mendix-Username}
    Mendix-ApiKey: {Mendix-ApiKey}

To remove this server, run: claude mcp remove mendix-cloud-mcp -s user

VS Code with GitHub Copilot

To add the Mendix MCP server in VS Code, add the following configuration to your .vscode/settings.json file or your VS Code user settings:

{
   "mcp":{
      "servers":{
         "mendix-cloud-mcp":{
            "type":"http",
            "url":"https://mcp.home.mendix.com/",
            "headers":{
               "Authorization":"MxToken {GENERATED_PAT}",
               "Mendix-Username":"{Mendix-Username}",
               "Mendix-ApiKey":"{Mendix-ApiKey}"
            }
         }
      }
   }
}

Replace the placeholder values with your credentials as described in the Claude Code section above.

Available Capabilities

Once connected, your AI assistant has access to the following capabilities.

Apps and Environments

Deployments and Packages

Backups

Logs

Permissions

Authentication

Your credentials are passed directly to the Mendix APIs and are not stored or inspected by the MCP gateway. Each user authenticates using their own credentials.

Two authentication methods are used depending on the API:

Client Compatibility

The Mendix MCP integration works with any MCP-compatible client that supports HTTP transport (streamable HTTP) and custom headers for authentication.

Known Limitations

The following limitations apply:

Troubleshooting

Connection Fails or Times Out

• Make sure the URL is exactly https://mcp.home.mendix.com/. The trailing slash (/) is required.
• Verify that your JSON configuration uses "type": "http" and not "transport": "http".

401 Unauthorized

Your credentials are incorrect or have expired. Regenerate your PAT and verify that your API key is still active.

403 Forbidden

You do not have permission to the requested resource. Verify that you have the correct role for the app or environment you are accessing. For more information, refer to Node Permissions.

406 Not Acceptable

Your MCP client is not sending the correct Accept header. This happens when you hand-edit the JSON configuration and use "transport": "http" instead of "type": "http" as the key. To fix this, remove and re-add the connection using the CLI, which sets the correct configuration automatically:

claude mcp remove mendix-cloud-mcp
claude mcp add --scope user --transport http mendix-cloud-mcp \
https://mcp.home.mendix.com/ \
--header "Authorization: MxToken {GENERATED_PAT}" \
--header "Mendix-Username: {Mendix-Username}" \
--header "Mendix-ApiKey: {Mendix-ApiKey}"

Tools Not Showing Up

• Wait 10–15 seconds after connecting for tool discovery to complete.
• Run claude mcp get mendix-cloud-mcp to check the connection status.
• If the status shows an error, remove and re-add the connection.

Feedback

To report an issue or request additional API coverage, contact your Mendix CSM.