@mxstage/mxstage
v0.2.4
Published
A local-only AI workbench for correcting IBM Maximo data: every change is staged, diffed and approved by a human before it is written to Maximo.
Maintainers
Readme
MX Stage
English | 日本語
MX Stage is a local-only AI workbench for correcting IBM Maximo data with your own AI assistant (Claude Desktop, ChatGPT, IBM Bob): every change is staged, diffed and approved by a human before it is written to Maximo.
Website: https://mxstage.tsunagi.app · Contact: [email protected]
- Your AI works on a staging sheet, not on Maximo. The AI assistant loads Maximo data into a sheet in the work screen (a browser tab), analyses it and proposes changes with reasons. You see every changed cell.
- Only a person can commit. The AI's tools cannot write to Maximo. Changes are written only when you press Commit to Maximo in the work screen. MX Stage writes one record first, checks it, then continues, and stops on conflicts. Any batch of changes can be undone before you commit.
- Nothing leaves your PC except calls to your Maximo and your AI assistant. There is no MX Stage cloud and no telemetry. The only exception is optional: if you turn on Settings → Updates → Update automatically (off by default), the bridge asks GitHub once a day for the latest version number. Installs made with the setup script then update themselves while no work is open; the Claude Desktop extension downloads and checks the new file for you to install. A small local process (the bridge) serves the work screen, talks MCP to your AI assistant and relays requests to Maximo, so Maximo needs no CORS settings. Your Maximo API key is saved on this PC by the bridge, encrypted with Windows data protection (DPAPI) or the macOS Keychain, and is never sent to the browser. Every window of the work screen — the installed app, a browser tab, or the browser inside your AI assistant — connects automatically, even after a restart, and you can switch between saved Maximo environments in Settings. (You can also connect without saving; the key then stays only in the tab's memory.)
- Teach it your procedures. Save a procedure worked out in a conversation as a Skill; the AI follows it next time.
Why not call the Maximo REST API from the AI directly?
Several Maximo MCP servers let the AI call the REST API. That is fine for reading, but risky for bulk changes: you cannot see what the AI is about to write, and a wrong guess goes straight into production. MX Stage puts a staging sheet, a diff, an undo and a human approval in between.
Supported AI assistants
| Assistant | Status | |---|---| | Claude Desktop (chat and Code tab) | Supported | | ChatGPT desktop — Codex or Work mode (Chat mode cannot use local MCP servers) | Supported | | Claude Code, Codex CLI and IDE extension, Antigravity | Work, not officially supported | | IBM Bob | Supported (registered by the installer) | | LM Studio | Coming |
Requirements
- Windows (macOS and Linux are untested)
- Node.js 22.6 or later and Git (the installer offers to install them)
- Chrome or Edge
- IBM Maximo or Maximo Application Suite (Manage) with the JSON API at
/maximo/apiand an API key
Install
Claude Desktop (simplest)
- Download
mxstage-<version>.mcpbfrom the latest release. - In Claude Desktop, open Settings → Extensions, then Advanced settings → Install Extension… and choose the file (or double-click the file, or drag it onto the Extensions page). Choose Install.
- Open
http://127.0.0.1:8788/appin Chrome or Edge and enter your Maximo URL and API key in Settings. Never paste the API key into the chat. - In a new chat, ask "show the MX Stage status".
The extension needs no Node.js or Git: Claude Desktop runs it. To use MX Stage from other assistants as well (ChatGPT desktop, IBM Bob, Claude Code in the terminal, Antigravity), use the installer below; it detects the extension and does not register MX Stage twice.
Other assistants (installer)
Ask Claude Code (or the Code tab of Claude Desktop) to install it: give it this repository's URL and say "install this". It follows Installation steps for Claude Code below and asks before running each command.
To install by hand, clone this repository to %USERPROFILE%\mxstage and run node scripts/setup-local.mjs in it.
One install registers MX Stage with every supported assistant found on this PC. Then restart the assistant you use, open mxstage on the desktop (or http://127.0.0.1:8788/app), and enter your Maximo URL and API key in Settings. Never paste the API key into the chat.
In Settings, also choose for each Maximo whether it is production or test. Committing to production needs a license (see License); everything else is free.
To update, say "update MX Stage"; to remove it, say "uninstall MX Stage" (see Uninstall).
Where it is registered
~ is %USERPROFILE%. The installer only touches assistants that are installed (Claude Desktop: its settings folder exists; Antigravity: ~\.gemini; Codex: ~\.codex; IBM Bob: ~\.bob), backs up every file before changing it (to ~\.config\mxstage\backup\), and never changes other servers' settings. node scripts/setup-local.mjs --status shows what is registered without changing anything. To leave an assistant out, add --no-claude-desktop, --no-antigravity, --no-codex or --no-bob (--no-skills copies no Skills). --claude-code registers Claude Code even when the extension is enabled.
| Assistant | MCP server | Skills | After installing or updating |
|---|---|---|---|
| Claude Code (CLI) | mcpServers.mxstage in ~\.claude.json. Not registered when the MX Stage extension (.mcpb) is enabled in Claude Desktop, because the Code tab already gets MX Stage from the extension and would show every tool twice (an entry the installer added earlier is removed). Add --claude-code to register anyway for Claude Code in a terminal (remembered for later runs) | ~\.claude\skills\<name>\SKILL.md | Restart Claude Code |
| Claude Desktop (Code tab) | Same as Claude Code, or the extension (.mcpb) when it is enabled | Same as Claude Code | Quit Claude Desktop from the system tray and open it again |
| Claude Desktop (chat) | mcpServers.mxstage in %APPDATA%\Claude\claude_desktop_config.json. Microsoft Store version: also in %LOCALAPPDATA%\Packages\Claude_<publisher ID>\LocalCache\Roaming\Claude\claude_desktop_config.json when that folder exists. Not registered when the MX Stage extension (.mcpb) is installed and enabled in Claude Desktop (an entry the installer added earlier is removed) | Not copied (see Skills) | Quit from the system tray (closing the window is not enough) and open again |
| Antigravity | mcpServers.mxstage in ~\.gemini\config\mcp_config.json | ~\.gemini\config\skills\<name>\SKILL.md | Start a new conversation |
| Codex (ChatGPT desktop, CLI, IDE extension) | [mcp_servers.mxstage] in ~\.codex\config.toml | ~\.agents\skills\<name>\SKILL.md | Restart Codex |
| IBM Bob | mcpServers.mxstage in ~\.bob\settings\mcp.json | ~\.bob\skills\<name>\SKILL.md | Restart IBM Bob |
Uninstall
Say "uninstall MX Stage" to Claude Code, or run in %USERPROFILE%\mxstage:
node scripts/setup-local.mjs --uninstallThis removes the mxstage entries from every assistant (restoring any setting the installer replaced), the Skills it copied (unless you edited them), the sign-in shortcut and desktop shortcut, and the bridge it started. It keeps your own Skills (~\.config\mxstage\skills\) and the backups. To remove everything, also delete %USERPROFILE%\mxstage and ~\.config\mxstage (the backups are full copies of the original settings files, including any tokens in them), and clear the site data for 127.0.0.1:8788 in your browser.
Installation steps for Claude Code
When the user asks to install MX Stage, follow these steps and get the user's approval before each command.
- Check prerequisites:
node --version(22.6 or later) andgit --version. If missing, with the user's agreement install them withwinget install OpenJS.NodeJS.LTS/winget install Git.Git, then confirmnodeandgitwork in a new shell. - Get the code into
%USERPROFILE%\mxstage(~/mxstageon macOS and Linux):- if it does not exist:
git clone <this repository URL> "%USERPROFILE%\mxstage" - if it exists:
git pull --ff-onlyin it (if local changes block it, stop and tell the user)
- if it does not exist:
- Install: in that folder run
node scripts/setup-local.mjs --json. This also runsnpm installand builds the work screen. Do not usemxstage.cmd(it waits for a key press at the end). - Read the result: success if no item in
stepshas"level": "error". Forerrororwarn, tell the user itsmessageandhintand follow thehint. Do not edit settings files by guesswork. - Tell the user to restart the assistant they use, to enter the Maximo URL and API key in the work screen settings (
http://127.0.0.1:8788/app), and never to paste the API key into the chat.
Update: steps 2 to 4. Ask the user to restart their assistant afterwards so the new bridge is used. Uninstall: node scripts/setup-local.mjs --uninstall --json. Status: node scripts/setup-local.mjs --status --json (changes nothing).
Skills
A Skill is a procedure the AI assistant follows.
| | Location | Contents | Updates |
|---|---|---|---|
| Built-in | skills/ in this repository (mxstage-workbench) | The basic procedure and rules for every task | Replaced with MX Stage updates; do not edit |
| Yours | ~/.config/mxstage/skills/<name>/SKILL.md | Procedures for your tasks or customers | Yours; kept across updates and never sent anywhere |
- Every assistant gets the basic procedure: it is attached to the result of the first tool call in each conversation, so assistants that cannot load Skill files (Claude Desktop chat, for example) follow the same rules.
- Create Skills from the chat: say "save this procedure as a Skill". The AI shows the name, description and body, and saves it after you agree.
- Run the installer again to copy new or changed Skills to each assistant.
Documentation
The detailed guides are in Japanese for now:
- docs/local.md — daily use, updates, troubleshooting
- docs/status.md — what works today
- docs/publish.md — checks before publishing
Development
npm run typecheck # tsc (app and bridge)
npx vitest run # tests (app and bridge)
npm run test:setup # installer tests (write only to temporary folders)
npm run build # build the built-in Skill and the work screen (dist/app)
npm run dev:app # dev server for the work screen (http://localhost:5173/app?demo=1 shows sample data; relays to the dev bridge on 8790)
npm run dev:fake-maximo # a fake Maximo at https://127.0.0.1:9797 (API key: test-api-key)
npm run dev:bridge # a bridge on port 8790 that accepts the development license for the fake MaximoDisable IBM telemetry when installing dependencies ($env:IBM_TELEMETRY_DISABLED='true'; npm install in PowerShell); the installer does this itself. See dev/README.md for developing and testing license checks.
Only test commits against a development Maximo with dummy data. There is no automatic rollback of changes written to Maximo.
License
MX Stage is licensed under the Business Source License 1.1. The source is available, but it is not open source. The LICENSE file is authoritative; this is a summary.
- Free: everything except committing to a production Maximo — loading, analysing and editing production data, building Skills, and committing to test environments. You may read, modify and redistribute the source under the same license.
- License needed: using MX Stage to create, change or delete data in a production Maximo environment — US$4,800 per production environment per year, for any number of users and PCs. The license key names the environment's URLs (up to three aliases). Pricing.
- Production environment: the Maximo your organization uses to record day-to-day operations, and an environment being prepared to replace it (for example, a migration target before go-live). Test environment: everything else (development, test, training, demonstration, migration rehearsal), even if it holds a copy of production data.
- Each version becomes Apache License 2.0 four years after its release.
- Third-party packages and fonts (IBM Carbon Design System, IBM Plex and others) keep their own licenses (THIRD_PARTY_NOTICES.md).
IBM and Maximo are trademarks of International Business Machines Corporation. MX Stage is an independent product and is not affiliated with or endorsed by IBM.
