system-health-mcp 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +63 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,23 +15,79 @@ A Model Context Protocol (MCP) server that provides real-time system health moni
|
|
|
15
15
|
- TypeScript
|
|
16
16
|
- npm or yarn
|
|
17
17
|
|
|
18
|
-
## Installation
|
|
18
|
+
## Installation (from npm)
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
You can install and run this MCP server directly from npm:
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
|
-
|
|
24
|
-
|
|
23
|
+
npm install -g system-health-mcp
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Then run the server:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
system-health-mcp
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Or, if you want to use it locally in a project:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npm install system-health-mcp
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Then run:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npx system-health-mcp
|
|
25
42
|
```
|
|
26
43
|
|
|
27
|
-
|
|
44
|
+
You do **not** need to clone the repository if installing from npm.
|
|
28
45
|
|
|
29
|
-
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Installation (from source)
|
|
49
|
+
|
|
50
|
+
git clone <repository-url>
|
|
51
|
+
cd system-health-mcp
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
git clone https://github.com/jvdub/system-health-mcp.git
|
|
55
|
+
cd system-health-mcp
|
|
56
|
+
npm install
|
|
57
|
+
npx tsc
|
|
58
|
+
```
|
|
30
59
|
|
|
31
60
|
## Configuration
|
|
32
61
|
|
|
33
62
|
To use this MCP server with an MCP-compatible client (like Claude Desktop), add the following configuration to your client's MCP settings file:
|
|
34
63
|
|
|
64
|
+
### If installed globally from npm:
|
|
65
|
+
|
|
66
|
+
```json
|
|
67
|
+
{
|
|
68
|
+
"mcpServers": {
|
|
69
|
+
"system-health": {
|
|
70
|
+
"command": "system-health-mcp"
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### If installed locally in a project:
|
|
77
|
+
|
|
78
|
+
```json
|
|
79
|
+
{
|
|
80
|
+
"mcpServers": {
|
|
81
|
+
"system-health": {
|
|
82
|
+
"command": "npx",
|
|
83
|
+
"args": ["system-health-mcp"]
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### If running from source:
|
|
90
|
+
|
|
35
91
|
```json
|
|
36
92
|
{
|
|
37
93
|
"mcpServers": {
|
|
@@ -43,7 +99,7 @@ To use this MCP server with an MCP-compatible client (like Claude Desktop), add
|
|
|
43
99
|
}
|
|
44
100
|
```
|
|
45
101
|
|
|
46
|
-
**Important**:
|
|
102
|
+
**Important**: For the source install, replace `/path/to/your/project/index.js` with the absolute path to the built `index.js` file in your cloned repository.
|
|
47
103
|
|
|
48
104
|
### Example Configuration Locations
|
|
49
105
|
|