IBM Maximo

🏭 Maximo MCP Server

AI-Powered Development for IBM Maximo

*Transform your Maximo development workflow with AI-driven schema discovery, live data querying, intelligent code generation, and full write-back capabilities.*

Author: Markus van Kempen Email: mvankempen@ca.ibm.com | markus.van.kempen@gmail.com Date: 16 September 2026

Getting Started • Documentation • Live Demo • Use Cases

---

🎯 What is This?

The Maximo MCP Server is a Model Context Protocol server that connects AI assistants (like Antigravity, Cursor, or VS Code Copilot) directly to your IBM Maximo environment. Instead of manually copying API documentation, the AI can:

---

📚 Documentation

Core Guides

French Translations

Word Documents

All guides are also available in .docx format in the docs/ folder for offline reading and sharing.

---

⚡ Quick Start

Prerequisites

• Node.js v18 or higher
• Maximo API Key with read access
• AI IDE with MCP support (Antigravity, Cursor, VS Code + Continue)

Installation

Installation

Method 1: Run directly with npx (Recommended)

npx maximo-mcp-server

Method 2: Clone from Source

# Clone the repository

git clone https://github.com/markusvankempen/maximo-mcp-ai-integration-options.git cd maximo-mcp-ai-integration-options

Install dependencies

npm install

Set up environment variables

cp .env.example .env

Edit .env with your Maximo credentials

Environment Configuration

Edit the .env file with your Maximo credentials:

# .env (never commit this file!)

MAXIMO_URL=https://your-maximo-host.com/maximo/api MAXIMO_HOST=https://your-maximo-host.com MAXIMO_API_KEY=your-api-key-here MAXIMO_OPENAPI_PATH=./maximo_openapi.json PORT=3002

Download the OpenAPI Schema (Recommended)

The OpenAPI schema file enables offline schema lookups for faster AI responses:

# Download from your Maximo instance

curl -X GET "https://your-maximo-host.com/maximo/oslc/oas/api" \ -H "apikey:your-api-key-here" \ -o maximo_openapi.json

Alternatively, download via Swagger UI at: https://your-host/maximo/oslc/oas/api.html (Click "Explore" or "Download")

Method 3: Direct Browser Download (Manual)

If curl fails (e.g., due to SSL/network errors), you can manually download the file:

1. Open this URL in your browser: https://[YOUR_MAXIMO_HOST]/maximo/oslc/oas/api *(Replace [YOUR_MAXIMO_HOST] with your actual server address)*

1. You may be prompted to log in to Maximo.

1. Once the JSON loads, right-click the page and select "Save Page As...".

1. Save the file as maximo_openapi.json in your project root folder.

Note: This file is ~12MB and contains all Object Structure definitions for your Maximo instance.

IDE Configuration

VS Code with GitHub Copilot (Recommended)

Option 1: Install from the MCP Server Gallery

1. Enable chat.mcp.gallery.enabled in VS Code settings
2. Open the Extensions view (⇧⌘X)
3. Type @mcp maximo in the search field
4. Click Install to add the Maximo MCP server

Option 2: Add manually via `mcp.json`

1. Open the Command Palette (⇧⌘P) → MCP: Open Workspace Folder Configuration
2. Add the following configuration:

{

"inputs": [ { "type": "promptString", "id": "maximo-url", "description": "Maximo REST API Base URL (e.g., https://your-host/maximo/api)" }, { "type": "promptString", "id": "maximo-api-key", "description": "Maximo API Key", "password": true }, { "type": "promptString", "id": "maximo-host", "description": "Maximo Host URL (e.g., https://your-host)" } ], "servers": { "maximo-mcp-server": { "type": "stdio", "command": "npx", "args": ["-y", "maximo-mcp-server"], "env": { "MAXIMO_URL": "${input:maximo-url}", "MAXIMO_API_KEY": "${input:maximo-api-key}", "MAXIMO_HOST": "${input:maximo-host}" } } } }

1. VS Code will prompt you for your Maximo credentials when the server starts.

💡 Tip: This project includes a .vscode/mcp.json file. If you clone the repo, VS Code will auto-detect the MCP server configuration.

Google Antigravity (Manual Setup Required)

⚠️ Note: The Antigravity MCP Store is curated and does not auto-discover servers from the registry. You must add this server manually.

1. Open Antigravity
2. Click "..." dropdown at the top of the Agent panel
3. Select "MCP Servers" → "Manage MCP Servers" → "View raw config"
4. Add to your mcp_config.json:

{

"mcpServers": { "maximo-mcp-server": { "command": "npx", "args": ["-y", "maximo-mcp-server"], "env": { "MAXIMO_URL": "https://your-maximo-host/maximo/api", "MAXIMO_API_KEY": "your-api-key-here", "MAXIMO_HOST": "https://your-maximo-host" } } } }

1. Save and click Refresh

Cursor / Claude Desktop

# Copy the template

cp config/mcp_config.json.example ~/.cursor/mcp.json

Or for Claude Desktop:

cp config/mcp_config.json.example ~/Library/Application\ Support/Claude/claude_desktop_config.json

Edit with your Maximo credentials:

{

"mcpServers": { "maximo-mcp-server": { "command": "npx", "args": ["-y", "maximo-mcp-server"], "env": { "MAXIMO_URL": "https://your-maximo-host/maximo/api", "MAXIMO_API_KEY": "your-api-key-here" } } } }

Verify Connection

In your AI IDE, ask:

"Is the Maximo MCP server connected?"

The AI will call get_instance_details and confirm connectivity.

---

🎬 Live Demo

Asset Manager Application

We built a complete Maximo Asset Manager web application using only natural language prompts and the MCP server.

*50 assets loaded with real-time filtering and search*

Demo Features

🎥 Screen Recording

A complete video demonstration is available: assets_demo_recording.webp

Try It Yourself

# Start the local proxy server

node server.js

Open in browser

open http://localhost:3002/demos/assets.html

---

🛠 Available MCP Tools

The server exposes 9 tools to the AI — 6 read tools and 3 write/CRUD tools:

Read Tools

Write Tools (CRUD)

⚠️ Write tools modify live data. Use a read-only API key for exploration; only enable write access for known workflows.

---

💡 Use Cases

1. Generate API Calls

"Get me the last 10 approved work orders from BEDFORD site"

The AI calls get_schema_details(MXWO), understands the fields, and generates:

GET /maximo/api/os/mxwo

?oslc.where=status="APPR" and siteid="BEDFORD" &oslc.select=wonum,description,status,reportdate &oslc.orderBy=-reportdate &oslc.pageSize=10 &lean=1

2. Generate Python Scripts

"Write a Python script to export all Priority 1 work orders to CSV"

import requests

import csv

response = requests.get( "https://your-host/maximo/api/os/mxwo", params={"oslc.where": "wopriority=1", "lean": 1}, headers={"apikey": "YOUR_KEY"} )

with open("priority1_workorders.csv", "w") as f: writer = csv.DictWriter(f, fieldnames=["wonum", "description"]) writer.writeheader() writer.writerows(response.json()["member"])

3. Generate SQL Queries

"Write SQL to find overdue work orders"

SELECT wonum, description, status, targcompdate

FROM workorder WHERE status NOT IN ('COMP', 'CLOSE', 'CAN') AND targcompdate < CURRENT_DATE;

4. Build Complete Applications

"Create an HTML dashboard to display assets"

Result: A complete web application with:

• Dark theme with glassmorphism
• Search and filter functionality
• Interactive detail panels
• Pre-loaded data from Maximo

See the Asset Manager Case Study for the full walkthrough.

5. Create & Update Records (CRUD)

"Create a corrective maintenance work order for the BEDFORD site, priority 1, description 'Pump failure inspection'."

The AI calls get_schema_details(MXWO) to confirm field names, then create_record:

POST /maximo/api/os/MXWO?lean=1

apikey: YOUR_KEY Content-Type: application/json

{ "description": "Pump failure inspection", "siteid": "BEDFORD", "worktype": "CM", "wopriority": 1 }

"Now approve work order 1025 with memo 'Reviewed and approved'."

POST /maximo/api/os/MXWO/1025?action=changeStatus&lean=1

apikey: YOUR_KEY Content-Type: application/json

{ "status": "APPR", "memo": "Reviewed and approved" }

See th