Skip to content

Commit 4acc568

Browse files
committed
readme update: version
1 parent 9453834 commit 4acc568

File tree

3 files changed

+87
-32
lines changed

3 files changed

+87
-32
lines changed

CITATION.cff

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
cff-version: 1.2.0
22
message: "If you use this software, please cite it as below."
3-
title: "Predictive Maintenance MCP Server"
4-
version: 0.2.0
5-
date-released: 2025-11-12
3+
title: "Predictive Maintenance MCP Server: A Proof of Concept"
4+
version: 0.3.0
5+
date-released: 2025-01-16
66
authors:
77
- family-names: Di Maggio
88
given-names: Luigi Gianpio
@@ -12,24 +12,34 @@ authors:
1212
repository-code: "https://github.com/LGDiMaggio/predictive-maintenance-mcp"
1313
url: "https://github.com/LGDiMaggio/predictive-maintenance-mcp"
1414
abstract: >
15-
A Model Context Protocol server that brings industrial machinery
16-
diagnostics directly to Large Language Models like Claude, enabling
17-
AI-powered vibration analysis, bearing fault detection, and predictive
18-
maintenance through natural conversation. Features include FFT spectrum
19-
analysis, envelope analysis for bearing faults, ISO 20816-3 compliance
20-
checks, and ML anomaly detection with interactive HTML reports.
15+
A Proof of Concept Model Context Protocol server demonstrating how Large
16+
Language Models like Claude can be empowered with industrial machinery
17+
diagnostics capabilities. Features real vibration data (15 bearing fault
18+
signals), FFT spectrum analysis, envelope analysis for bearing faults,
19+
ISO 20816-3 compliance checks, ML anomaly detection with semi-supervised
20+
learning, and interactive HTML reports. Demonstrates the feasibility of
21+
natural language interfaces for complex industrial diagnostics workflows.
2122
keywords:
23+
- signal-processing
24+
- iiot
25+
- predictive-analytics
26+
- anomaly-detection
27+
- asset-management
28+
- envelope-analysis
2229
- predictive-maintenance
23-
- vibration-analysis
2430
- condition-monitoring
25-
- bearing-fault-detection
31+
- machine-failure
32+
- bearing-fault-diagnosis
33+
- industrial-iot
34+
- fault-diagnosis
35+
- vibration-analysis
36+
- claude-ai
37+
- industry-4-0
2638
- model-context-protocol
27-
- mcp
28-
- fft-analysis
29-
- envelope-analysis
30-
- iso-20816
31-
- machine-learning
32-
- anomaly-detection
39+
- mcp-server
40+
- fastmcp
41+
- iso10816
42+
- claude-agents
3343
license: MIT
3444
# Zenodo DOI
3545
# identifiers:
@@ -38,11 +48,11 @@ license: MIT
3848
# description: "Zenodo DOI for this version"
3949
preferred-citation:
4050
type: software
41-
title: "Predictive Maintenance MCP Server"
51+
title: "Predictive Maintenance MCP Server: A Proof of Concept"
4252
authors:
4353
- family-names: Di Maggio
4454
given-names: Luigi Gianpio
4555
year: 2025
46-
version: 0.2.0
56+
version: 0.3.0
4757
repository-code: "https://github.com/LGDiMaggio/predictive-maintenance-mcp"
4858
license: MIT

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ A Model Context Protocol server that brings **industrial machinery diagnostics**
1515
## 📑 Table of Contents
1616

1717
- [✨ What Makes This Special](#-what-makes-this-special)
18+
- [🔬 Proof of Concept & Community Invitation](#-proof-of-concept--community-invitation)
1819
- [🎬 Quick Examples](#-quick-examples)
1920
- [🚀 Installation](#-installation)
2021
- [Configuration](#configuration)
@@ -42,6 +43,44 @@ A Model Context Protocol server that brings **industrial machinery diagnostics**
4243
- **🔍 Advanced Diagnostics** - FFT spectrum analysis, envelope analysis for bearing faults, time-domain feature extraction
4344
- **🚀 Zero Configuration** - Works out of the box with sample data, auto-detects sampling rates from metadata
4445

46+
## 🔬 Proof of Concept & Community Invitation
47+
48+
**This is a Proof of Concept (PoC)** - a demonstration of feasibility showing how LLMs can be empowered with industrial diagnostics capabilities through the Model Context Protocol.
49+
50+
### PoC Goals Achieved ✅
51+
52+
-**Real vibration data integration** - 15 bearing fault signals with metadata
53+
-**Professional analysis workflows** - FFT spectrum, envelope analysis, ISO 20816-3 compliance
54+
-**ML anomaly detection** - Semi-supervised learning with hyperparameter tuning
55+
-**Metadata-driven auto-detection** - Sampling rates and signal units from JSON files
56+
-**Interactive HTML reports** - Plotly visualizations with automatic peak detection
57+
-**Natural language interface** - Complex diagnostics through conversational AI
58+
59+
### 🤝 We Invite the Community to Contribute!
60+
61+
This PoC demonstrates the potential - now we need **your expertise** to make it production-ready.
62+
63+
**How You Can Help:**
64+
65+
- **📊 Add More Data** - Real-world vibration datasets from different machines/sensors/industries
66+
- **🔧 Expand Diagnostics** - Gear fault detection, pump cavitation, motor electrical faults, misalignment
67+
- **🤖 Improve ML** - Deep learning approaches, advanced anomaly models, real-time streaming analysis
68+
- **📏 Standards Compliance** - Additional ISO standards (10816, 14839), NIST guidelines, API 670
69+
- **🌍 Internationalization** - Multi-language support, regional standards (VDI, GB)
70+
- **📖 Documentation** - Tutorials, case studies, industrial validation, best practices
71+
- **🐛 Testing** - Edge cases, validation with ground truth data, cross-validation studies
72+
73+
**Get Involved:**
74+
75+
- 🐛 **Report issues**: [GitHub Issues](https://github.com/LGDiMaggio/predictive-maintenance-mcp/issues)
76+
- 💡 **Suggest features**: [Discussions](https://github.com/LGDiMaggio/predictive-maintenance-mcp/discussions)
77+
- 🔀 **Submit PRs**: See [CONTRIBUTING.md](CONTRIBUTING.md)
78+
- 💬 **Join the conversation**: [LinkedIn](https://www.linkedin.com/in/luigi-gianpio-di-maggio)
79+
80+
**Why This Matters:**
81+
82+
Predictive maintenance is critical for Industry 4.0, but expertise is scarce and analysis tools are fragmented. By combining LLM reasoning with diagnostic tools through MCP, we can **democratize access to expert-level machinery diagnostics** and make industrial AI more accessible to engineers worldwide.
83+
4584
## 🎬 Quick Examples
4685

4786
### Example 1: Bearing Fault Detection
@@ -496,13 +535,13 @@ The system now includes a hybrid documentation reader that combines:
496535
**Known Limitations:**
497536
- PDF reading requires PyPDF2 (optional dependency)
498537
- Limited bearing catalog (extensible)
499-
- No OCR for scanned PDFs (planned for v0.3.0)
538+
- No OCR for scanned PDFs (planned for v0.4.0)
500539

501540
See [resources/machine_manuals/README.md](resources/machine_manuals/README.md) for usage guide.
502541

503542
---
504543

505-
### 🔮 Planned for v0.3.0
544+
### 🔮 Planned for v0.4.0
506545

507546
#### 🔍 Vector Search for Large Documents
508547
For manuals >100 pages, semantic search will be more efficient:

pyproject.toml

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,34 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "predictive-maintenance-mcp"
7-
version = "0.2.0"
8-
description = "AI-Powered Predictive Maintenance & Fault Diagnosis MCP Server - Industrial machinery condition monitoring, vibration analysis, bearing diagnostics, and ML-based anomaly detection through Model Context Protocol"
7+
version = "0.3.0"
8+
description = "Proof of Concept: AI-Powered Predictive Maintenance & Fault Diagnosis MCP Server - Industrial machinery condition monitoring, vibration analysis, bearing diagnostics, and ML-based anomaly detection through Model Context Protocol"
99
readme = "README.md"
1010
authors = [
1111
{ name = "Luigi Di Maggio", email = "luigi.dimaggio@example.com" }
1212
]
1313
license = { text = "MIT" }
1414
keywords = [
15+
"signal-processing",
16+
"iiot",
17+
"predictive-analytics",
18+
"anomaly-detection",
19+
"asset-management",
20+
"envelope-analysis",
1521
"predictive-maintenance",
1622
"condition-monitoring",
23+
"machine-failure",
24+
"bearing-fault-diagnosis",
25+
"industrial-iot",
1726
"fault-diagnosis",
1827
"vibration-analysis",
19-
"mcp-server",
2028
"claude-ai",
21-
"machine-learning",
22-
"anomaly-detection",
23-
"bearing-diagnostics",
24-
"fft",
25-
"envelope-analysis",
26-
"iso-20816",
27-
"industrial-iot",
28-
"industry-4-0"
29+
"industry-4-0",
30+
"model-context-protocol",
31+
"mcp-server",
32+
"fastmcp",
33+
"iso10816",
34+
"claude-agents"
2935
]
3036
classifiers = [
3137
"Development Status :: 4 - Beta",

0 commit comments

Comments
 (0)