Skip to main content

An MCP server for IBM Maximo Asset Management, by Maxis Technology — stable tool surface for MCP clients and hosted API use.

Project description

Maximo Enterprise MCP

A production-focused integration that brings IBM Maximo Asset Management into AI workflows through the Model Context Protocol.

Built by Maxis Technology as part of Alchemize — a state-of-the-art enterprise data management platform capable of doing in hours what others do in days. Want to know more? Head over to alchemize.io.

This project now exposes:

  • A stable MCP server for Claude Desktop, Cursor, and other MCP clients.
  • A hosted HTTP/SSE mode for remote MCP access.
  • A FastAPI tool layer for OpenAI, Gemini, Grok, and custom orchestrators.

The current stable surface is 69 public tools across assets, asset reliability (failure classes, meter readings, criticality, warranty status), work orders, work order planning (job plan detail, actuals vs planned, schedule calendar, cost estimate, cost breakdown), service requests, job plans, inventory (item master, storerooms, valuation, critical-spares check), purchasing (POs, requisitions, vendors, spend analysis), labor (crafts, available-technician finder), locations, reporting (failure Pareto, bad actor assets, Excel + PDF export), AI intelligence (anomaly detection, root cause, health scoring), compliance & EHS (calibrations due, inspections due, permits, certifications expiring, incidents, compliance dashboard), schema discovery, and administration.

Responsible Use

This server speaks to a live IBM Maximo instance and exposes its data — and, when explicitly enabled, its mutating operations — to a language model. Before deploying:

  • Run hosted HTTP/SSE behind an authenticated gateway. Per-request identity comes from MCP_AUTH_MODE=jwt (OIDC) or static + gateway-injected X-MCP-* headers. Never expose the FastAPI tool API to untrusted callers without an identity solution in front.
  • TLS at the edge (or in-process via MCP_SSL_*) is mandatory for any non-stdio deployment. The app does not terminate TLS itself.
  • Keep all write tools # DISABLED in server.py until you have reviewed the RBAC policy and audit posture for your environment.
  • Stamp MAXIMO_ENV=dev|staging|prod per deployment so audit records and /healthz make it obvious which Maximo a container is talking to.
  • Read SECURITY.md and PRODUCT_GAPS_BEFORE_DEPLOY.md before pushing to a public registry; the latter documents the exact controls required for https://github.com/mcp-style listings.

Architecture

Local MCP clients        -> stdio MCP server -> Maximo OSLC
Remote MCP clients       -> HTTP gateway -> hosted MCP SSE -> Maximo OSLC
OpenAI / Gemini / Grok   -> FastAPI tool API -> shared executor -> Maximo OSLC

Installation

Local MCP for Claude Desktop / Claude Code / Cursor

You have two ways to install: uvx (recommended — no manual install) or pip install.

Option A — uvx (recommended)

Install uv once, then point your MCP client at uvx maximo-enterprise-mcp. uvx downloads, caches, and runs the package on demand.

Option B — pip install

pip install maximo-enterprise-mcp

Then in the configs below, replace:

"command": "uvx",
"args": ["maximo-enterprise-mcp"]

with:

"command": "maximo-enterprise-mcp",
"args": []

Claude Desktop

Edit %APPDATA%\Claude\claude_desktop_config.json (Windows) or ~/Library/Application Support/Claude/claude_desktop_config.json (macOS):

{
  "mcpServers": {
    "maximo": {
      "command": "uvx",
      "args": ["maximo-enterprise-mcp"],
      "env": {
        "MAXIMO_URL": "https://your-maximo-host.com/maximo/oslc",
        "MAXIMO_HOST": "https://your-maximo-host.com",
        "AUTH_MODE": "basic",
        "MAXIMO_USERNAME": "your-username",
        "MAXIMO_PASSWORD": "your-password",
        "CURRENT_USER_ROLE": "readonly"
      }
    }
  }
}

Restart Claude Desktop. The hammer icon appears once tools load.

Claude Code

Add to project-level .mcp.json or global ~/.claude.json:

{
  "mcpServers": {
    "maximo": {
      "command": "uvx",
      "args": ["maximo-enterprise-mcp"],
      "env": {
        "MAXIMO_URL": "https://your-maximo-host.com/maximo/oslc",
        "MAXIMO_HOST": "https://your-maximo-host.com",
        "AUTH_MODE": "basic",
        "MAXIMO_USERNAME": "your-username",
        "MAXIMO_PASSWORD": "your-password",
        "CURRENT_USER_ROLE": "readonly"
      }
    }
  }
}

Run /mcp in Claude Code to verify the connection.

Cursor

Add to ~/.cursor/mcp.json (global) or .cursor/mcp.json (per project):

{
  "mcpServers": {
    "maximo": {
      "command": "uvx",
      "args": ["maximo-enterprise-mcp"],
      "env": {
        "MAXIMO_URL": "https://your-maximo-host.com/maximo/oslc",
        "MAXIMO_HOST": "https://your-maximo-host.com",
        "AUTH_MODE": "basic",
        "MAXIMO_USERNAME": "your-username",
        "MAXIMO_PASSWORD": "your-password",
        "CURRENT_USER_ROLE": "readonly"
      }
    }
  }
}

In Cursor: Settings → MCP → Refresh to load.

Hosted MCP over HTTP/SSE

Hosted mode is intended for trusted network or gateway-protected deployments. It now fails closed unless MCP_ACCESS_TOKEN is set.

python server.py --http --host 0.0.0.0 --port 8080

Remote MCP clients should connect to:

  • MCP SSE endpoint: http://host:8080/sse
  • Health endpoint: http://host:8080/healthz

Example remote MCP config:

{
  "mcpServers": {
    "maximo": {
      "type": "sse",
      "url": "http://localhost:8080/sse",
      "headers": {
        "Authorization": "Bearer <your MCP_ACCESS_TOKEN>"
      }
    }
  }
}

FastAPI Tool API

Hosted HTTP mode also exposes a tool API for non-MCP platforms:

  • GET /healthz
  • GET /v1/tools
  • POST /v1/tools/{tool_name}
  • GET /v1/providers/openai-tools
  • GET /v1/providers/gemini-tools
  • GET /v1/providers/grok-tools

Example invocation:

curl -X POST http://localhost:8080/v1/tools/list_assets \
  -H "Authorization: Bearer $MCP_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"site_id\":\"BEDFORD\",\"page_size\":10}"

AI Platform Usage

OpenAI

Use GET /v1/providers/openai-tools to retrieve OpenAI-compatible tool definitions, then execute the selected tool via POST /v1/tools/{tool_name}.

Gemini

Use GET /v1/providers/gemini-tools to retrieve Gemini function declarations from the same shared tool registry.

Grok

Use GET /v1/providers/grok-tools. The payload is OpenAI-compatible so the same orchestration pattern works.

Optional Dependencies

Core installation uses requirements.txt.

Optional extras are defined in pyproject.toml:

  • pip install ".[ai]" for OpenAI, ChromaDB, and sentence-transformers.
  • pip install ".[exports]" for Excel and PDF export dependencies.
  • pip install ".[dev]" for local test and lint tooling.

Environment Variables

See .env.example for the complete set. The most important variables are:

Variable Required Description
MAXIMO_URL Yes Full Maximo OSLC base URL
MAXIMO_HOST Yes Maximo host root URL
AUTH_MODE Yes basic, apikey, or oauth
MAXIMO_USERNAME / MAXIMO_PASSWORD Basic auth Maximo credentials
MCP_ACCESS_TOKEN Hosted HTTP Required bearer token for hosted MCP/API mode
CURRENT_USER_ROLE Local only Session role for local or trusted deployments
REDIS_URL No Redis cache connection string
VPN_SAFE_MODE No Enables safer default payload sizes
DEFAULT_PAGE_SIZE No Default page size when safe mode is enabled

Docker

Build

docker build -t maximo-enterprise-mcp .

Run

docker run -d ^
  -p 8080:8080 ^
  -e TRANSPORT_MODE=http ^
  -e MCP_ACCESS_TOKEN=change-me ^
  -e MAXIMO_URL=https://your-maximo-host.example.com/maximo/oslc ^
  -e MAXIMO_HOST=https://your-maximo-host.example.com ^
  -e AUTH_MODE=basic ^
  -e MAXIMO_USERNAME=your-maximo-username ^
  -e MAXIMO_PASSWORD=your-maximo-password ^
  maximo-enterprise-mcp

Use docker-compose.yml if you want Redis included.

Deployment Guidance

The server does NOT terminate TLS itself. Every non-stdio deployment MUST terminate TLS either at the edge or in-process via MCP_SSL_CERTFILE / MCP_SSL_KEYFILE. See SECURITY.md.

AWS

  • Recommended first target: ECS Fargate or App Runner.
  • Store secrets in AWS Secrets Manager.
  • Required: put ALB or API Gateway in front for TLS and access control.
  • Keep Maximo connectivity private when possible.

Azure

  • Recommended first target: Azure Container Apps or App Service.
  • Store secrets in Key Vault.
  • Required: put Application Gateway or Front Door in front for TLS and access control.

Environment Separation

Run one container image, three deployments, three secret stores. Stamp MAXIMO_ENV=dev|staging|prod per deployment — the value lands in every audit record and on /healthz, so an operator can confirm at a glance which Maximo a given container is pointed at.

Recommended pattern:

Deployment MAXIMO_ENV Maximo target Token scope
dev dev dev Maximo dev MCP_ACCESS_TOKEN / OIDC tenant
staging staging staging Maximo staging token / OIDC tenant
prod prod prod Maximo prod token / OIDC tenant

Never reuse a token across environments — a leaked dev token must not unlock prod, and a misrouted dev container must not write to prod data.

Public Internet

Exposing the raw hosted MCP to the public internet requires ALL of the following — no exceptions:

  • bearer or OIDC inbound authentication (MCP_AUTH_MODE)
  • TLS at the edge or in-process (the app serves plaintext by default)
  • explicit CORS allowlist (MCP_ALLOWED_ORIGINS) — do NOT use *
  • rate limiting (RATE_LIMIT_PER_MINUTE) and a separate edge limiter
  • audit logging with durable forwarding
  • private Maximo connectivity or strict network controls

Development

Run unit tests

pytest -m "not integration"

Run integration tests

Integration tests hit a real Maximo instance configured in .env. Two suites:

  • tests/integration_test_tools.py — tool-by-tool smoke against a single live Maximo
  • tests/integration/test_smoke_wave[1-4].py — per-wave smoke runs that gate every public tool added in waves 1–4/6
# Run every integration test (skipped automatically if MAXIMO_URL is unset)
pytest tests/integration -m integration -v

# Run a single wave's smoke
pytest tests/integration/test_smoke_wave2.py -m integration -v

# Or run a wave standalone for ad-hoc debugging
python tests/integration/test_smoke_wave2.py

List registered MCP tools

python server.py --test

Security Notes

  • Do not commit real .env, .mcp.json, or .cursor/mcp.json values.
  • Use example configs from the *.example files and keep secrets in local-only files or a secret manager.
  • Hosted mode requires MCP_ACCESS_TOKEN.
  • The env-based role model is suitable for local or trusted deployments, not multi-tenant public hosting.

IBM and Maximo are trademarks of International Business Machines Corp., used here for descriptive purposes only. This project is not affiliated with IBM.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

maximo_enterprise_mcp-1.0.0.tar.gz (150.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

maximo_enterprise_mcp-1.0.0-py3-none-any.whl (148.8 kB view details)

Uploaded Python 3

File details

Details for the file maximo_enterprise_mcp-1.0.0.tar.gz.

File metadata

  • Download URL: maximo_enterprise_mcp-1.0.0.tar.gz
  • Upload date:
  • Size: 150.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for maximo_enterprise_mcp-1.0.0.tar.gz
Algorithm Hash digest
SHA256 5a39721fd2156525bcda6b8dc07be5100bbc6f8ce49b263a8add6664587bdaad
MD5 c4fe0e7ed26ece550144af0b173fb29c
BLAKE2b-256 26f146c1a7f96dde4dae98c44950188ab8870579c4c1c7f96c0a793d90483cae

See more details on using hashes here.

File details

Details for the file maximo_enterprise_mcp-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for maximo_enterprise_mcp-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c68f5ba9a32b7a00641ffd4be5a138e99d828eee65681279779c8a5a03e22df1
MD5 10ba408c4fd7017e9de214bdb7679926
BLAKE2b-256 1bb5ace253dba47f7614e80a5eb920dedb9a7316c480cdee080b240c926997e2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page