pms-analysis-reports-mcp-server/README.md

PMS analysis reports server handling maintenance reports, equipment analysis, compliance tracking, and performance metrics with ERP access for data extraction

# PMS Analysis Reports MCP Server

A Model Context Protocol (MCP) server for Planned Maintenance System (PMS) analysis reports, maintenance tracking, compliance monitoring, and performance analytics.

## Features

- **Search PMS Analysis Reports**: Universal search tool for maintenance records, compliance data, and performance metrics
- **AI-Powered Analysis**: Generate comprehensive maintenance analysis reports with AI insights
- **Equipment Status Tracking**: Monitor equipment status and maintenance schedules
- **Compliance Monitoring**: Track compliance requirements and status
- **Performance Analytics**: Analyze equipment performance and maintenance trends

## Tools

### 1. search_pms_analysis_reports
Universal search tool for PMS analysis reports, maintenance records, compliance data, and performance metrics.

**Features:**
- Natural language and keyword search
- Advanced filtering by vessel, equipment type, status, dates, etc.
- Pagination support
- Multiple sorting options

### 2. generate_maintenance_analysis_report
Generate comprehensive maintenance analysis reports using AI-powered insights.

**Features:**
- Multiple report types (equipment status, maintenance trends, compliance summary, etc.)
- AI-generated recommendations
- Various output formats (markdown, JSON, text, HTML)
- Customizable detail levels

## Installation

```bash
npm install pms-analysis-reports-mcp-server
```

## Usage

### Command Line
```bash
pms-analysis-reports-mcp-server --mongo-uri "mongodb://localhost:27017" --db-name "pms_analysis"
```

### Development
```bash
npm run dev
```

### Build
```bash
npm run build
```

### Test
```bash
npm test
```

## Configuration

The server can be configured using command-line arguments or environment variables:

- `--mongo-uri` / `MONGO_URI`: MongoDB connection URI
- `--db-name` / `DB_NAME`: Database name
- `--typesense-host` / `TYPESENSE_HOST`: Typesense server host
- `--typesense-port` / `TYPESENSE_PORT`: Typesense server port
- `--typesense-api-key` / `TYPESENSE_API_KEY`: Typesense API key
- `--openai-api-key` / `OPENAI_API_KEY`: OpenAI API key for AI analysis

## Dependencies

- MongoDB for data storage
- Typesense for search functionality
- OpenAI for AI-powered analysis
- Winston for logging

## License

MIT

## Contributing

Please read the contributing guidelines before submitting pull requests.