ntfy-mcp-server 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 +67 -6
- package/package.json +9 -6
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.typescriptlang.org/)
|
|
4
4
|
[](https://modelcontextprotocol.io/)
|
|
5
|
-
[](https://github.com/cyanheads/ntfy-mcp-server/releases)
|
|
6
6
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
7
7
|
[](https://github.com/cyanheads/ntfy-mcp-server)
|
|
8
8
|
[](https://github.com/cyanheads/ntfy-mcp-server)
|
|
@@ -65,11 +65,12 @@ This server implements the Model Context Protocol (MCP), enabling standardized c
|
|
|
65
65
|
2. **Install and Run:**
|
|
66
66
|
|
|
67
67
|
```bash
|
|
68
|
-
#
|
|
68
|
+
# Option 1: Install via npm
|
|
69
|
+
npm install -g ntfy-mcp-server
|
|
70
|
+
|
|
71
|
+
# Option 2: Clone repository and build
|
|
69
72
|
git clone https://github.com/cyanheads/ntfy-mcp-server.git
|
|
70
73
|
cd ntfy-mcp-server
|
|
71
|
-
|
|
72
|
-
# Install dependencies and build
|
|
73
74
|
npm install
|
|
74
75
|
npm run build
|
|
75
76
|
|
|
@@ -87,7 +88,27 @@ This server implements the Model Context Protocol (MCP), enabling standardized c
|
|
|
87
88
|
|
|
88
89
|
## Installation
|
|
89
90
|
|
|
90
|
-
1
|
|
91
|
+
### Option 1: NPM Package (Recommended)
|
|
92
|
+
|
|
93
|
+
1. **Install the package globally:**
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
npm install -g ntfy-mcp-server
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
This will install the server globally, making it available as a command-line tool.
|
|
100
|
+
|
|
101
|
+
2. **Or install locally in your project:**
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
npm install ntfy-mcp-server
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
When installed locally, you can run it via npx or from node.
|
|
108
|
+
|
|
109
|
+
### Option 2: From Source
|
|
110
|
+
|
|
111
|
+
1. **Clone the repository:**
|
|
91
112
|
|
|
92
113
|
```bash
|
|
93
114
|
git clone https://github.com/cyanheads/ntfy-mcp-server.git
|
|
@@ -127,6 +148,26 @@ NODE_ENV=development # Optional: Environment (development, production)
|
|
|
127
148
|
|
|
128
149
|
Add the following configuration to your Cline MCP settings file (usually located at `~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json` on macOS):
|
|
129
150
|
|
|
151
|
+
##### If installed globally:
|
|
152
|
+
|
|
153
|
+
```json
|
|
154
|
+
{
|
|
155
|
+
"mcpServers": {
|
|
156
|
+
"ntfy": {
|
|
157
|
+
"command": "ntfy-mcp-server",
|
|
158
|
+
"env": {
|
|
159
|
+
"NTFY_BASE_URL": "https://ntfy.sh",
|
|
160
|
+
"NTFY_DEFAULT_TOPIC": "your_default_topic",
|
|
161
|
+
"LOG_LEVEL": "info",
|
|
162
|
+
"NODE_ENV": "production"
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
##### If installed from source:
|
|
170
|
+
|
|
130
171
|
```json
|
|
131
172
|
{
|
|
132
173
|
"mcpServers": {
|
|
@@ -148,6 +189,26 @@ Add the following configuration to your Cline MCP settings file (usually located
|
|
|
148
189
|
|
|
149
190
|
Add the following configuration to your Claude Desktop config file (usually located at `~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
|
|
150
191
|
|
|
192
|
+
##### If installed globally:
|
|
193
|
+
|
|
194
|
+
```json
|
|
195
|
+
{
|
|
196
|
+
"mcpServers": {
|
|
197
|
+
"ntfy": {
|
|
198
|
+
"command": "ntfy-mcp-server",
|
|
199
|
+
"env": {
|
|
200
|
+
"NTFY_BASE_URL": "https://ntfy.sh",
|
|
201
|
+
"NTFY_DEFAULT_TOPIC": "your_default_topic",
|
|
202
|
+
"LOG_LEVEL": "info",
|
|
203
|
+
"NODE_ENV": "production"
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
##### If installed from source:
|
|
211
|
+
|
|
151
212
|
```json
|
|
152
213
|
{
|
|
153
214
|
"mcpServers": {
|
|
@@ -165,7 +226,7 @@ Add the following configuration to your Claude Desktop config file (usually loca
|
|
|
165
226
|
}
|
|
166
227
|
```
|
|
167
228
|
|
|
168
|
-
|
|
229
|
+
_For source installation, replace `/path/to/ntfy-mcp-server/dist/index.js` with the actual absolute path to the built server file._
|
|
169
230
|
_Adjust `env` variables as needed for your setup._
|
|
170
231
|
|
|
171
232
|
### Ntfy Setup
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ntfy-mcp-server",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "1.0.1",
|
|
4
|
+
"description": "An MCP (Model Context Protocol) server designed to interact with the ntfy push notification service. It enables LLMs and AI agents to send notifications to your devices with extensive customization options.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"files": [
|
|
@@ -33,14 +33,17 @@
|
|
|
33
33
|
"xss-filters": "^1.2.7"
|
|
34
34
|
},
|
|
35
35
|
"keywords": [
|
|
36
|
-
"
|
|
37
|
-
"
|
|
36
|
+
"ntfy",
|
|
37
|
+
"notifications",
|
|
38
|
+
"push-notifications",
|
|
38
39
|
"MCP",
|
|
39
40
|
"model-context-protocol",
|
|
40
|
-
"vibe-code",
|
|
41
41
|
"LLM",
|
|
42
42
|
"AI-integration",
|
|
43
|
-
"server"
|
|
43
|
+
"server",
|
|
44
|
+
"typescript",
|
|
45
|
+
"claude",
|
|
46
|
+
"messaging"
|
|
44
47
|
],
|
|
45
48
|
"author": "Casey Hand @cyanheads",
|
|
46
49
|
"license": "Apache-2.0"
|