Maximo MCP

🏭 Maximo MCP服务器

IBM Maximo的AI驱动开发

](https://nodejs.org/)    ](package.json)

*通过人工智能驱动的模式发现、实时数据查询和智能代码生成，改变您的Maximo开发工作流程。*

作者 马库斯·范·肯彭\ 电子邮件： mvankempen@ca.ibm.com | markus.van.kempen@gmail.com\ 日期： 2026年2月5日

入门指南 • 文档 • 现场演示 • 用例

______________________________________________________________________

🎯 这是什么？

这 Maximo MCP服务器 是一个 模型上下文协议 将AI助手（如Antigravity、Cursor或VS Code Copilot）直接连接到IBM Maximo环境的服务器。人工智能可以：

______________________________________________________________________

📚 文档

核心指南

法语翻译

Word文档

所有指南也可在 .docx 格式在 docs/ 用于离线阅读和共享的文件夹。

______________________________________________________________________

⚡ 快速开始

先决条件

• Node.js v18或更高版本
• Maximo API密钥 具有读取权限
• 支持MCP的AI IDE（反重力、光标、VS代码+继续）

安装

安装

方法1：直接使用npx运行（推荐）

npx maximo-mcp-server

方法2：从源克隆

# 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

环境配置

编辑 .env 使用您的Maximo凭据文件：

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

下载OpenAPI模式（推荐）

OpenAPI模式文件支持离线模式查找，以实现更快的AI响应：

# 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

或者，通过Swagger UI下载： https://your-host/maximo/oslc/oas/api.html （点击“浏览”或“下载”）

方法3：直接浏览器下载（手动）

如果 curl 如果失败（例如，由于SSL/网络错误），您可以手动下载文件：

1. 在浏览器中打开此URL：

https://[YOUR_MAXIMO_HOST]/maximo/oslc/oas/api *（替换 [YOUR_MAXIMO_HOST] 使用您的实际服务器地址）*

1. 系统可能会提示您登录Maximo。

1. 加载JSON后，右键单击页面并选择 “将页面另存为…”.

1. 将文件另存为 maximo_openapi.json 在您的项目根文件夹中。

备注：此文件约为12MB，包含Maximo实例的所有对象结构定义。

IDE配置

谷歌反重力（需要手动设置）

⚠️ 注： 反重力MCP商店是经过精心策划的，不会从注册表中自动发现服务器。您必须手动添加此服务器。

1. 开放反重力
2. 点击“...“Agent面板顶部的下拉列表
3. 选择“MCP服务器" → "管理MCP服务器" → "查看原始配置"
4. 添加到您的 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. 保存并单击 刷新

光标/克劳德桌面

# 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

使用您的Maximo凭据进行编辑：

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

验证连接

在AI IDE中，问：

“Maximo MCP服务器是否已连接？”

AI将呼叫 get_instance_details 并确认连接。

______________________________________________________________________

🎬 现场演示

资产管理器应用程序

我们建立了一个完整的 Maximo资产经理 仅使用自然语言提示和MCP服务器的web应用程序。

Asset Manager Dashboard

*50个资产加载了实时过滤和搜索功能*

演示功能

🎥 屏幕录制

完整的视频演示可用： assets_demo_recording.webp

动手试一试

# Start the local proxy server
node server.js

# Open in browser
open http://localhost:3002/demos/assets.html

______________________________________________________________________

🛠 可用的MCP工具

服务器向AI公开了6个工具：

MCP Tools UI

______________________________________________________________________

💡 用例

1.生成API调用

“从BEDFORD现场获取最近10个批准的工作订单”

AI呼叫 get_schema_details(MXWO)，理解字段，并生成：

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.生成Python脚本

“编写一个Python脚本，将所有优先级1的工作订单导出到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.生成SQL查询

“编写SQL查找逾期工单”

SELECT wonum, description, status, targcompdate
FROM workorder
WHERE status NOT IN ('COMP', 'CLOSE', 'CAN')
  AND targcompdate  “创建HTML仪表板以显示资产”

**结果：** 一个完整的web应用程序，包括：

- 玻璃造型的黑暗主题
- 搜索和筛选功能
- 交互式细节面板
- 来自Maximo的预加载数据

请参阅 [资产管理公司案例研究](docs/Asset_Manager_App_Case_Study.md) 完整的演练。

______________________________________________________________________

## 📁 项目结构

Maximo-MCP/ ├── maximo-mcp-server.js # 🔌 MCP Server implementation ├── server.js # 🌐 Local proxy server for CORS ├── package.json # 📦 Dependencies ├── README.md # This file ├── .env.example # Environment template ├── .gitignore # Git ignore rules │ ├── 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_MCP_Server_Guide_FR.md # French translation │ └── Maximo_API_Interaction_Guide_FR.md # French translation │ ├── 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 │ ├── pump_search_results.png # Search demo │ └── laredo_filtered.png # Filter demo │ └── config/ # ⚙️ Configuration Templates └── mcp_config.json.example # MCP config template

______________________________________________________________________

## 🔒 安全最佳实践

|实践|描述|
|----------|-------------|
| 🔐 **本地执行** |MCP服务器在您的计算机上运行；API密钥永远不会离开您的环境|
| 📖 **只读密钥** |使用受限权限的API密钥进行开发|
| 🔒 **环境变量** |永远不要在配置文件中硬编码凭据|
| 🌐 **仅限HTTPS** |始终使用与Maximo的加密连接|

______________________________________________________________________

## 🤝 贡献

欢迎投稿！请在提交PR之前阅读我们的投稿指南。

1. 克隆该仓库
1. 创建要素分支(`git checkout -b feature/amazing-feature`)
1. 提交您的更改(`git commit -m 'Add amazing feature'`)
1. 推到分支(`git push origin feature/amazing-feature`)
1. 打开拉取请求

______________________________________________________________________

## 📄 许可证

此项目根据MIT许可证获得许可-请参阅 [许可证](LICENSE) 文件以获取详细信息。

______________________________________________________________________

## 🙏 致谢

- [模型上下文协议](https://modelcontextprotocol.io/) 对于MCP规范
- [IBM最大值](https://www.ibm.com/products/maximo) 企业资产管理平台
- [碳设计系统](https://carbondesignsystem.com/) 对于UI组件