Skip to content

Commit 9453834

Browse files
committed
update conf in readme
1 parent 4ca9823 commit 9453834

File tree

2 files changed

+15
-97
lines changed

2 files changed

+15
-97
lines changed

README.md

Lines changed: 15 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -282,79 +282,11 @@ pip install -e .
282282

283283
### Claude Desktop
284284

285-
Add to your Claude Desktop config (`%APPDATA%\Claude\claude_desktop_config.json` on Windows, `~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
285+
Add to your Claude Desktop config:
286+
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
287+
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
286288

287-
> 📋 **Example configs**: See [`claude_desktop_config_EXAMPLE.json`](claude_desktop_config_EXAMPLE.json) (using UV) and [`claude_desktop_config_PYTHON_VENV.json`](claude_desktop_config_PYTHON_VENV.json) (using Python virtual environment)
288-
289-
<details>
290-
<summary>Using NPX (recommended for easy installation)</summary>
291-
292-
```json
293-
{
294-
"mcpServers": {
295-
"predictive-maintenance": {
296-
"command": "uvx",
297-
"args": ["predictive-maintenance-mcp"]
298-
}
299-
}
300-
}
301-
```
302-
303-
> **Note**: `uvx` automatically manages the Python environment and dependencies. This is the recommended installation method.
304-
305-
</details>
306-
307-
<details>
308-
<summary>Using pip installation</summary>
309-
310-
```json
311-
{
312-
"mcpServers": {
313-
"predictive-maintenance": {
314-
"command": "predictive-maintenance-mcp"
315-
}
316-
}
317-
}
318-
```
319-
320-
> **Prerequisites**: Install first with `pip install predictive-maintenance-mcp` or `pipx install predictive-maintenance-mcp`
321-
322-
</details>
323-
324-
<details>
325-
<summary>Using UV</summary>
326-
327-
```json
328-
{
329-
"mcpServers": {
330-
"predictive-maintenance": {
331-
"command": "npx",
332-
"args": ["-y", "predictive-maintenance-mcp"]
333-
}
334-
}
335-
}
336-
```
337-
338-
</details>
339-
340-
<details>
341-
<summary>Using UV</summary>
342-
343-
```json
344-
{
345-
"mcpServers": {
346-
"predictive-maintenance": {
347-
"command": "uvx",
348-
"args": ["predictive-maintenance-mcp"]
349-
}
350-
}
351-
}
352-
```
353-
354-
</details>
355-
356-
<details>
357-
<summary>Using Python (from source)</summary>
289+
> 📋 **Example config**: See [`claude_desktop_config_PYTHON_VENV.json`](claude_desktop_config_PYTHON_VENV.json) for a complete example
358290
359291
```json
360292
{
@@ -367,31 +299,31 @@ Add to your Claude Desktop config (`%APPDATA%\Claude\claude_desktop_config.json`
367299
}
368300
```
369301

370-
> **Note**: Replace `C:/path/to/predictive-maintenance-mcp` with your actual project path. Use **absolute paths** for both command and args.
302+
> **Important Notes**:
303+
> - Replace `C:/path/to/predictive-maintenance-mcp` with your actual project path
304+
> - Use **absolute paths** for both `command` and `args`
305+
> - On macOS/Linux, use `.venv/bin/python` instead of `.venv/Scripts/python.exe`
306+
> - Forward slashes (`/`) work on all platforms, including Windows
371307
372-
</details>
308+
After configuration, **restart Claude Desktop** completely.
373309

374310
### VS Code
375311

376-
For manual installation, add to your MCP configuration:
377-
378-
**Method 1: User Configuration (Recommended)**
379-
Open Command Palette (`Ctrl + Shift + P`) → `MCP: Open User Configuration`
380-
381-
**Method 2: Workspace Configuration**
382-
Create `.vscode/mcp.json` in your workspace
312+
Add to your MCP configuration (`.vscode/mcp.json` or user settings):
383313

384314
```json
385315
{
386316
"servers": {
387317
"predictive-maintenance": {
388-
"command": "npx",
389-
"args": ["-y", "predictive-maintenance-mcp"]
318+
"command": "/path/to/predictive-maintenance-mcp/.venv/bin/python",
319+
"args": ["/path/to/predictive-maintenance-mcp/src/machinery_diagnostics_server.py"]
390320
}
391321
}
392322
}
393323
```
394324

325+
> Adjust paths according to your system (use `.venv/Scripts/python.exe` on Windows)
326+
395327
## Sample Dataset
396328

397329
The server includes **15 real bearing vibration signals** from production machinery:

claude_desktop_config_EXAMPLE.json

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)