# CMMS MCP Server
A Model Context Protocol (MCP) server that integrates with MES (Manufacturing Execution System), CMMS (Computerized Maintenance Management System), and IoT systems. This server provides tools and resources to interact with manufacturing, maintenance, and IoT data.
## Features
### MES Integration
- **Production Orders**: Query production orders by status or ID
- **Work Orders**: Get work orders filtered by status or production order
- **Equipment**: Monitor equipment status and details
### CMMS Integration
- **Maintenance Tasks**: Query, filter, and create maintenance tasks
- **Assets**: Get asset information and status
- **Maintenance History**: Access historical maintenance records
### IoT Integration
- **Sensors**: Query sensor information and configurations
- **Sensor Readings**: Get real-time and historical sensor data
- **Devices**: Monitor IoT device status
- **Alerts**: View and acknowledge IoT alerts
## Installation
1. Install dependencies:
```bash
npm install
```
2. Build the project:
```bash
npm run build
```
## Usage
### Running the Server
The server runs on stdio and can be used with MCP-compatible clients:
```bash
npm start
```
For development with auto-reload:
```bash
npm run dev
```
### MCP Client Configuration
Add this server to your MCP client configuration (e.g., in Claude Desktop's `claude_desktop_config.json`):
```json
{
"mcpServers": {
"cmms-mcp-server": {
"command": "node",
"args": ["/path/to/cmms-mcp-server/dist/index.js"]
}
}
}
```
## Available Tools
### MES Tools
#### `get_production_orders`
Get production orders from MES system.
**Parameters:**
- `status` (optional): Filter by status (`planned`, `in-progress`, `completed`, `cancelled`)
- `orderId` (optional): Get specific production order by ID
**Example:**
```json
{
"status": "in-progress"
}
```
#### `get_work_orders`
Get work orders from MES system.
**Parameters:**
- `status` (optional): Filter by status (`pending`, `in-progress`, `completed`, `on-hold`)
- `productionOrderId` (optional): Filter by production order ID
#### `get_equipment`
Get equipment status from MES system.
**Parameters:**
- `status` (optional): Filter by status (`running`, `idle`, `maintenance`, `error`)
- `equipmentId` (optional): Get specific equipment by ID
### CMMS Tools
#### `get_maintenance_tasks`
Get maintenance tasks from CMMS system.
**Parameters:**
- `status` (optional): Filter by status (`scheduled`, `in-progress`, `completed`, `cancelled`, `overdue`)
- `priority` (optional): Filter by priority (`low`, `medium`, `high`, `critical`)
- `taskType` (optional): Filter by type (`preventive`, `corrective`, `inspection`, `calibration`)
- `assetId` (optional): Filter by asset ID
#### `get_assets`
Get assets from CMMS system.
**Parameters:**
- `status` (optional): Filter by status (`operational`, `maintenance`, `out-of-service`, `retired`)
- `assetId` (optional): Get specific asset by ID
#### `get_maintenance_history`
Get maintenance history from CMMS system.
**Parameters:**
- `assetId` (optional): Filter by asset ID
- `startDate` (optional): Start date for history (ISO format)
- `endDate` (optional): End date for history (ISO format)
#### `create_maintenance_task`
Create a new maintenance task in CMMS system.
**Required Parameters:**
- `assetId`: Asset ID for the maintenance task
- `taskType`: Type of maintenance task (`preventive`, `corrective`, `inspection`, `calibration`)
- `priority`: Priority of the task (`low`, `medium`, `high`, `critical`)
- `scheduledDate`: Scheduled date (ISO format)
- `dueDate`: Due date (ISO format)
- `assignedTo`: Technician ID assigned to the task
- `description`: Description of the maintenance task
**Optional Parameters:**
- `estimatedDuration`: Estimated duration in minutes (default: 240)
**Example:**
```json
{
"assetId": "asset-001",
"taskType": "preventive",
"priority": "high",
"scheduledDate": "2024-02-15T08:00:00Z",
"dueDate": "2024-02-15T17:00:00Z",
"assignedTo": "tech-001",
"description": "Monthly preventive maintenance",
"estimatedDuration": 480
}
```
### IoT Tools
#### `get_sensors`
Get sensors from IoT system.
**Parameters:**
- `type` (optional): Filter by type (`temperature`, `pressure`, `vibration`, `humidity`, `flow`, `level`)
- `status` (optional): Filter by status (`active`, `inactive`, `error`)
- `equipmentId` (optional): Filter by equipment ID
#### `get_sensor_readings`
Get sensor readings from IoT system.
**Parameters:**
- `sensorId` (optional): Filter by sensor ID
- `status` (optional): Filter by reading status (`normal`, `warning`, `critical`)
- `hours` (optional): Get readings from last N hours
#### `get_devices`
Get IoT devices.
**Parameters:**
- `status` (optional): Filter by status (`online`, `offline`, `error`)
- `type` (optional): Filter by device type
#### `get_alerts`
Get IoT alerts.
**Parameters:**
- `severity` (optional): Filter by severity (`info`, `warning`, `critical`)
- `acknowledged` (optional): Filter by acknowledged status (boolean)
- `deviceId` (optional): Filter by device ID
#### `acknowledge_alert`
Acknowledge an IoT alert.
**Required Parameters:**
- `alertId`: Alert ID to acknowledge
- `acknowledgedBy`: User ID acknowledging the alert
## Available Resources
The server provides the following resources:
- `mes://production-orders` - All production orders from MES system
- `mes://equipment` - All equipment from MES system
- `cmms://maintenance-tasks` - All maintenance tasks from CMMS system
- `cmms://assets` - All assets from CMMS system
- `iot://sensors` - All sensors from IoT system
- `iot://alerts` - All active (unacknowledged) alerts from IoT system
## Mock Data
This server currently uses mock data for demonstration purposes. The mock data includes:
- **MES**: 3 production orders, 3 work orders, 4 equipment items
- **CMMS**: 4 maintenance tasks, 4 assets, 2 maintenance history records
- **IoT**: 5 sensors, 6 sensor readings, 4 devices, 4 alerts
To connect to real systems, replace the mock data imports in `src/index.ts` with actual API clients.
## Project Structure
```
cmms-mcp-server/
├── src/
│ ├── index.ts # Main server implementation
│ └── mock-data/
│ ├── mes-data.ts # MES mock data
│ ├── cmms-data.ts # CMMS mock data
│ └── iot-data.ts # IoT mock data
├── dist/ # Compiled JavaScript (generated)
├── package.json
├── tsconfig.json
└── README.md
```
## Testing
See [TESTING.md](./TESTING.md) for detailed testing instructions.
Quick test:
```bash
npm test
```
## Development
### Building
```bash
npm run build
```
### Development Mode
```bash
npm run dev
```
This runs the server in watch mode with auto-reload using `tsx`.
## License
MIT
