Atlas MCP
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Atlas MCPlist all open and in-progress work orders"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Atlas MCP
An MCP (Model Context Protocol) server that bridges Claude to the Atlas CMMS work order REST API, exposed over Streamable HTTP.
It signs in to the API once with a service-account email/password, holds the resulting JWT in memory, and refreshes it automatically (both preemptively before expiry and reactively on a 401).
Tools
Tool | Endpoint | Purpose |
|
| Filter + paginate work orders |
|
| Full detail on one work order |
|
| Create a work order |
|
| Partial update of general fields |
|
| Move through OPEN/IN_PROGRESS/ON_HOLD/COMPLETE, with feedback/signature |
| (wraps | Set assignees / primary assignee |
|
| Executive summary for a given week, by |
|
| Full detail on one asset, read-only |
|
| Filter + paginate assets, read-only |
Output matches what a human sees in the frontend, not the database schema
Every tool renders people and entities as { id, name } pairs instead of bare ids —
get-work-order's relations.primaryWorker reads { "id": 7, "name": "John Smith" }, not
"worker: ID 225". Two conventions apply everywhere, and are also declared in the MCP server's
instructions field (sent once at connection time) so Claude applies them without being told
per-request:
idis the display code, not the database primary key. The frontend's own "Id" column is always bound tocustomId(WorkOrderService.getWorkOrderNumber/AssetService.getAssetNumber— formatWO+ 6 digits for work orders, e.g.WO000042;A+ 6 digits for assets, e.g.A000012), never the raw numeric id — confirmed in both the generation code and the list/detail-view rendering. So every tool'sidfield is that display code (src/util/format.ts'sdisplayId()), and the raw numeric id — still needed to chain further tool calls — is kept alongside under an unambiguous name:workOrderIdfor work orders,assetIdfor assets. Never read a bare number back to a user as "the ID".primaryWorkeris the main/responsible worker, distinct fromassignedTo. The frontend detail page (WorkOrderDetails.tsx) rendersprimaryUserunder its own "Primary Worker" heading, with its own "No primary worker" empty state — structurally separate from the "Assigned To" list of other workers, never merged into it. So when asked "who is working on this" or "who's assigned to it", answer withprimaryWorkerfirst;assignedTois the additional-workers list, not a set of equally-weighted assignees.
Two more wrinkles worth knowing:
Users have no combined "name" field on the API side (
UserMiniDTOonly hasfirstName/lastName) —formatUserName()joins them. A user with neither field set (rare) falls back toUser #<id>.get-work-orderalso fetches and resolves discrepancies ("squawks") viaGET /work-order-discrepancies/work-order/{id}, included as adiscrepanciesarray. Each discrepancy's "raised by" is only exposed as a rawcreatedByuser id by that endpoint — this tool makes one extraGET /users/{id}call per unique id to resolve it to a name (src/util/userLookup.ts), rather than showing a bare id.
A few things that don't match the "obvious" naming
The Atlas API's actual enums differ from what you'd guess from a typical CMMS:
Status is
OPEN | IN_PROGRESS | ON_HOLD | COMPLETE— there is noARCHIVEDstatus.archivedis a separate boolean field, set viaupdate-work-order, not a status value.Priority is
NONE | LOW | MEDIUM | HIGH(noteNONE, the default).AssetStatus (settable on create via
assetStatus) isOPERATIONAL | DOWN | MODERNIZATION | STANDBY | INSPECTION_SCHEDULED | COMMISSIONING | EMERGENCY_SHUTDOWN.change-work-order-statushas nocompletedById— the API setscompletedBy/completedOnitself when a work order reachesCOMPLETE; this tool only sendsstatus,feedback, andsignature.
These were verified against the API's actual Java source (entities/DTOs/enums), not assumed from
convention — see src/atlasTypes.ts for the mirrored shapes.
Search filter mechanics
The API's /work-orders/search endpoint takes a SearchCriteria with a filterFields array, and
its filter semantics are stricter than they look:
Filtering an enum column (
status,priority) requiresoperation: "in"withenumNameset ("STATUS"/"PRIORITY") and the value(s) invalues. A plain"eq"with a bare string skips the server's enum-name conversion and won't match anything.Filtering a to-many relation (
assignedTo) requiresoperation: "inm"(many-to-many, via a join) withjoinType: "LEFT".Filtering a to-one relation (
team,location) usesoperation: "in"on the bare field name with entity ids invalues.list-assetsdeliberately has no status filter. The server's enum-name conversion (EnumName.java) only knowsPRIORITY/STATUS/JS_DATE— there's noASSET_STATUSentry, and the API's own frontend doesn't filter assets by status via search either. Filtering by status would silently match nothing rather than erroring, so it's left out; useget-asseton individual results instead.Filtering a date range requires
operation: "ge"/"le"withenumName: "JS_DATE", and the value must be in the exact formatyyyy-MM-dd'T'HH:mm:ss.SSS'Z'— i.e. JavaScript'sDate#toISOString(). Any other format fails to parse server-side and is silently dropped (no error), so the filter just doesn't apply.
list-work-orders and generate-weekly-work-order-report build these correctly; if you extend the
filter set, mirror this rather than guessing at "eq".
Related MCP server: Workiz MCP Server
Setup
cp .env.example .env # fill in API_BASE_URL / API_EMAIL / API_PASSWORD
npm install
npm run build
npm startFor local development against a running Atlas API:
npm run devEnvironment variables
Variable | Default | Purpose |
|
| Base URL of the Atlas API |
| (required) | Service account email |
| (required) | Service account password |
|
| Port for the MCP HTTP transport + |
|
|
|
|
| Refresh the JWT this many minutes before it expires |
| (unset) | Bearer token required on |
The service account must already exist (POST /auth/signup against the Atlas API) before this
server starts — it only signs in, it doesn't create the account.
Exposing this on a public network
Local Claude clients (Desktop, Claude Code) can reach localhost directly. The Claude mobile apps
and claude.ai's custom connectors cannot — they need a public HTTPS URL. Before you put this
server anywhere reachable from the internet:
Set
MCP_AUTH_TOKENto a long random value (openssl rand -hex 32). Without it,/mcphas no access control at all and anyone with the URL can act as your Atlas service account. The server logs aWARNat startup if this is unset, precisely so it's not silently forgotten.Put it behind HTTPS — a reverse proxy (Caddy, nginx + Let's Encrypt) or a platform that terminates TLS for you (Fly.io, Render, etc.).
When adding it as a custom connector in claude.ai, supply the same token as the connector's bearer/auth header.
GET /health intentionally stays open with no token required, so container orchestrators and load
balancers can probe it without the secret.
Running with Docker
docker compose up -d --builddocker-compose.yml reads API_BASE_URL, API_EMAIL, API_PASSWORD, LOG_LEVEL,
JWT_EXPIRY_BUFFER_MINUTES, and MCP_AUTH_TOKEN from your shell/.env. The container exposes
GET /health → { "status": "ok" }, used by both the Dockerfile's HEALTHCHECK and the compose
file.
Example tool calls
// list-work-orders
{ "status": ["OPEN", "IN_PROGRESS"], "priority": ["HIGH"], "pageSize": 10 }
// get-work-order
{ "workOrderId": 42 }
// create-work-order
{
"title": "Replace worn belt",
"description": "Belt on conveyor 3 is fraying",
"priority": "HIGH",
"dueDate": "2026-09-05T00:00:00Z",
"assetId": 12,
"assignedToUserIds": [7, 9]
}
// update-work-order
{ "workOrderId": 42, "priority": "MEDIUM", "estimatedDuration": 1.5 }
// change-work-order-status
{ "workOrderId": 42, "newStatus": "COMPLETE", "feedback": "Replaced and tested." }
// assign-work-order
{ "workOrderId": 42, "userIds": [7, 9], "primaryUserId": 7 }
// generate-weekly-work-order-report
{ "weekOffset": 0, "format": "MARKDOWN" }
// get-asset
{ "assetId": 12 }
// list-assets
{ "locationId": 3, "nameContains": "conveyor", "pageSize": 10 }Testing
npm testtest/validation.test.ts— pure input-validation unit tests (malformed dates, bad enums, missing required fields, oversized arrays). Runs with no network access.test/integration.test.ts— exercises the real API end to end (signin → list → create → get → update → change-status). Only runs whenAPI_BASE_URL,API_EMAIL, andAPI_PASSWORDare set and point at a live instance with that account already signed up; otherwise the suite is skipped sonpm teststill passes in CI without a backend.
To stand up a local Atlas API to test against, see the cmms repo's own CLAUDE.md — the short
version:
service postgresql start
su postgres -c "psql -c \"ALTER USER postgres WITH PASSWORD 'postgres';\" -c 'CREATE DATABASE atlas;'"
cd api && DB_URL=localhost:5432/atlas DB_USER=postgres DB_PWD=postgres \
JWT_SECRET_KEY=... KEYGEN_PRODUCT_TOKEN= OAUTH2_PROVIDER= STORAGE_TYPE=minio \
mvn -DskipTests spring-boot:run
curl -X POST localhost:8080/auth/signup -H 'Content-Type: application/json' \
-d '{"email":"mcp@atlas.local","password":"Password123!","firstName":"MCP","lastName":"Bot","phone":"+1","companyName":"Co","employeesCount":2}'Then set API_EMAIL=mcp@atlas.local, API_PASSWORD=Password123! before running npm test.
Error handling & logging
401 → the client re-authenticates once and retries the request; a second 401 is surfaced as an error rather than retried again.
Transient errors (5xx, network/timeout) → retried up to 3 times with backoff
100ms → 500ms → 1000ms.All logging is structured JSON on stdout/stderr.
password,accessToken,authorization, andsignaturefields are redacted from logged context, at every log level, so raisingLOG_LEVELtoDEBUGnever leaks a credential or token.
Troubleshooting
"Missing required environment variable: API_EMAIL/API_PASSWORD" — set them in
.envor the environment; the process refuses to start without them (no hardcoded fallback).Every tool call fails with a 401-related error — the service account may not exist yet, or its password changed. Re-run
/auth/signup(or reset the password) against the Atlas API.list-work-ordersreturns nothing you expect from a status/priority filter — double-check you're not comparing againstARCHIVEDas a status (it isn't one) — see Tools above.generate-weekly-work-order-reportlooks incomplete for a busy week — it pages through results up to 25 pages of 200 (5,000 work orders); past that it logs aWARNand returns what it has rather than hanging indefinitely./mcprequests return 401 "missing or invalid bearer token" —MCP_AUTH_TOKENis set on the server; the client must send the exact same value asAuthorization: Bearer <token>.Server logs
WARN: MCP_AUTH_TOKEN is not set...at startup — expected in local dev; set the variable before exposing the port on any network you don't fully trust.
This server cannot be deployed
Maintenance
Related MCP Connectors
Property management AI: work orders, vendors, appliances, and triage for Claude and ChatGPT.
Run UX research from Claude — create card sort studies, list studies, pull headline stats.
- platform7nOAuthtech.p7n
Connect Claude to your Platform7n workspaces — chat, links, and tasks. One-click OAuth.
- mcpOAuthcom.fivexer
Route, roster, and track work in a Fivexer workspace from Claude Code and other agentic tools
Related MCP Servers
- AlicenseAqualityBmaintenanceEnables Claude to inspect and operate Apache Airflow over its REST API, providing read tools and safe write operations (gated by read-only mode) for managing DAGs, runs, tasks, and pools.14MIT
- FlicenseNot gradedqualityBmaintenanceProvides tools to read and write Workiz CRM/Field Service data (jobs, leads, team, time off) enabling Claude to manage records via natural language.-
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants like Claude to interact with Atomicwork tickets, requests, and workflows through natural language, providing tools for listing, searching, and managing tickets.MIT
- AlicenseAqualityBmaintenanceEnables Claude to interact with System Task projects, teams, and tasks, providing daily briefs, project reports, team load, and risk identification, as well as creating and updating tasks and demands.15MIT