"alerts", "title": "System Alert", "message": "CPU usage has exceeded 90% for 5 minutes.", "tags": ["warning", "computer"], "priority": 4, "click": "https://server-dashboard.example.com", "actions": [ { "id": "view", "label": "View Details", "action": "view", "url": "https://server-dashboard.example.com/cpu" }, { "id": "restart", "label": "Restart Service", "action": "http", "url": "https://api.example.com/restart-service", "method": "POST", "headers": { "Authorization": "Bearer token123" } } ], "markdown": true } ``` #### Example Response: ```json { "success": true, "id": "5ZFY362156Sa", "topic": "ATLAS", "time": 1743064235, "expires": 1743496235, "message": "This is a test message from the README verification process", "title": "README Testing" } ``` ## Resources ### Direct Resources #### `ntfy://default` - **Description:** Returns the default ntfy topic configured in the server's environment variables (`NTFY_DEFAULT_TOPIC`). - **Usage:** Useful for clients to discover the primary topic without needing prior configuration. - **Example:** An LLM agent can access this resource to automatically use the default topic when sending notifications. - **Example Response:** ```json { "defaultTopic": "ATLAS", "timestamp": "2025-03-27T08:30:25.619Z", "requestUri": "ntfy://default", "requestId": "0da963d0-30e0-4dbc-bb77-4bf2dee14484" } ``` ### Resource Templates #### `ntfy://{topic}` - **Description:** Returns information about a specific ntfy topic. - **Parameters:** `topic` - The name of the ntfy topic. - **Usage:** For querying information about topics other than the default. - **Example Response:** ```json { "topic": "ATLAS", "timestamp": "2025-03-27T08:30:30.038Z", "requestUri": "ntfy://ATLAS", "requestId": "31baf1df-278f-4fdb-860d-019f156a72b0" } ``` ## Use Cases 1. **Long-running Task Notifications** - Get notified when tasks like database backups, code generation, or data processing complete. 2. **Scheduled Reminders** - Set delayed notifications for future events or reminders. 3. **Alert Systems** - Set up critical alerts for monitoring systems or important events. 4. **Mobile Notifications from LLMs** - Allow LLMs to send notifications directly to your phone. 5. **Multi-step Process Updates** - Receive updates as different stages of a complex process complete. ### Usage Examples #### Basic Notification ``` ntfy-mcp-server send_ntfy { "topic": "updates", "title": "Task Completed", "message": "Your requested data analysis has finished", "tags": ["check"] } ``` #### Rich Notification with Actions ``` ntfy-mcp-server send_ntfy { "topic": "alerts", "title": "Critical Error Detected", "message": "The application has encountered a critical error.\n\n**Error Code**: E123\n\n**Details**: Database connection failed", "tags": ["warning", "skull"], "priority": 5, "actions": [ { "id": "view", "label": "View Logs", "action": "view", "url": "https://logs.example.com" }, { "id": "restart", "label": "Restart Service", "action": "http", "url": "https://api.example.com/restart", "method": "POST" } ], "markdown": true } ``` ## Available Scripts - `npm run build`: Compiles the TypeScript source code to JavaScript in the `dist/` directory. - `npm run clean`: Removes the `dist/` directory and cleans the contents of the `logs/` directory. - `npm run rebuild`: Runs `clean` and then `build`. - `npm run tree`: Generates a directory tree representation in `docs/tree.md`. - `npm start`: Runs the compiled server from the `dist/` directory using Node.js. - `npm run watch`: Tails the combined log file (`logs/combined.log`) for real-time monitoring. ## Contributing Cont

Ntfy MCP Server

コメント