Maximo MCP Server
This server does not currently have a deployable release on Glama. Follow the repository's setup instructions to install and configure it for your MCP client, including any required credentials and local dependencies.
π MCP for Maximo Application Suite
AI-Powered Development for IBM Maximo Application Suite
Elevate your IBM Maximo development experience with AI-powered schema discovery, real-time data querying, intelligent code generation, and seamless data write-back capabilities.
Author: Ravi Kumar Rajapudi
Email: rajapudiravi@gmail.com
Getting Started β’ Documentation β’ Live Demo β’ Use Cases
π― What is This?
The Maximo MCP Server is a Model Context Protocol (MCP) server that seamlessly connects AI-powered development assistantsβsuch as Antigravity, Cursor, and GitHub Copilot in VS Codeβto your IBM Maximo environment.
By establishing a direct connection to Maximo, it enables AI assistants to interact with your environment intelligently, eliminating the need to manually search, copy, and reference API documentation. Instead, your AI assistant 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 |
βοΈ Create Records | Create Work Orders, Assets, Service Requests via AI |
π Update Records | Partially update any Maximo record by ID |
β‘ Run Actions | Trigger Maximo business workflows (status changes, approvals) |
Related MCP server: Maximo Enterprise MCP
π Documentation
Core Guides
Document | Description |
Complete setup, configuration, and tool reference | |
OSLC query syntax, code generation patterns, troubleshooting | |
Step-by-step walkthrough of building a complete app | |
VS Code extension: install, connect, explore, generate apps |
Prerequisites
Node.js v18 or higher
Maximo API Key with read access
AI IDE with MCP support (Antigravity, Cursor, VS Code + Continue)
Installation
Method 1: Run directly with npx (Recommended)
npx maximo-mcp-serverMethod 2: Clone from Source
# Clone the repository
git clone https://github.com/ravi-kumar-rajapudi/mas-ai-mcp-integration.git
cd maximo-mcp-ai-integration-options
# Install dependencies
npm install
# Set up environment variables
cp .env.example .env
# Edit .env with your Maximo credentialsEnvironment 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=3002Download 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.jsonAlternatively, 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:
Open this URL in your browser:
https://[YOUR_MAXIMO_HOST]/maximo/oslc/oas/api(Replace[YOUR_MAXIMO_HOST]with your actual server address)You may be prompted to log in to Maximo.
Once the JSON loads, right-click the page and select "Save Page As...".
Save the file as
maximo_openapi.jsonin 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
Enable
chat.mcp.gallery.enabledin VS Code settingsOpen the Extensions view (
β§βX)Type
@mcp maximoin the search fieldClick Install to add the Maximo MCP server
Option 2: Add manually via mcp.json
Open the Command Palette (
β§βP) β MCP: Open Workspace Folder ConfigurationAdd 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}"
}
}
}
}VS Code will prompt you for your Maximo credentials when the server starts.
π‘ Tip: This project includes a
.vscode/mcp.jsonfile. 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.
Open Antigravity
Click "..." dropdown at the top of the Agent panel
Select "MCP Servers" β "Manage MCP Servers" β "View raw config"
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"
}
}
}
}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.jsonEdit 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
Feature | Screenshot |
Full Dashboard | 50 assets, 4 stat cards, 3 sites |
Search Filter |
|
Site Filter |
|
π₯ 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
Tool Name | Description |
| List available Maximo Object Structures (APIs) |
| Get field definitions for an Object Structure |
| Execute OSLC REST queries |
| Generate Carbon Design HTML tables |
| Generate detail view for a record |
| Check server connectivity |
Write Tools (CRUD)
β οΈ Write tools modify live data. Use a read-only API key for exploration; only enable write access for known workflows.
Tool Name | Description |
| Create a new record in any Maximo Object Structure |
| Partially update fields on an existing record by ID |
| Execute Maximo business actions (status changes, approvals) |
π‘ 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=12. 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 the full guide: Maximo MCP Server Guide β CRUD Workflows
π§© VS Code Extensions
This project includes two VS Code extensions for interactive Maximo API development β no AI agent required.
Maximo API Explorer
A full-featured VS Code extension for discovering, testing, and generating code for Maximo REST APIs.

Connected to a live Maximo instance showing Object Structures (MXWO, MXSR, MXASSET, etc.) and API Endpoints.
Feature | Description |
Sidebar Tree View | Browse all Object Structures (MXWO, MXASSET, MXSR, etc.) with attributes, types, and relationships |
Interactive API Tester | Build OSLC queries visually, send raw requests, inspect schemas β all in a WebView panel |
Code Snippet Generator | Generate ready-to-use API calls in cURL, Python, JavaScript, TypeScript, and Java |
Carbon App Generator | Scaffold complete Work Order Browser and Asset Manager web apps with one click |
Export for AI Agents | Export schemas and docs to |

OSLC Query Builder with live JSON response (200 OK, 20 records from MXWO).
Quick Start
cd maximo-api-explorer
npm install && npm run compile
# Press F5 in VS Code to launch the Extension Development HostSee the full guide: Maximo API Explorer Guide
Maximo Cursor Explorer
A fork of the API Explorer optimized for Cursor's AI features:
Feature | Description |
.cursorrules Generator | Auto-generate rules giving Cursor AI deep Maximo API knowledge |
AI Context Export | Export schemas to |
Prompt Templates | Pre-built prompts for OSLC queries, CRUD services, dashboards, and more |
All Standard Features | Everything from the API Explorer, plus a dedicated Cursor AI tab |
cd maximo-cursor-extension
npm install && npm run compile
# Press F5 in VS Code to launchπ Project Structure
Maximo-MCP/
βββ maximo-mcp-server.js # π MCP Server implementation
βββ server.js # π Local proxy server for CORS
βββ package.json # π¦ Dependencies & scripts
βββ README.md # This file
βββ .env.example # Environment template
β
βββ docs/ # π Documentation
β βββ Maximo_MCP_Server_Guide.md # Complete MCP guide
β βββ Maximo_API_Interaction_Guide.md # API interaction patterns
β βββ Asset_Manager_App_Case_Study.md # Build walkthrough
β βββ Maximo_API_Explorer_Guide.md # VS Code extension guide
β βββ Maximo_MCP_Server_Guide_FR.md # French translation
β βββ Maximo_API_Interaction_Guide_FR.md # French translation
β
βββ maximo-api-explorer/ # π§© VS Code Extension
β βββ package.json # Extension manifest
β βββ src/extension.ts # Activation & commands
β βββ src/api/ # API client & discovery
β βββ src/auth/ # Authentication manager
β βββ src/views/ # Sidebar tree & WebView panel
β βββ src/snippets/ # Multi-language code generator
β βββ src/templates/ # Carbon app generators
β βββ src/export/ # AI context exporter
β
βββ maximo-cursor-extension/ # π€ Cursor-Optimized Extension
β βββ package.json # Extension manifest
β βββ src/extension.ts # Activation & commands
β βββ src/cursor/ # .cursorrules, prompts, context
β βββ src/... # Same structure as api-explorer
β
βββ CodeExample/ # π¦ Standalone Carbon App Example
β βββ maximo-workorders-carbon/ # Work Order Browser (reference)
β
βββ demos/ # π¨ Demo Applications
β βββ assets.html # Asset Manager app
β βββ carbon_workorders.html # Carbon table demo
β βββ index.html # API visualization demo
β
βββ images/ # πΈ Screenshots & Recordings
β βββ assets_demo_recording.webp # Full demo recording
β βββ assets_loaded.png # Dashboard screenshot
β βββ api-explorer-sidebar.png # Extension sidebar & tree view
β βββ api-explorer-tester.png # OSLC Query Builder & JSON response
β βββ api-explorer-carbon-app.png # Generated Work Order Browser app
β βββ api-explorer-snippets.png # Carbon App Templates (Examples tab)
β βββ ... # More screenshots
β
βββ config/ # βοΈ Configuration Templates
βββ mcp_config.json.example # MCP config templateπ Security Best Practices
Practice | Description |
π Local Execution | MCP server runs on your machine; API keys never leave your environment |
π Read-Only Keys for Dev | Use limited-permission API keys for exploration and development |
βοΈ Separate Write Keys | Only enable write permissions on API keys used for known CRUD workflows |
π Environment Variables | Never hardcode credentials in config files |
π HTTPS Only | Always use encrypted connections to Maximo |
π§ͺ Test Non-Production First | Always validate CRUD operations on a dev/test instance before production |
π€ Contributing
Contributions are welcome! Please read our contributing guidelines before submitting PRs.
Fork the repository
Create a feature branch (
git checkout -b feature/amazing-feature)Commit your changes (
git commit -m 'Add amazing feature')Push to the branch (
git push origin feature/amazing-feature)Open a Pull Request
π License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
π Acknowledgments
Model Context Protocol for the MCP specification
IBM Maximo for the enterprise asset management platform
Carbon Design System for the UI components
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelogβ¦
This server cannot be deployed
Maintenance
Related MCP Connectors
Zero-setup MCP gateway securely connecting AI to your tools with authentication and workflows
Build and run AI workflows, agents, data tables and 1000+ API integrations from any MCP client.
Connect any AI agent to 1,000+ apps and 27,000+ actions through one remote MCP server (OAuth).
Kaiva Bridge turns your API, database or documents into a managed MCP server for Claude, ChatGPT, Cursor and VS Code. Point it at an OpenAPI or Swagger spec, an API docs link, a cURL command, a Postman collection, a GraphQL endpoint, Postgres, MySQL, MariaDB or SQL Server, spreadsheets, PDFs and other documents, or an MCP server you already run. Bridge reads the source and proposes tools, and you choose which ones your AI client sees. No code to write and nothing to run. Connect this server and your agent does the setup for you: it lists your servers, shows one, drafts a new server from an OpenAPI spec, and refreshes a server's tools when its API changes. Free plan: 10 servers and 200,000 tool calls a month, no credit card. Pricing: https://kaiv.ai/bridge/pricing Security: https://kaiv.ai/bridge/security Docs: https://kaiv.ai/bridge/docs
Related MCP Servers
- AlicenseNot gradedqualityCmaintenancehe Maximo MCP Server bridges AI agents (Claude, Cursor, Antigravity) with your IBM Maximo environment. It empowers your AI to autonomously discover Object Structures (APIs), inspect schemas, and query live data via OSLC. Instead of hallucinating field names, the AI validates queries instantly and ca72 npm11Apache 2.0
- AlicenseNot gradedqualityDmaintenanceA production-focused integration that brings IBM Maximo Asset Management into AI workflows, enabling natural language interaction with assets, work orders, inventory, and more.3Apache 2.0
- AlicenseNot gradedqualityCmaintenanceConnects AI assistants directly to IBM Maximo so they can discover APIs, inspect schemas, query live data, generate Carbon UI, and create, update, or act on Maximo records through natural language.72 npmApache 2.0
- AlicenseNot gradedqualityCmaintenanceConnects AI assistants directly to IBM Maximo environments to discover APIs, inspect schemas, query live data, generate UI code, and create, update, or act on records through OSLC REST and business workflows.72 npmApache 2.0

