Maximo

You can connect AI assistants directly to your IBM Maximo environment using the Maximo MCP Server. It enables automatic discovery of APIs, precise schema inspection, live data queries, UI generation, and instant validation to accelerate development workflows without manual API documentation juggling.

How to use

You interact with the server through your MCP compatible IDE or agent. Use it to discover available Maximo object structures, inspect exact field definitions, and run live OSLC REST queries against your Maximo instance. You can also generate UI components and dashboards from the data model, then validate queries before generating code. This workflow helps you build integrations, dashboards, and automation with real-time access to your data.

Practical usage patterns include: finding object structures like MXWO or MXASSET, retrieving their schemas to understand fields and types, executing targeted queries to fetch current records, rendering results into Carbon Design System tables for UI prototypes, and verifying results to ensure your generated code will work against your live data.

How to install

Prerequisites include Node.js version 18 or higher, a Maximo API Key with read access, and an AI IDE with MCP support (such as Antigravity, Cursor, or VS Code with MCP extensions).

Method 1: Run directly with npx (recommended)

npx maximo-mcp-server

Method 2: Clone from source and install dependencies

# 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 and schema access

Create and edit the environment configuration to supply your Maximo access details. This enables offline schema lookups and smoother AI responses.

Edit the .env file with your Maximo credentials and key settings:

# .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)

Having the OpenAPI schema on hand enables offline schema lookups for faster AI responses.

Download the schema from your Maximo instance or use the Swagger UI to obtain it.

# 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

IDE configuration for MCP integration

Configure your MCP client so it can communicate with the Maximo MCP Server. The following examples show how to register the server with Antigravity, Cursor, and Claude Desktop.

Antigravity (manual setup) configuration example:

{
  "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"
      }
    }
  }
}

Cursor / Claude Desktop (template-based setup) create a local config that points to the MCP server. Copy the template and edit the credentials to match your environment.

# Copy the template for Cursor
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

Then edit the file to include the server details, similar to the Antigravity example shown previously.

## Verify connection

In your AI IDE, verify the connection by asking a question about the Maximo MCP server connectivity. For example, you can prompt the AI with: “Is the Maximo MCP server connected?” The AI will call a connectivity check endpoint and confirm whether the server is reachable.

## Security and best practices

Keep credentials secure by using read-only API keys for development, never hardcode secrets in configuration files, and enable HTTPS for all communications with Maximo.

## Troubleshooting and notes

If you encounter SSL or network issues when downloading the OpenAPI schema, try the direct browser download method and save the file as maximo\_openapi.json in your project root.

## Available tools

### list\_object\_structures

List available Maximo Object Structures (APIs) you can query or inspect.

### get\_schema\_details

Return field definitions for a chosen Object Structure, including names, types, and descriptions.

### query\_maximo

Execute OSLC REST queries against Maximo to retrieve live data.

### render\_carbon\_table

Generate Carbon Design HTML tables from data for UI previews.

### render\_carbon\_details

Create a detailed UI view for a single Maximo record.

### get\_instance\_details

Check whether the MCP server is connected and responsive.