maximo-mcp-artifacts

soumyaprasadrana/maximo-mcp-artifacts

3.2

If you are the rightful owner of maximo-mcp-artifacts and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to dayong@mcphub.com.

Maximo MCP is a server deployment solution that simplifies the installation and management of the Maximo MCP Server using versioned build artifacts.

Maximo MCP – Installation Artifacts

This repository provides the installation script and versioned build artifacts for deploying the Maximo MCP Server.

The MCP server bundle for each version is distributed as a ZIP file under GitHub Releases. The installer downloads the correct version, extracts it, installs dependencies, and generates a start-server.sh script with your provided runtime environment variables embedded.

No .env file is used.


1. Requirements

Before installing, ensure the target machine has:

  • Node.js 18+
  • npm
  • curl
  • unzip
  • bash

2. Installation

Use the installer and specify the release version you want to deploy:

curl -sSL https://raw.githubusercontent.com/soumyaprasadrana/maximo-mcp-artifacts/main/mcp-installer.sh | bash -s \
  VERSION=1.0.0 \
  MAXIMO_URL=https://your-maximo-server.com \
  MAXIMO_API_KEY=your-api-key \
  MCP_DATA_BASE_DIR=/opt/mcp \
  MCP_LOG_TO_CONSOLE=true

What this command does:

  1. Downloads the ZIP for v1.0.0 from GitHub Releases
  2. Extracts it into maximo-mcp/ (or into INSTALL_DIR if provided)
  3. Installs production dependencies (npm install --omit=dev)
  4. Generates a start-server.sh that exports all environment variables you passed
  5. Does not start the server automatically

This ensures the server always runs with the same environment configuration that was provided at install time.


3. Starting the Server

After installation:

cd maximo-mcp/<extracted-folder>/
./start-server.sh

This script:

  1. Exports all environment variables passed during installation
  2. Starts the MCP server from the official entry point:
node server/index.js

4. Update to a New Version

Simply install the new version:

curl -sSL https://raw.githubusercontent.com/soumyaprasadrana/maximo-mcp-artifacts/main/mcp-installer.sh | bash -s \
  VERSION=1.1.0 \
  MAXIMO_URL=https://your-maximo-server.com \
  MAXIMO_API_KEY=your-api-key

Each installation is isolated within its own directory.


5. Environment Variables

Any variable passed to the installer in the form KEY=value will be:

  • exported into the installer environment
  • persisted inside start-server.sh
  • exported again when the server starts

Commonly used variables:

VariableMeaning
MAXIMO_URLMaximo base URL
MAXIMO_API_KEYAPI key for OSLC APIs
MAXIMO_METADATA_API_KEYAPI key for metadata APIs
MCP_DATA_BASE_DIRDirectory for logs / data
MCP_TRANSPORTstdio or http
MCP_LOG_TO_CONSOLEEnable console logging
MCP_LOG_FILE_PATHLog file path
MCP_SERVER_DEBUGDebug mode
MCP_SERVER_PORTRequired when using http transport
INSTALL_DIROptional install directory

You may also pass custom variables; all will be persisted.


6. Release Artifacts

All ZIP bundles for MCP releases are published under GitHub Releases:

https://github.com/soumyaprasadrana/maximo-mcp-artifacts/releases/tag/v<version>

Each release contains:

maximo-mcp-v<version>.zip

which includes:

server/index.js
node_modules/ (installed by installer)
start-server.sh (generated by installer)

7. Uninstalling

Simply delete the installation directory:

rm -rf maximo-mcp

(or whatever directory was used via INSTALL_DIR=)


8. Notes

  • The installer does not run the server automatically.

  • The server is started manually using:

    ./start-server.sh
    
  • No .env file is generated or required.

  • All environment variables are fully controlled by the user.