MCP server setup

Prerequisites

You will need an Aplas API key. To generate one:

1. Log in to Aplas and open Config → API.
2. Click Create API Key, choose its role, and copy the generated key.

The role decides what an assistant connected with that key may do:

A ReadOnly key is the right default. It lets an assistant answer questions about your estate with no possibility of altering it — useful when you are trying MCP out, or connecting a client you do not fully control.

Regional endpoint

Aplas is hosted in three regions and the MCP server lives at the same regional host as the REST API, under /mcp/v1:

Use the URL that matches your organization's region. To find yours, open the Config dashboard in Aplas — the Data residency card shows your region and API endpoint. The examples below use the Australia URL; substitute your own.

Claude Code

Run the following command in your terminal:

claude mcp add --transport http aplas https://api.au.aplas.com/mcp/v1 --header "Authorization: Bearer YOUR_API_KEY"

Cursor

1. Open Settings > MCP.
2. Click Add new MCP server.
3. Add the following configuration:

{
  "mcpServers": {
    "aplas": {
      "url": "https://api.au.aplas.com/mcp/v1",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

VS Code (GitHub Copilot)

Create or update the .vscode/mcp.json file in your project:

{
  "servers": {
    "aplas": {
      "type": "http",
      "url": "https://api.au.aplas.com/mcp/v1",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

Claude Desktop, claude.ai and the mobile apps

These connect Aplas as a custom connector. Anthropic's infrastructure calls our server rather than your device, which works because our MCP endpoints are on the public internet.

1. Open the add-connector dialog:

   • Free, Pro and Max — Customize → Connectors → Add custom connector
   • Team and Enterprise — an owner adds it under Organization settings → Connectors → Add → Custom (choose Web if asked for a type); members then connect it from Customize → Connectors

2. Enter the MCP URL for your region, for example https://api.au.aplas.com/mcp/v1

3. Open Request headers and choose the authorization header

4. Enter the value including the scheme:

   Bearer YOUR_API_KEY

   Claude sends the value exactly as typed and adds no prefix — YOUR_API_KEY on its own is rejected

5. Click Add, then enable Aplas from the + menu in a conversation

Because the credential is stored once for the connector rather than per person, everyone using it shares that key's role. A ReadOnly key is the safer default for a shared connector.

Verifying the connection

Once configured, ask your assistant:

List my Aplas workspaces

A working connection returns your workspaces, each with a short id — its slug.

That request is also the first step of every session. Aplas tools are scoped to one workspace, so the assistant has to know which one you mean before it can search or write. A good client calls list_workspaces on its own and then passes the slug to everything else; if yours does not, naming the workspace in your question ("in the enterprise workspace, how many applications are Retired?") is enough.

Protocol version

The server implements MCP protocol 2025-11-25, over streamable HTTP with no session state — each call is a self-contained POST carrying its own credential. Any client supporting that revision works; the three above all do.

Troubleshooting