IBM Maximo

---

🎯 これは何ですか？

Maximo MCP Server は、AI アシスタント（Antigravity、Cursor、VS Code Copilot など）を IBM Maximo 環境に直接接続する Model Context Protocol サーバーです。API ドキュメントを手作業でコピーする代わりに、AI は次のことができます。

機能	説明
🔍 API を検出	利用可能な Object Structure（MXWO、MXASSET など）を検索します
📋 スキーマを調査	正確なフィールド名、型、説明を取得します
📊 ライブデータをクエリ	OSLC REST クエリを実行し、実際の結果を確認します
🎨 UI を生成	Carbon Design System のテーブルやダッシュボードを作成します
✅ 即座に検証	最終的なコードを生成する前にクエリをテストします
✏️ レコードを作成	AI を使って作業指示書、資産、サービスリクエストを作成します
🔄 レコードを更新	ID を指定して、任意の Maximo レコードを部分更新します
⚡ アクションを実行	Maximo のビジネスワークフロー（ステータス変更、承認）をトリガーします

---

📚 ドキュメント

コアガイド

ドキュメント	説明
📖 Maximo MCP Server ガイド	セットアップ、構成、ツールリファレンスの完全ガイド
🔌 Maximo API 操作ガイド	OSLC クエリ構文、コード生成パターン、トラブルシューティング
🎬 Asset Manager ケーススタディ	アプリ全体の構築手順を詳しく説明します
🧩 Maximo API Explorer ガイド	VS Code 拡張機能：インストール、接続、探索、アプリ生成

フランス語訳

ドキュメント	説明
📖 Guide du Serveur MCP Maximo	完全ガイドのフランス語版
🔌 Guide d'Interaction API Maximo	API ガイドのフランス語版

Word 文書

すべてのガイドは、オフラインでの閲覧や共有に使用できる .docx 形式でも docs/ フォルダーに用意されています。

---

⚡ クイックスタート

前提条件

• Node.js v18 以降
• Maximo API Key（読み取りアクセス権付き）
• MCP に対応した AI IDE（Antigravity、Cursor、VS Code + Continue）

インストール

インストール

方法 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

環境設定

Maximo の認証情報を .env ファイルに記入します。

# .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（「Explore」または「Download」をクリック）

方法 3：ブラウザーから直接ダウンロード（手動）

curl が失敗する場合（SSL／ネットワークエラーなど）、ファイルを手動でダウンロードできます。

1. ブラウザーで次の URL を開きます。 https://[YOUR_MAXIMO_HOST]/maximo/oslc/oas/api （[YOUR_MAXIMO_HOST] を実際のサーバーアドレスに置き換えてください）

2. Maximo へのログインを求められる場合があります。

3. JSON が読み込まれたら、ページを右クリックして 「名前を付けてページを保存...」 を選択します。

4. プロジェクトのルートフォルダーに maximo_openapi.json という名前でファイルを保存します。

注： このファイルは約 12 MB で、お使いの Maximo インスタンスのすべてのオブジェクト構造の定義が含まれています。

IDE の設定

GitHub Copilot を使用する VS Code（推奨）

オプション 1：MCP Server Gallery からインストール

1. VS Code の設定で chat.mcp.gallery.enabled を有効にします
2. 拡張機能ビュー（⇧⌘X）を開きます
3. 検索フィールドに @mcp maximo と入力します
4. インストール をクリックして、Maximo MCP サーバーを追加します

オプション 2：mcp.json から手動で追加

1. コマンドパレット（⇧⌘P）を開き、MCP: ワークスペースフォルダーの構成を開く を選択します
2. 次の設定を追加します。

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

3. サーバーの起動時に、VS Code から Maximo の認証情報を求められます。

💡 ヒント： このプロジェクトには .vscode/mcp.json ファイルが含まれています。リポジトリをクローンすると、VS Code が MCP サーバーの設定を自動検出します。

Google Antigravity（手動設定が必要）

⚠️ 注： Antigravity MCP Store は厳選されたサーバーのみを掲載しており、レジストリからサーバーを自動検出しません。このサーバーは手動で追加する必要があります。

1. Antigravity を開きます
2. Agent パネル上部にある「...」のドロップダウンをクリックします
3. 「MCP Servers」→「Manage MCP Servers」→「View raw config」を選択します
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"
      }
    }
  }
}

5. 保存して 更新 をクリックします

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

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 を呼び出し、接続を確認します。

---

🎬 ライブデモ

Asset Manager アプリケーション

自然言語のプロンプトと MCP サーバーだけを使用して、完全な Maximo Asset Manager ウェブアプリケーションを構築しました。

デモの機能

機能	スクリーンショット
完全なダッシュボード	50 件のアセット、4 つの統計カード、3 つのサイト
検索フィルター
サイトフィルター

🎥 画面録画

完全な動画デモはこちらからご覧いただけます：assets_demo_recording.webp

お試しください

# Start the local proxy server
node server.js

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

---

🛠 利用可能な MCP ツール

サーバーは AI に 9 個のツール（読み取りツール 6 個と書き込み／CRUD ツール 3 個）を提供します。

読み取りツール

ツール名	説明
list_object_structures	利用可能な Maximo オブジェクト構造（API）の一覧を取得します
get_schema_details	オブジェクト構造のフィールド定義を取得します
query_maximo	OSLC REST クエリを実行します
render_carbon_table	Carbon Design の HTML テーブルを生成します
render_carbon_details	レコードの詳細ビューを生成します
get_instance_details	サーバーへの接続を確認します

書き込みツール（CRUD）

⚠️ 書き込みツールは稼働中のデータを変更します。 調査には読み取り専用の API キーを使用してください。書き込みアクセスを有効にするのは、把握済みのワークフローでのみ行ってください。

ツール名	説明
create_record	任意の Maximo オブジェクト構造に新しいレコードを作成します
update_record	ID を指定して、既存のレコードのフィールドを部分的に更新します
run_action	Maximo の業務アクション（ステータス変更、承認など）を実行します

💡 使用例

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 スクリプトの生成

「優先度1の作業指示書をすべて CSV にエクスポートする Python スクリプトを書いてください」

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 < CURRENT_DATE;

4. 完全なアプリケーションの構築

「資産を表示する HTML ダッシュボードを作成してください」

結果： 以下の機能を備えた完全なウェブアプリケーションです。

• グラスモーフィズムを取り入れたダークテーマ
• 検索およびフィルター機能
• インタラクティブな詳細パネル
• Maximo から事前に読み込まれたデータ

詳細な手順については、資産管理ケーススタディをご覧ください。

5. レコードの作成と更新（CRUD）

「BEDFORD サイト向けに、優先度1、説明『ポンプ故障の点検』の是正保全作業指示書を作成してください。」

AI は get_schema_details(MXWO) を呼び出してフィールド名を確認し、続いて 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 }

「作業指示書1025に、メモ『レビュー済み、承認済み』を付けて承認してください。」

POST /maximo/api/os/MXWO/1025?action=changeStatus&lean=1
apikey: YOUR_KEY
Content-Type: application/json

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

詳細なガイドについては、Maximo MCP サーバーガイド — CRUD ワークフローをご覧ください。

---

🧩 VS Code 拡張機能

このプロジェクトには、インタラクティブな Maximo API 開発向けの VS Code 拡張機能が2つ含まれています。AI エージェントは必要ありません。

Maximo API Explorer

Maximo REST API の検出、テスト、コード生成に対応した、フル機能の VS Code 拡張機能です。

Object Structures（MXWO、MXSR、MXASSET など）と API エンドポイントを表示した、稼働中の Maximo インスタンスへの接続画面です。

機能	説明
サイドバーのツリービュー	属性、型、関連を含むすべての Object Structures（MXWO、MXASSET、MXSR など）を参照できます
インタラクティブ API テスター	OSLC クエリを視覚的に作成し、生のリクエストを送信して、WebView パネルですべてのスキーマを確認できます
コードスニペットジェネレーター	すぐに使える API 呼び出しを cURL、Python、JavaScript、TypeScript、Java で生成します
Carbon アプリジェネレーター	ワンクリックで、作業指示書ブラウザーと資産管理ウェブアプリの完全なひな形を作成します
AI エージェント向けエクスポート	Copilot、Cursor、または任意の AI アシスタントで使用できるよう、スキーマとドキュメントを .maximo/ にエクスポートします

ライブ JSON レスポンス（200 OK、MXWO からの20件のレコード）を表示した OSLC クエリビルダーです。

クイックスタート

cd maximo-api-explorer
npm install && npm run compile
# Press F5 in VS Code to launch the Extension Development Host

詳細なガイドについては、Maximo API Explorer ガイドをご覧ください。

Maximo Cursor Explorer

Cursor の AI 機能に最適化された API Explorer のフォークです。

機能	説明
.cursorrules ジェネレーター	Cursor AI に Maximo API の深い知識を与えるルールを自動生成します
AI コンテキストのエクスポート	@file 参照で使用できるよう、スキーマを .cursor/context/ にエクスポートします
プロンプトテンプレート	OSLC クエリ、CRUD サービス、ダッシュボードなどの事前構築済みプロンプトです
すべての標準機能	API Explorer のすべての機能に加え、専用の Cursor AI タブを備えています

cd maximo-cursor-extension
npm install && npm run compile
# Press F5 in VS Code to launch

---

📁 プロジェクト構成

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

---

🔒 セキュリティのベストプラクティス

実践項目	説明
🔐 ローカル実行	MCP サーバーはお使いのマシンで実行されます。API キーが環境外に出ることはありません
📖 開発用の読み取り専用キー	調査や開発には、権限を制限した API キーを使用してください
✏️ 書き込みキーの分離	既知の CRUD ワークフローで使用する API キーにのみ、書き込み権限を付与してください
🔒 環境変数	設定ファイルに認証情報をハードコードしないでください
🌐 HTTPS のみ使用	Maximo への接続には、必ず暗号化された接続を使用してください
🧪 本番以外の環境で先にテスト	本番環境に適用する前に、必ず開発／テストインスタンスで CRUD 操作を検証してください

🤝 コントリビューション

コントリビューションを歓迎します！PR を送信する前に、コントリビューションガイドラインをお読みください。

1. リポジトリをフォークします
2. 機能ブランチを作成します（git checkout -b feature/amazing-feature）
3. 変更をコミットします（git commit -m 'Add amazing feature'）
4. ブランチにプッシュします（git push origin feature/amazing-feature）
5. プルリクエストを作成します

---

📄 ライセンス

このプロジェクトは Apache License 2.0 の下でライセンスされています。詳細については、LICENSE ファイルをご覧ください。

---

🙏 謝辞

• MCP の仕様を提供する Model Context Protocol
• エンタープライズ資産管理プラットフォームを提供する IBM Maximo
• UI コンポーネントを提供する Carbon Design System