Maximo MCP Server

AI-Powered Development for IBM Maximo

README.md

🏭 Maximo MCP Server

AI-Powered Development for IBM Maximo

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

Author: Markus van Kempen
Email: mvankempen@ca.ibm.com | markus.van.kempen@gmail.com
Date: 5 February 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:

Capability Description
πŸ” Discover APIs Find available Object Structures (MXWO, MXASSET, etc.)
πŸ“‹ Inspect Schemas Get exact field names, types, and descriptions
πŸ“Š Query Live Data Execute OSLC REST queries and see real results
🎨 Generate UI Create Carbon Design System tables and dashboards
βœ… Validate Instantly Test queries before generating final code

πŸ“š Documentation

Core Guides

Document Description
πŸ“– **Maximo MCP Server Guide** Complete setup, configuration, and tool reference
πŸ”Œ **Maximo API Interaction Guide** OSLC query syntax, code generation patterns, troubleshooting
🎬 **Asset Manager Case Study** Step-by-step walkthrough of building a complete app

French Translations

Document Description
πŸ“– Guide du Serveur MCP Maximo Version franΓ§aise du guide complet
πŸ”Œ Guide d'Interaction API Maximo Version franΓ§aise du guide API

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)

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

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

  4. 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

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

Tools 3

discover_apisFind available Object Structures like MXWO or MXASSET
inspect_schemaGet exact field names, types, and descriptions for a specific object
query_dataExecute OSLC REST queries against Maximo

Environment Variables

MAXIMO_URLrequiredThe base URL for your Maximo API
MAXIMO_HOSTrequiredThe host address for your Maximo instance
MAXIMO_API_KEYrequiredAPI key with read access to Maximo
MAXIMO_OPENAPI_PATHrequiredPath to the local maximo_openapi.json file
PORTPort for the MCP server

Try it

β†’List all available Object Structures in my Maximo environment.
β†’Inspect the schema for the MXWO object structure to see available fields.
β†’Query the last 5 work orders that are currently in 'WAPPR' status.
β†’Generate a Carbon Design System table component for displaying asset data.

Frequently Asked Questions

What are the key features of Maximo MCP Server?

AI-driven discovery of Maximo Object Structures. Direct inspection of field schemas and data types. Execution of OSLC REST queries for live data retrieval. Intelligent code generation for Maximo-integrated applications. Support for offline schema lookups via OpenAPI JSON.

What can I use Maximo MCP Server for?

Automating the creation of Maximo-integrated UI components. Rapidly debugging OSLC query syntax for custom integrations. Building AI-powered assistants for Maximo asset managers. Generating documentation for custom Maximo object structures.

How do I install Maximo MCP Server?

Install Maximo MCP Server by running: npx maximo-mcp-server

What MCP clients work with Maximo MCP Server?

Maximo MCP Server works with any MCP-compatible client including Claude Desktop, Claude Code, Cursor, and other editors with MCP support.

Turn this server into reusable context

Keep Maximo MCP Server docs, env vars, and workflow notes in Conare so your agent carries them across sessions.

Open Conare