@davidfuchs/mcp-uptime-kuma 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 David Fuchs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,210 @@
+# mcp-uptime-kuma
+
+A Model Context Protocol (MCP) server for [Uptime Kuma](https://github.com/louislam/uptime-kuma) *version 2*, built with TypeScript and supporting both stdio and streamable HTTP transports.
+
+## Features
+
+- **Multiple Transports**: Supports both stdio (for local integration) and streamable HTTP (for remote access)
+- **Built with TypeScript**: Full type safety and modern tooling
+- **MCP SDK**: Uses the official `@modelcontextprotocol/sdk` package
+- **Uptime Kuma Integration**: Real-time access to monitors and heartbeats via WebSocket connection
+- **Comprehensive Tools**: Retrieve monitor configurations and status data (heartbeats)
+
+## Available Tools
+
+### getMonitor
+Retrieves detailed information about a specific monitor by its ID.
+
+- **Input**: 
+  - `monitorID` (number): The ID of the monitor to retrieve
+  - `includeAdditionalFields` (boolean, optional): Include all additional fields from Uptime Kuma (default: false)
+- **Output**: Monitor configuration object with details like URL, type, check interval, notification settings, etc.
+
+### listMonitors
+Retrieves the full list of all monitors the user has access to.
+
+- **Input**:
+  - `includeAdditionalFields` (boolean, optional): Include all additional fields from Uptime Kuma (default: false)
+- **Output**: Array of monitor objects with count
+
+### getHeartbeats
+Retrieves heartbeats (status checks) for a specific monitor.
+
+- **Input**:
+  - `monitorID` (number): The ID of the monitor to get heartbeats for
+  - `includeAll` (boolean, optional): If true, returns all heartbeats (up to 100). If false, returns only the most recent heartbeat (default: false)
+- **Output**: Array of heartbeat objects containing status, response time, timestamps, etc.
+
+### listAllHeartbeats
+Retrieves the complete heartbeat list for all monitors.
+
+- **Input**:
+  - `includeAll` (boolean, optional): If true, returns all heartbeats (up to 100 per monitor). If false, returns only the most recent heartbeat per monitor (default: false)
+- **Output**: Map of monitor IDs to their heartbeat arrays, with monitor and heartbeat counts
+
+## Usage Notes
+
+- **Monitors** contain configuration information (URLs, check intervals, notification settings, etc.)
+- **Heartbeats** contain actual status data (up/down status, response times, timestamps, etc.)
+- To check if something is **up or down**, use the heartbeat tools, not the monitor tools
+- By default, tools return only essential fields. Set `includeAdditionalFields=true` to get all available data
+
+## Prerequisites
+
+- Node.js (v18 or higher)
+- An Uptime Kuma instance with credentials
+- Environment variables for configuration (see Configuration section)
+
+## Production Usage
+
+This MCP server supports both stdio and streamable HTTP transports.
+
+### For the stdio Transport
+
+For Claude Code, VS Code, or other MCP clients, you can configure the server as follows:
+
+```json
+{
+  "mcpServers": {
+    "uptime-kuma": {
+      "command": "npx",
+      "args": ["mcp-uptime-kuma"],
+      "env": {
+        "UPTIME_KUMA_URL": "http://your-uptime-kuma-instance:3001",
+        "UPTIME_KUMA_USERNAME": "your_username",
+        "UPTIME_KUMA_PASSWORD": "your_password"
+      }
+    }
+  }
+}
+```
+
+### For the Streamable HTTP Transport
+
+The recommended way to run the MCP server using streamable HTTP is to run it as a Docker container.
+
+A docker-compose file is provided - update the included environment variables as needed and run:
+
+`docker compose up -d`
+
+The MCP endpoint will be available on your Docker host at port 300 (configurable via `PORT` environment variable).
+
+If you'd prefer to run it directly on your host machine, see the Development Usage section below.
+
+## Development Usage
+
+To run locally, clone the repository and follow these steps:
+
+### Install dependencies
+
+```bash
+npm install
+```
+
+### Create the environment configuration
+
+Configure the required environment variables either directly in your environment, or by creating a `.env` file in the project root.
+
+These are the required variables:
+
+```env
+UPTIME_KUMA_URL=http://your-uptime-kuma-instance:3001
+UPTIME_KUMA_USERNAME=your_username
+UPTIME_KUMA_PASSWORD=your_password
+PORT=3000  # Optional, only for HTTP transport
+```
+
+## Building
+
+Build the TypeScript code to JavaScript:
+
+```bash
+npm run build
+```
+
+For development with auto-rebuild:
+
+```bash
+npm run watch
+```
+
+## Running
+
+### Default (stdio Transport)
+
+Run in production mode (requires build first):
+
+```bash
+npm start
+```
+
+or
+
+```bash
+npm run start:stdio
+```
+
+This mode is designed to be spawned by MCP clients (like Claude Desktop, VS Code, etc.) that communicate via standard input/output.
+
+### Streamable HTTP Transport (for remote access)
+
+Run in production mode (requires build first):
+
+```bash
+npm run start:http
+```
+
+By default, the HTTP server runs on port 3000. You can change this with the `PORT` environment variable:
+
+```bash
+PORT=8080 npm run start:http
+```
+
+The MCP endpoint will be available at `http://localhost:3000/mcp`
+
+## Testing
+
+You can test the server using the MCP Inspector:
+
+```bash
+npm run inspector
+```
+
+### For HTTP transport:
+Start the HTTP server:
+```bash
+npm run dev:http
+```
+
+Then use the MCP Inspector:
+```bash
+npx @modelcontextprotocol/inspector
+```
+Connect to: `http://localhost:3000/mcp`
+
+## Project Structure
+
+```
+mcp-uptime-kuma/
+├── src/
+│   ├── index.ts                # Main entry point with transport selection
+│   ├── server.ts               # Core MCP server configuration with tools
+│   ├── uptime-kuma-client.ts   # WebSocket client for Uptime Kuma API
+│   └── types.ts                # TypeScript type definitions
+├── dist/                       # Compiled JavaScript (generated)
+├── package.json                # Project dependencies and scripts
+├── tsconfig.json               # TypeScript configuration
+├── .env                        # Environment configuration (create this)
+└── README.md                   # This file
+```
+
+## Development
+
+To add new tools or modify existing ones, edit `src/server.ts`. The Uptime Kuma client in `src/uptime-kuma-client.ts` handles the WebSocket connection and caches monitor and heartbeat data.
+
+## Learn More
+
+- [Uptime Kuma](https://github.com/louislam/uptime-kuma)
+- [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
+- [MCP TypeScript SDK](https://www.npmjs.com/package/@modelcontextprotocol/sdk)
+- [MCP Specification](https://spec.modelcontextprotocol.io/)

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import 'dotenv/config';
+export { createServer } from './server.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,eAAe,CAAC;AA0JvB,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,138 @@
+#!/usr/bin/env node
+import 'dotenv/config';
+import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
+import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js';
+import express from 'express';
+import { createServer } from './server.js';
+/**
+ * Main entry point for @davidfuchs/mcp-uptime-kuma
+ * Supports both stdio (default) and streamable-http transports via CLI flags
+ */
+// Validate required environment variables
+function validateEnvironment() {
+    const url = process.env.UPTIME_KUMA_URL;
+    const username = process.env.UPTIME_KUMA_USERNAME;
+    const password = process.env.UPTIME_KUMA_PASSWORD;
+    if (!url) {
+        console.error('Error: UPTIME_KUMA_URL environment variable is required');
+        process.exit(1);
+    }
+    if (!username) {
+        console.error('Error: UPTIME_KUMA_USERNAME environment variable is required');
+        process.exit(1);
+    }
+    if (!password) {
+        console.error('Error: UPTIME_KUMA_PASSWORD environment variable is required');
+        process.exit(1);
+    }
+    return { url, username, password };
+}
+// Parse command-line arguments
+function parseArgs() {
+    const args = process.argv.slice(2);
+    let transport = 'stdio';
+    for (let i = 0; i < args.length; i++) {
+        if (args[i] === '-t' || args[i] === '--transport') {
+            const value = args[i + 1];
+            if (value === 'stdio' || value === 'streamable-http') {
+                transport = value;
+                i++; // Skip next arg since we consumed it
+            }
+            else {
+                console.error(`Invalid transport: ${value}. Must be 'stdio' or 'streamable-http'`);
+                process.exit(1);
+            }
+        }
+        else if (args[i] === '-h' || args[i] === '--help') {
+            console.log(`Usage: mcp-uptime-kuma [options]
+
+Options:
+  -t, --transport <type>  Transport type: 'stdio' (default) or 'streamable-http'
+  -h, --help              Show this help message
+
+Examples:
+  mcp-uptime-kuma                          # Run with stdio transport (default)
+  mcp-uptime-kuma -t stdio                 # Run with stdio transport
+  mcp-uptime-kuma -t streamable-http       # Run with streamable HTTP transport (port 3000)
+  PORT=8080 mcp-uptime-kuma -t streamable-http  # Run HTTP on custom port
+`);
+            process.exit(0);
+        }
+    }
+    return { transport };
+}
+// Run with the stdio transport
+async function runStdio(config) {
+    try {
+        const server = await createServer(config);
+        const transport = new StdioServerTransport();
+        await server.connect(transport);
+        console.error('mcp-uptime-kuma server running on stdio transport');
+    }
+    catch (error) {
+        console.error('Fatal error in stdio transport:', error);
+        process.exit(1);
+    }
+}
+// Run with the streamable HTTP transport
+async function runHttp(config) {
+    const app = express();
+    app.use(express.json());
+    // Create the MCP server once (reused across requests)
+    const server = await createServer(config);
+    // Handle MCP requests
+    app.post('/mcp', async (req, res) => {
+        try {
+            // Create a new transport for each request to prevent request ID collisions
+            const transport = new StreamableHTTPServerTransport({
+                sessionIdGenerator: undefined,
+                enableJsonResponse: true,
+            });
+            res.on('close', () => {
+                transport.close();
+            });
+            await server.connect(transport);
+            await transport.handleRequest(req, res, req.body);
+        }
+        catch (error) {
+            console.error('Error handling MCP request:', error);
+            if (!res.headersSent) {
+                res.status(500).json({
+                    jsonrpc: '2.0',
+                    error: {
+                        code: -32603,
+                        message: 'Internal server error',
+                    },
+                    id: null,
+                });
+            }
+        }
+    });
+    // Health check endpoint
+    app.get('/health', (req, res) => {
+        res.json({ status: 'ok', server: 'mcp-uptime-kuma' });
+    });
+    const port = parseInt(process.env.PORT || '3000');
+    app.listen(port, () => {
+        console.log(`mcp-uptime-kuma server running on http://localhost:${port}/mcp`);
+        console.log(`Health check available at http://localhost:${port}/health`);
+    }).on('error', (error) => {
+        console.error('Server error:', error);
+        process.exit(1);
+    });
+}
+// Main entry point
+async function main() {
+    const config = validateEnvironment();
+    const { transport } = parseArgs();
+    if (transport === 'stdio') {
+        await runStdio(config);
+    }
+    else {
+        await runHttp(config);
+    }
+}
+main();
+// Also export the server creation function for programmatic use
+export { createServer } from './server.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,eAAe,CAAC;AACvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,6BAA6B,EAAE,MAAM,oDAAoD,CAAC;AACnG,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C;;;GAGG;AAEH,0CAA0C;AAC1C,SAAS,mBAAmB;IAC1B,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;IACxC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC;IAClD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC;IAElD,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;QACzE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,CAAC,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAC9E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,CAAC,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAC9E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;AACrC,CAAC;AAED,+BAA+B;AAC/B,SAAS,SAAS;IAChB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,IAAI,SAAS,GAAgC,OAAO,CAAC;IAErD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,aAAa,EAAE,CAAC;YAClD,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1B,IAAI,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,iBAAiB,EAAE,CAAC;gBACrD,SAAS,GAAG,KAAK,CAAC;gBAClB,CAAC,EAAE,CAAC,CAAC,qCAAqC;YAC5C,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,sBAAsB,KAAK,wCAAwC,CAAC,CAAC;gBACnF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;YACpD,OAAO,CAAC,GAAG,CAAC;;;;;;;;;;;CAWjB,CAAC,CAAC;YACG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED,OAAO,EAAE,SAAS,EAAE,CAAC;AACvB,CAAC;AAED,+BAA+B;AAC/B,KAAK,UAAU,QAAQ,CAAC,MAA4D;IAClF,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,CAAC;QAC1C,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAE7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAEhC,OAAO,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACrE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,iCAAiC,EAAE,KAAK,CAAC,CAAC;QACxD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,yCAAyC;AACzC,KAAK,UAAU,OAAO,CAAC,MAA4D;IACjF,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;IACtB,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAExB,sDAAsD;IACtD,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,CAAC;IAE1C,sBAAsB;IACtB,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAClC,IAAI,CAAC;YACH,2EAA2E;YAC3E,MAAM,SAAS,GAAG,IAAI,6BAA6B,CAAC;gBAClD,kBAAkB,EAAE,SAAS;gBAC7B,kBAAkB,EAAE,IAAI;aACzB,CAAC,CAAC;YAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;gBACnB,SAAS,CAAC,KAAK,EAAE,CAAC;YACpB,CAAC,CAAC,CAAC;YAEH,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAChC,MAAM,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,6BAA6B,EAAE,KAAK,CAAC,CAAC;YACpD,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;gBACrB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;oBACnB,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE;wBACL,IAAI,EAAE,CAAC,KAAK;wBACZ,OAAO,EAAE,uBAAuB;qBACjC;oBACD,EAAE,EAAE,IAAI;iBACT,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,wBAAwB;IACxB,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC9B,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,MAAM,CAAC,CAAC;IAElD,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;QACpB,OAAO,CAAC,GAAG,CAAC,sDAAsD,IAAI,MAAM,CAAC,CAAC;QAC9E,OAAO,CAAC,GAAG,CAAC,8CAA8C,IAAI,SAAS,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QACvB,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,mBAAmB;AACnB,KAAK,UAAU,IAAI;IACjB,MAAM,MAAM,GAAG,mBAAmB,EAAE,CAAC;IACrC,MAAM,EAAE,SAAS,EAAE,GAAG,SAAS,EAAE,CAAC;IAElC,IAAI,SAAS,KAAK,OAAO,EAAE,CAAC;QAC1B,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;AACH,CAAC;AAED,IAAI,EAAE,CAAC;AAEP,gEAAgE;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/server.d.ts

@@ -0,0 +1,14 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+/**
+ * Configuration interface for Uptime Kuma
+ */
+export interface UptimeKumaConfig {
+    url: string;
+    username: string;
+    password: string;
+}
+/**
+ * Creates and configures the MCP server with tools, resources, and prompts
+ */
+export declare function createServer(config: UptimeKumaConfig): Promise<McpServer>;
+//# sourceMappingURL=server.d.ts.map

package/dist/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAMpE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,wBAAsB,YAAY,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC,CA+Q/E"}

package/dist/server.js

@@ -0,0 +1,214 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { McpError, ErrorCode } from '@modelcontextprotocol/sdk/types.js';
+import { z } from 'zod';
+import { UptimeKumaClient, filterMonitorFields } from './uptime-kuma-client.js';
+import { HeartbeatSchema, MonitorBaseSchema } from './types.js';
+/**
+ * Creates and configures the MCP server with tools, resources, and prompts
+ */
+export async function createServer(config) {
+    const server = new McpServer({
+        name: 'mcp-uptime-kuma',
+        version: '0.1.0',
+    }, {
+        instructions: `
+        This MCP server provides access to Uptime Kuma monitoring data.
+
+        Available tools:
+        - getMonitor: Retrieve configuration and details for a specific monitor by ID
+        - listMonitors: Get all monitors with their configurations
+        - getHeartbeats: Retrieve status checks and uptime data for a specific monitor
+        - listAllHeartbeats: Get status checks and uptime data for all monitors
+
+        Monitors contain configuration information (URLs, check intervals, notification settings, etc.).
+        Heartbeats contain actual status data (up/down status, response times, timestamps, etc.).
+        To check if something is up or down, use heartbeat tools, not monitor tools.
+
+        By default, tools return only essential fields. Set includeAdditionalFields=true to get all available data.
+      `
+    });
+    // Initialize Uptime Kuma client and login
+    const client = new UptimeKumaClient(config.url);
+    let isAuthenticated = false;
+    try {
+        await client.connect();
+        await client.login(config.username, config.password);
+        isAuthenticated = true;
+        console.error('Successfully authenticated with Uptime Kuma');
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+        console.error('Failed to authenticate with Uptime Kuma:', error);
+        throw new McpError(ErrorCode.InternalError, `Failed to authenticate with Uptime Kuma: ${errorMessage}`);
+    }
+    // Register getMonitor tool
+    server.registerTool('getMonitor', {
+        title: 'Get Monitor',
+        description: 'Retrieves detailed information about a specific monitor by its ID',
+        inputSchema: {
+            monitorID: z.number().int().positive().describe('The ID of the monitor to retrieve'),
+            includeAdditionalFields: z.boolean().optional().describe('Include all additional fields from Uptime Kuma (default: false)')
+        },
+        outputSchema: {
+            monitor: MonitorBaseSchema.passthrough().describe('Monitor object (may include additional fields beyond base schema when includeAdditionalFields is true)')
+        },
+    }, async ({ monitorID, includeAdditionalFields }) => {
+        if (!isAuthenticated) {
+            throw new McpError(ErrorCode.InternalError, 'Not authenticated with Uptime Kuma');
+        }
+        try {
+            const monitor = client.getMonitor(monitorID);
+            if (!monitor) {
+                throw new Error(`Monitor with ID ${monitorID} not found`);
+            }
+            const result = (includeAdditionalFields ?? false) ? monitor : filterMonitorFields(monitor);
+            return {
+                content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
+                structuredContent: { monitor: result },
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+            throw new McpError(ErrorCode.InternalError, `Failed to get monitor: ${errorMessage}`);
+        }
+    });
+    // Register listMonitors tool
+    server.registerTool('listMonitors', {
+        title: 'List Monitors',
+        description: 'Retrieves the full list of all monitors the user has access to from the cache. By default returns all fields; set includeAdditionalFields to false to return only defined fields.',
+        inputSchema: {
+            includeAdditionalFields: z.boolean().optional().describe('Include all additional fields from Uptime Kuma (default: false)')
+        },
+        outputSchema: {
+            monitors: z.array(MonitorBaseSchema.passthrough()).describe('Array of monitor objects (may include additional fields beyond base schema when includeAdditionalFields is true)'),
+            count: z.number()
+        },
+    }, async ({ includeAdditionalFields }) => {
+        if (!isAuthenticated) {
+            throw new McpError(ErrorCode.InternalError, 'Not authenticated with Uptime Kuma');
+        }
+        try {
+            const monitorList = client.getMonitorList();
+            const monitors = Object.values(monitorList).map(monitor => (includeAdditionalFields ?? false) ? monitor : filterMonitorFields(monitor));
+            return {
+                content: [{
+                        type: 'text',
+                        text: JSON.stringify(monitors, null, 2)
+                    }],
+                structuredContent: {
+                    monitors,
+                    count: monitors.length
+                },
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+            throw new McpError(ErrorCode.InternalError, `Failed to list monitors: ${errorMessage}`);
+        }
+    });
+    // Register getHeartbeats tool
+    server.registerTool('getHeartbeats', {
+        title: 'Get Heartbeats',
+        description: 'Retrieves heartbeats for a specific monitor from the cache. By default returns up to 100 most recent heartbeats; set includeAll to false to return only the most recent heartbeat.',
+        inputSchema: {
+            monitorID: z.number().int().positive().describe('The ID of the monitor to get heartbeats for'),
+            includeAll: z.boolean().optional().describe('If true, returns all heartbeats (up to 100). If false, returns only the most recent heartbeat (default: false)')
+        },
+        outputSchema: {
+            monitorID: z.number(),
+            heartbeats: z.array(HeartbeatSchema),
+            count: z.number()
+        },
+    }, async ({ monitorID, includeAll }) => {
+        if (!isAuthenticated) {
+            throw new McpError(ErrorCode.InternalError, 'Not authenticated with Uptime Kuma');
+        }
+        try {
+            const includeAllFlag = includeAll ?? false;
+            let heartbeatsArray;
+            if (includeAllFlag) {
+                heartbeatsArray = client.getHeartbeatsForMonitor(monitorID, true);
+            }
+            else {
+                const singleHeartbeat = client.getHeartbeatsForMonitor(monitorID, false);
+                heartbeatsArray = singleHeartbeat ? [singleHeartbeat] : [];
+            }
+            return {
+                content: [{
+                        type: 'text',
+                        text: JSON.stringify(heartbeatsArray, null, 2)
+                    }],
+                structuredContent: {
+                    monitorID,
+                    heartbeats: heartbeatsArray,
+                    count: heartbeatsArray.length
+                },
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+            throw new McpError(ErrorCode.InternalError, `Failed to get heartbeats: ${errorMessage}`);
+        }
+    });
+    // Register listAllHeartbeats tool
+    server.registerTool('listAllHeartbeats', {
+        title: 'List All Heartbeats',
+        description: 'Retrieves the complete heartbeat list for all monitors from the cache. By default, each monitor ID maps to an array of up to 100 recent heartbeats; set includeAll to false to return only the most recent heartbeat per monitor.',
+        inputSchema: {
+            includeAll: z.boolean().optional().describe('If true, returns all heartbeats (up to 100 per monitor). If false, returns only the most recent heartbeat per monitor (default: false)')
+        },
+        outputSchema: {
+            heartbeats: z.record(z.string(), z.array(HeartbeatSchema)).describe('Map of monitor IDs to their heartbeat arrays'),
+            monitorCount: z.number(),
+            totalHeartbeatCount: z.number()
+        },
+    }, async ({ includeAll }) => {
+        if (!isAuthenticated) {
+            throw new McpError(ErrorCode.InternalError, 'Not authenticated with Uptime Kuma');
+        }
+        try {
+            const includeAllFlag = includeAll ?? false;
+            const rawHeartbeatList = includeAllFlag
+                ? client.getHeartbeatList(true)
+                : client.getHeartbeatList(false);
+            // Normalize to always return arrays for consistent schema
+            const heartbeatList = {};
+            for (const [monitorID, heartbeats] of Object.entries(rawHeartbeatList)) {
+                if (includeAllFlag) {
+                    heartbeatList[monitorID] = heartbeats;
+                }
+                else {
+                    heartbeatList[monitorID] = heartbeats ? [heartbeats] : [];
+                }
+            }
+            // Calculate total heartbeat count
+            const totalCount = Object.values(heartbeatList).reduce((sum, heartbeats) => sum + heartbeats.length, 0);
+            return {
+                content: [{
+                        type: 'text',
+                        text: JSON.stringify(heartbeatList, null, 2)
+                    }],
+                structuredContent: {
+                    heartbeats: heartbeatList,
+                    monitorCount: Object.keys(heartbeatList).length,
+                    totalHeartbeatCount: totalCount
+                },
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+            throw new McpError(ErrorCode.InternalError, `Failed to list heartbeats: ${errorMessage}`);
+        }
+    });
+    // Clean up on server shutdown
+    process.on('SIGINT', () => {
+        client.disconnect();
+        process.exit(0);
+    });
+    process.on('SIGTERM', () => {
+        client.disconnect();
+        process.exit(0);
+    });
+    return server;
+}
+//# sourceMappingURL=server.js.map

package/dist/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAWhE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAwB;IACzD,MAAM,MAAM,GAAG,IAAI,SAAS,CAC1B;QACE,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE,OAAO;KACjB,EACD;QACE,YAAY,EAAE;;;;;;;;;;;;;;OAcb;KACF,CACF,CAAC;IAGF,0CAA0C;IAC1C,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAChD,IAAI,eAAe,GAAG,KAAK,CAAC;IAE5B,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACvB,MAAM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACrD,eAAe,GAAG,IAAI,CAAC;QACvB,OAAO,CAAC,KAAK,CAAC,6CAA6C,CAAC,CAAC;IAC/D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;QAC9E,OAAO,CAAC,KAAK,CAAC,0CAA0C,EAAE,KAAK,CAAC,CAAC;QACjE,MAAM,IAAI,QAAQ,CAChB,SAAS,CAAC,aAAa,EACvB,4CAA4C,YAAY,EAAE,CAC3D,CAAC;IACJ,CAAC;IAED,2BAA2B;IAC3B,MAAM,CAAC,YAAY,CACjB,YAAY,EACZ;QACE,KAAK,EAAE,aAAa;QACpB,WAAW,EAAE,mEAAmE;QAChF,WAAW,EAAE;YACX,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;YACpF,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iEAAiE,CAAC;SAC5H;QACD,YAAY,EAAE;YACZ,OAAO,EAAE,iBAAiB,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,wGAAwG,CAAC;SAC5J;KACF,EACD,KAAK,EAAE,EAAE,SAAS,EAAE,uBAAuB,EAAE,EAAE,EAAE;QAC/C,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,QAAQ,CAChB,SAAS,CAAC,aAAa,EACvB,oCAAoC,CACrC,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAE7C,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,mBAAmB,SAAS,YAAY,CAAC,CAAC;YAC5D,CAAC;YAED,MAAM,MAAM,GAAG,CAAC,uBAAuB,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAE3F,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;gBAClE,iBAAiB,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE;aACvC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;YAC9E,MAAM,IAAI,QAAQ,CAChB,SAAS,CAAC,aAAa,EACvB,0BAA0B,YAAY,EAAE,CACzC,CAAC;QACJ,CAAC;IACH,CAAC,CACF,CAAC;IAEF,6BAA6B;IAC7B,MAAM,CAAC,YAAY,CACjB,cAAc,EACd;QACE,KAAK,EAAE,eAAe;QACtB,WAAW,EAAE,mLAAmL;QAChM,WAAW,EAAE;YACX,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iEAAiE,CAAC;SAC5H;QACD,YAAY,EAAE;YACZ,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,kHAAkH,CAAC;YAC/K,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;SAClB;KACF,EACD,KAAK,EAAE,EAAE,uBAAuB,EAAE,EAAE,EAAE;QACpC,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,QAAQ,CAChB,SAAS,CAAC,aAAa,EACvB,oCAAoC,CACrC,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;YAC5C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CACxD,CAAC,uBAAuB,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAC5E,CAAC;YAEF,OAAO;gBACL,OAAO,EAAE,CAAC;wBACR,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;qBACxC,CAAC;gBACF,iBAAiB,EAAE;oBACjB,QAAQ;oBACR,KAAK,EAAE,QAAQ,CAAC,MAAM;iBACvB;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;YAC9E,MAAM,IAAI,QAAQ,CAChB,SAAS,CAAC,aAAa,EACvB,4BAA4B,YAAY,EAAE,CAC3C,CAAC;QACJ,CAAC;IACH,CAAC,CACF,CAAC;IAEF,8BAA8B;IAC9B,MAAM,CAAC,YAAY,CACjB,eAAe,EACf;QACE,KAAK,EAAE,gBAAgB;QACvB,WAAW,EAAE,oLAAoL;QACjM,WAAW,EAAE;YACX,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6CAA6C,CAAC;YAC9F,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gHAAgH,CAAC;SAC9J;QACD,YAAY,EAAE;YACZ,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;YACrB,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;YACpC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;SAClB;KACF,EACD,KAAK,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE;QAClC,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,QAAQ,CAChB,SAAS,CAAC,aAAa,EACvB,oCAAoC,CACrC,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,cAAc,GAAG,UAAU,IAAI,KAAK,CAAC;YAC3C,IAAI,eAAsB,CAAC;YAE3B,IAAI,cAAc,EAAE,CAAC;gBACnB,eAAe,GAAG,MAAM,CAAC,uBAAuB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACpE,CAAC;iBAAM,CAAC;gBACN,MAAM,eAAe,GAAG,MAAM,CAAC,uBAAuB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;gBACzE,eAAe,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7D,CAAC;YAED,OAAO;gBACL,OAAO,EAAE,CAAC;wBACR,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;qBAC/C,CAAC;gBACF,iBAAiB,EAAE;oBACjB,SAAS;oBACT,UAAU,EAAE,eAAe;oBAC3B,KAAK,EAAE,eAAe,CAAC,MAAM;iBAC9B;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;YAC9E,MAAM,IAAI,QAAQ,CAChB,SAAS,CAAC,aAAa,EACvB,6BAA6B,YAAY,EAAE,CAC5C,CAAC;QACJ,CAAC;IACH,CAAC,CACF,CAAC;IAEF,kCAAkC;IAClC,MAAM,CAAC,YAAY,CACjB,mBAAmB,EACnB;QACE,KAAK,EAAE,qBAAqB;QAC5B,WAAW,EAAE,mOAAmO;QAChP,WAAW,EAAE;YACX,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,wIAAwI,CAAC;SACtL;QACD,YAAY,EAAE;YACZ,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,8CAA8C,CAAC;YACnH,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;YACxB,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;SAChC;KACF,EACD,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;QACvB,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,QAAQ,CAChB,SAAS,CAAC,aAAa,EACvB,oCAAoC,CACrC,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,cAAc,GAAG,UAAU,IAAI,KAAK,CAAC;YAC3C,MAAM,gBAAgB,GAAG,cAAc;gBACrC,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC;gBAC/B,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;YAEnC,0DAA0D;YAC1D,MAAM,aAAa,GAAmC,EAAE,CAAC;YACzD,KAAK,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBACvE,IAAI,cAAc,EAAE,CAAC;oBACnB,aAAa,CAAC,SAAS,CAAC,GAAG,UAAmB,CAAC;gBACjD,CAAC;qBAAM,CAAC;oBACN,aAAa,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5D,CAAC;YACH,CAAC;YAED,kCAAkC;YAClC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,MAAM,CACpD,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,EAC5C,CAAC,CACF,CAAC;YAEF,OAAO;gBACL,OAAO,EAAE,CAAC;wBACR,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;qBAC7C,CAAC;gBACF,iBAAiB,EAAE;oBACjB,UAAU,EAAE,aAAa;oBACzB,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM;oBAC/C,mBAAmB,EAAE,UAAU;iBAChC;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;YAC9E,MAAM,IAAI,QAAQ,CAChB,SAAS,CAAC,aAAa,EACvB,8BAA8B,YAAY,EAAE,CAC7C,CAAC;QACJ,CAAC;IACH,CAAC,CACF,CAAC;IAEF,8BAA8B;IAC9B,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;QACxB,MAAM,CAAC,UAAU,EAAE,CAAC;QACpB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;QACzB,MAAM,CAAC,UAAU,EAAE,CAAC;QACpB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,197 @@
+import { z } from 'zod';
+/**
+ * Zod schema for Base Monitor Object structure from Uptime Kuma (defined fields only)
+ */
+export declare const MonitorBaseSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+    type: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+    method: z.ZodOptional<z.ZodString>;
+    interval: z.ZodNumber;
+    retryInterval: z.ZodNumber;
+    resendInterval: z.ZodNumber;
+    maxretries: z.ZodNumber;
+    hostname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    port: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    active: z.ZodBoolean;
+    tags: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        tag_id: z.ZodNumber;
+        monitor_id: z.ZodNumber;
+        value: z.ZodNullable<z.ZodString>;
+        name: z.ZodString;
+        color: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        tag_id: number;
+        monitor_id: number;
+        value: string | null;
+        name: string;
+        color: string;
+    }, {
+        tag_id: number;
+        monitor_id: number;
+        value: string | null;
+        name: string;
+        color: string;
+    }>, "many">>;
+    notificationIDList: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
+    accepted_statuscodes_json: z.ZodOptional<z.ZodString>;
+    conditions: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+    pathName: z.ZodString;
+    maintenance: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    type: string;
+    id: number;
+    interval: number;
+    retryInterval: number;
+    resendInterval: number;
+    maxretries: number;
+    active: boolean;
+    pathName: string;
+    maintenance: boolean;
+    url?: string | undefined;
+    method?: string | undefined;
+    hostname?: string | null | undefined;
+    port?: number | null | undefined;
+    tags?: {
+        tag_id: number;
+        monitor_id: number;
+        value: string | null;
+        name: string;
+        color: string;
+    }[] | undefined;
+    notificationIDList?: Record<string, boolean> | undefined;
+    accepted_statuscodes_json?: string | undefined;
+    conditions?: any[] | undefined;
+}, {
+    name: string;
+    type: string;
+    id: number;
+    interval: number;
+    retryInterval: number;
+    resendInterval: number;
+    maxretries: number;
+    active: boolean;
+    pathName: string;
+    maintenance: boolean;
+    url?: string | undefined;
+    method?: string | undefined;
+    hostname?: string | null | undefined;
+    port?: number | null | undefined;
+    tags?: {
+        tag_id: number;
+        monitor_id: number;
+        value: string | null;
+        name: string;
+        color: string;
+    }[] | undefined;
+    notificationIDList?: Record<string, boolean> | undefined;
+    accepted_statuscodes_json?: string | undefined;
+    conditions?: any[] | undefined;
+}>;
+/**
+ * Base Monitor type inferred from the Zod schema
+ */
+export type MonitorBase = z.infer<typeof MonitorBaseSchema>;
+/**
+ * Monitor with additional fields (includes all Uptime Kuma fields)
+ */
+export interface MonitorWithAdditionalFields extends MonitorBase {
+    [key: string]: any;
+}
+/**
+ * Monitor type - can include or exclude additional fields based on includeAdditionalFields option
+ */
+export type Monitor<T extends boolean = true> = T extends true ? MonitorWithAdditionalFields : MonitorBase;
+/**
+ * Response structure for API callbacks
+ */
+export interface ApiResponse {
+    ok: boolean;
+    msg?: string;
+    msgi18n?: boolean;
+}
+/**
+ * Login response
+ */
+export interface LoginResponse extends ApiResponse {
+    token?: string;
+    tokenRequired?: boolean;
+}
+/**
+ * Get monitor response
+ */
+export interface GetMonitorResponse<T extends boolean = true> extends ApiResponse {
+    monitor?: Monitor<T>;
+}
+/**
+ * Monitor list structure
+ */
+export interface MonitorList<T extends boolean = true> {
+    [monitorID: string]: Monitor<T>;
+}
+/**
+ * Zod schema for Heartbeat object structure from Uptime Kuma
+ */
+export declare const HeartbeatSchema: z.ZodObject<{
+    status: z.ZodNumber;
+    time: z.ZodString;
+    msg: z.ZodString;
+    important: z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodNumber]>, boolean, number | boolean>;
+    id: z.ZodOptional<z.ZodNumber>;
+    monitor_id: z.ZodOptional<z.ZodNumber>;
+    ping: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    duration: z.ZodOptional<z.ZodNumber>;
+    down_count: z.ZodOptional<z.ZodNumber>;
+    retries: z.ZodOptional<z.ZodNumber>;
+    end_time: z.ZodOptional<z.ZodString>;
+    monitorID: z.ZodOptional<z.ZodNumber>;
+    localDateTime: z.ZodOptional<z.ZodString>;
+    timezone: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    status: number;
+    time: string;
+    msg: string;
+    important: boolean;
+    monitor_id?: number | undefined;
+    id?: number | undefined;
+    ping?: number | null | undefined;
+    duration?: number | undefined;
+    down_count?: number | undefined;
+    retries?: number | undefined;
+    end_time?: string | undefined;
+    monitorID?: number | undefined;
+    localDateTime?: string | undefined;
+    timezone?: string | undefined;
+}, {
+    status: number;
+    time: string;
+    msg: string;
+    important: number | boolean;
+    monitor_id?: number | undefined;
+    id?: number | undefined;
+    ping?: number | null | undefined;
+    duration?: number | undefined;
+    down_count?: number | undefined;
+    retries?: number | undefined;
+    end_time?: string | undefined;
+    monitorID?: number | undefined;
+    localDateTime?: string | undefined;
+    timezone?: string | undefined;
+}>;
+/**
+ * Heartbeat type inferred from the Zod schema
+ */
+export type Heartbeat = z.infer<typeof HeartbeatSchema>;
+/**
+ * Heartbeat list structure - maps monitor IDs to heartbeats
+ * When includeAll is true, returns arrays of heartbeats
+ * When includeAll is false, returns only the most recent heartbeat
+ */
+export type HeartbeatList<T extends boolean = true> = T extends true ? {
+    [monitorID: string]: Heartbeat[];
+} : {
+    [monitorID: string]: Heartbeat | undefined;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAaxB;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmB5B,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,WAAW;IAC9D,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,OAAO,GAAG,IAAI,IAAI,CAAC,SAAS,IAAI,GAC1D,2BAA2B,GAC3B,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,OAAO,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,OAAO,GAAG,IAAI,CAAE,SAAQ,WAAW;IAC/E,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,OAAO,GAAG,IAAI;IACnD,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiB1B,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAExD;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,GAAG,IAAI,IAAI,CAAC,SAAS,IAAI,GAChE;IAAE,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,CAAA;CAAE,GACpC;IAAE,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAA;CAAE,CAAC"}

package/dist/types.js

@@ -0,0 +1,56 @@
+import { z } from 'zod';
+/**
+ * Zod schema for Monitor tag object
+ */
+const MonitorTagSchema = z.object({
+    tag_id: z.number(),
+    monitor_id: z.number(),
+    value: z.string().nullable(),
+    name: z.string(),
+    color: z.string(),
+});
+/**
+ * Zod schema for Base Monitor Object structure from Uptime Kuma (defined fields only)
+ */
+export const MonitorBaseSchema = z.object({
+    id: z.number(),
+    name: z.string(),
+    type: z.string(),
+    url: z.string().optional(),
+    method: z.string().optional(),
+    interval: z.number(),
+    retryInterval: z.number(),
+    resendInterval: z.number(),
+    maxretries: z.number(),
+    hostname: z.string().nullable().optional(),
+    port: z.number().nullable().optional(),
+    active: z.boolean(),
+    tags: z.array(MonitorTagSchema).optional(),
+    notificationIDList: z.record(z.string(), z.boolean()).optional(),
+    accepted_statuscodes_json: z.string().optional(),
+    conditions: z.array(z.any()).optional(),
+    pathName: z.string(),
+    maintenance: z.boolean(),
+});
+/**
+ * Zod schema for Heartbeat object structure from Uptime Kuma
+ */
+export const HeartbeatSchema = z.object({
+    // Required fields
+    status: z.number().describe('0=DOWN, 1=UP, 2=PENDING, 3=MAINTENANCE'),
+    time: z.string().describe('Timestamp string'),
+    msg: z.string().describe('Status message or error'),
+    important: z.union([z.boolean(), z.number()]).transform(val => Boolean(val)).describe('Was this heartbeat a status change?'),
+    // Optional fields
+    id: z.number().optional().describe('Unique heartbeat ID'),
+    monitor_id: z.number().optional().describe('The monitor this heartbeat belongs to'),
+    ping: z.number().nullable().optional().describe('Response time in ms, null if not applicable'),
+    duration: z.number().optional().describe('Seconds since the last heartbeat for this monitor'),
+    down_count: z.number().optional().describe('Consecutive down count for resend logic'),
+    retries: z.number().optional().describe('Number of retries attempted for this state'),
+    end_time: z.string().optional().describe('End time of the heartbeat check'),
+    monitorID: z.number().optional().describe('camelCase alias (used in some events)'),
+    localDateTime: z.string().optional().describe('Formatted time in server\'s timezone'),
+    timezone: z.string().optional().describe('Server\'s timezone name'),
+});
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC1C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACtC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE;IAC1C,kBAAkB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IAChE,yBAAyB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChD,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE;CACzB,CAAC,CAAC;AAoDH;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,kBAAkB;IAClB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wCAAwC,CAAC;IACrE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IAC7C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IACnD,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,qCAAqC,CAAC;IAC5H,kBAAkB;IAClB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IACzD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IACnF,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6CAA6C,CAAC;IAC9F,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,mDAAmD,CAAC;IAC7F,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;IACrF,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC;IACrF,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iCAAiC,CAAC;IAC3E,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IAClF,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC;IACrF,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;CACpE,CAAC,CAAC"}

package/dist/uptime-kuma-client.d.ts

@@ -0,0 +1,81 @@
+import { Socket } from 'socket.io-client';
+import type { MonitorBase, MonitorWithAdditionalFields, LoginResponse, MonitorList, Heartbeat, HeartbeatList } from './types.js';
+/**
+ * Uptime Kuma Socket.io API Client
+ */
+export declare class UptimeKumaClient {
+    private socket;
+    private url;
+    private monitorListCache;
+    private heartbeatListCache;
+    constructor(url: string);
+    /**
+     * Connect to the Uptime Kuma server
+     */
+    connect(): Promise<void>;
+    /**
+     * Disconnect from the Uptime Kuma server
+     */
+    disconnect(): void;
+    /**
+     * Login using username and password
+     *
+     * @param username - Username (can be empty string)
+     * @param password - Password/API key
+     * @param token - Optional 2FA token if required
+     * @returns Promise resolving to the login response
+     */
+    login(username: string, password: string, token?: string): Promise<LoginResponse>;
+    /**
+     * Set up event listeners for monitor list updates
+     * These listeners keep the cached monitor list in sync with the server
+     */
+    private setupMonitorListListeners;
+    /**
+     * Set up event listeners for heartbeat updates
+     * These listeners keep the cached heartbeat list in sync with the server
+     */
+    private setupHeartbeatListeners;
+    /**
+     * Get a specific monitor by ID from the cache
+     *
+     * @param monitorID - The ID of the monitor to retrieve
+     * @returns The monitor data with all fields, or undefined if not found
+     */
+    getMonitor(monitorID: number): MonitorWithAdditionalFields | undefined;
+    /**
+     * Get the cached full list of monitors the user has access to
+     * The list is populated after login and kept up-to-date via server events
+     *
+     * @returns The cached monitor list with all fields
+     */
+    getMonitorList(): MonitorList<true>;
+    /**
+     * Get the cached heartbeat list
+     * The list is populated after login and kept up-to-date via server events
+     *
+     * @param includeAll - If true, returns arrays of all heartbeats (up to 100). If false, returns only the most recent heartbeat for each monitor
+     * @returns The cached heartbeat list
+     */
+    getHeartbeatList<T extends boolean = true>(includeAll?: T): HeartbeatList<T>;
+    /**
+     * Get heartbeats for a specific monitor from the cache
+     *
+     * @param monitorID - The ID of the monitor
+     * @param includeAll - If true, returns all heartbeats (up to 100). If false, returns only the most recent heartbeat
+     * @returns Heartbeat(s) for the monitor, or empty array/undefined if none exist
+     */
+    getHeartbeatsForMonitor<T extends boolean = true>(monitorID: number, includeAll?: T): T extends true ? Heartbeat[] : Heartbeat | undefined;
+    /**
+     * Get the socket instance (for advanced usage)
+     */
+    getSocket(): Socket | null;
+}
+/**
+ * Utility function to filter a monitor object to only include defined fields
+ *
+ * @param monitor - The monitor object with all fields
+ * @returns The monitor object with only defined fields
+ */
+export declare function filterMonitorFields(monitor: MonitorWithAdditionalFields): MonitorBase;
+//# sourceMappingURL=uptime-kuma-client.d.ts.map

package/dist/uptime-kuma-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uptime-kuma-client.d.ts","sourceRoot":"","sources":["../src/uptime-kuma-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAM,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EACV,WAAW,EACX,2BAA2B,EAG3B,aAAa,EAEb,WAAW,EACX,SAAS,EACT,aAAa,EACd,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,gBAAgB,CAAyB;IACjD,OAAO,CAAC,kBAAkB,CAA2B;gBAEzC,GAAG,EAAE,MAAM;IAIvB;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBxB;;OAEG;IACH,UAAU,IAAI,IAAI;IAkBlB;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IA8BjF;;;OAGG;IACH,OAAO,CAAC,yBAAyB;IAmBjC;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAoC/B;;;;;OAKG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,2BAA2B,GAAG,SAAS;IAItE;;;;;OAKG;IACH,cAAc,IAAI,WAAW,CAAC,IAAI,CAAC;IAInC;;;;;;OAMG;IACH,gBAAgB,CAAC,CAAC,SAAS,OAAO,GAAG,IAAI,EAAE,UAAU,GAAE,CAAa,GAAG,aAAa,CAAC,CAAC,CAAC;IAavF;;;;;;OAMG;IACH,uBAAuB,CAAC,CAAC,SAAS,OAAO,GAAG,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,GAAE,CAAa,GAAG,CAAC,SAAS,IAAI,GAAG,SAAS,EAAE,GAAG,SAAS,GAAG,SAAS;IAUrJ;;OAEG;IACH,SAAS,IAAI,MAAM,GAAG,IAAI;CAG3B;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,2BAA2B,GAAG,WAAW,CAyBrF"}

package/dist/uptime-kuma-client.js

@@ -0,0 +1,232 @@
+import { io, Socket } from 'socket.io-client';
+/**
+ * Uptime Kuma Socket.io API Client
+ */
+export class UptimeKumaClient {
+    socket = null;
+    url;
+    monitorListCache = {};
+    heartbeatListCache = {};
+    constructor(url) {
+        this.url = url;
+    }
+    /**
+     * Connect to the Uptime Kuma server
+     */
+    connect() {
+        return new Promise((resolve, reject) => {
+            this.socket = io(this.url, {
+                reconnection: true,
+                reconnectionDelay: 1000,
+                reconnectionAttempts: 5,
+            });
+            this.socket.on('connect', () => {
+                resolve();
+            });
+            this.socket.on('connect_error', (error) => {
+                reject(new Error(`Connection failed: ${error.message}`));
+            });
+        });
+    }
+    /**
+     * Disconnect from the Uptime Kuma server
+     */
+    disconnect() {
+        if (this.socket) {
+            // Remove event listeners
+            this.socket.off('monitorList');
+            this.socket.off('updateMonitorIntoList');
+            this.socket.off('deleteMonitorFromList');
+            this.socket.off('heartbeatList');
+            this.socket.off('heartbeat');
+            this.socket.disconnect();
+            this.socket = null;
+        }
+        // Clear the caches
+        this.monitorListCache = {};
+        this.heartbeatListCache = {};
+    }
+    /**
+     * Login using username and password
+     *
+     * @param username - Username (can be empty string)
+     * @param password - Password/API key
+     * @param token - Optional 2FA token if required
+     * @returns Promise resolving to the login response
+     */
+    login(username, password, token) {
+        return new Promise((resolve, reject) => {
+            if (!this.socket || !this.socket.connected) {
+                reject(new Error('Not connected to server'));
+                return;
+            }
+            const loginData = {
+                username,
+                password
+            };
+            if (token) {
+                loginData.token = token;
+            }
+            // Set up listeners for monitor list and heartbeat updates before login
+            this.setupMonitorListListeners();
+            this.setupHeartbeatListeners();
+            this.socket.emit('login', loginData, (response) => {
+                if (response.ok) {
+                    resolve(response);
+                }
+                else {
+                    reject(new Error(response.msg || 'Login failed'));
+                }
+            });
+        });
+    }
+    /**
+     * Set up event listeners for monitor list updates
+     * These listeners keep the cached monitor list in sync with the server
+     */
+    setupMonitorListListeners() {
+        if (!this.socket)
+            return;
+        // Listen for the full monitor list (sent after login or on major changes)
+        this.socket.on('monitorList', (monitorList) => {
+            this.monitorListCache = monitorList;
+        });
+        // Listen for updates to specific monitors
+        this.socket.on('updateMonitorIntoList', (updates) => {
+            Object.assign(this.monitorListCache, updates);
+        });
+        // Listen for monitor deletions
+        this.socket.on('deleteMonitorFromList', (monitorID) => {
+            delete this.monitorListCache[monitorID.toString()];
+        });
+    }
+    /**
+     * Set up event listeners for heartbeat updates
+     * These listeners keep the cached heartbeat list in sync with the server
+     */
+    setupHeartbeatListeners() {
+        if (!this.socket)
+            return;
+        // Listen for the full heartbeat list (sent after login)
+        this.socket.on('heartbeatList', (monitorID, heartbeatList, important) => {
+            // The heartbeatList event sends data per monitor, not all at once
+            // Format: (monitorID, array of heartbeats, important flag)
+            console.error(`Received heartbeatList for monitor ${monitorID}:`, heartbeatList.length, 'heartbeats');
+            this.heartbeatListCache[monitorID.toString()] = heartbeatList;
+        });
+        // Listen for individual heartbeat updates (real-time)
+        this.socket.on('heartbeat', (heartbeat) => {
+            // The heartbeat event should always include monitorID
+            if (!heartbeat.monitorID) {
+                console.error('Received heartbeat without monitorID:', heartbeat);
+                return;
+            }
+            const monitorID = heartbeat.monitorID.toString();
+            // Initialize array for this monitor if it doesn't exist
+            if (!this.heartbeatListCache[monitorID]) {
+                this.heartbeatListCache[monitorID] = [];
+            }
+            // Add the new heartbeat to the beginning of the array
+            this.heartbeatListCache[monitorID].unshift(heartbeat);
+            // Keep only the most recent heartbeats (limit to 100 like the API does)
+            if (this.heartbeatListCache[monitorID].length > 100) {
+                this.heartbeatListCache[monitorID] = this.heartbeatListCache[monitorID].slice(0, 100);
+            }
+        });
+    }
+    /**
+     * Get a specific monitor by ID from the cache
+     *
+     * @param monitorID - The ID of the monitor to retrieve
+     * @returns The monitor data with all fields, or undefined if not found
+     */
+    getMonitor(monitorID) {
+        return this.monitorListCache[monitorID.toString()];
+    }
+    /**
+     * Get the cached full list of monitors the user has access to
+     * The list is populated after login and kept up-to-date via server events
+     *
+     * @returns The cached monitor list with all fields
+     */
+    getMonitorList() {
+        return this.monitorListCache;
+    }
+    /**
+     * Get the cached heartbeat list
+     * The list is populated after login and kept up-to-date via server events
+     *
+     * @param includeAll - If true, returns arrays of all heartbeats (up to 100). If false, returns only the most recent heartbeat for each monitor
+     * @returns The cached heartbeat list
+     */
+    getHeartbeatList(includeAll = true) {
+        if (includeAll) {
+            return this.heartbeatListCache;
+        }
+        // Return only the most recent heartbeat for each monitor
+        const recentHeartbeats = {};
+        for (const [monitorID, heartbeats] of Object.entries(this.heartbeatListCache)) {
+            recentHeartbeats[monitorID] = heartbeats[0];
+        }
+        return recentHeartbeats;
+    }
+    /**
+     * Get heartbeats for a specific monitor from the cache
+     *
+     * @param monitorID - The ID of the monitor
+     * @param includeAll - If true, returns all heartbeats (up to 100). If false, returns only the most recent heartbeat
+     * @returns Heartbeat(s) for the monitor, or empty array/undefined if none exist
+     */
+    getHeartbeatsForMonitor(monitorID, includeAll = true) {
+        const heartbeats = this.heartbeatListCache[monitorID.toString()];
+        if (includeAll) {
+            return (heartbeats || []);
+        }
+        return (heartbeats?.[0]);
+    }
+    /**
+     * Get the socket instance (for advanced usage)
+     */
+    getSocket() {
+        return this.socket;
+    }
+}
+/**
+ * Utility function to filter a monitor object to only include defined fields
+ *
+ * @param monitor - The monitor object with all fields
+ * @returns The monitor object with only defined fields
+ */
+export function filterMonitorFields(monitor) {
+    const filtered = {
+        id: monitor.id,
+        name: monitor.name,
+        type: monitor.type,
+        interval: monitor.interval,
+        retryInterval: monitor.retryInterval,
+        resendInterval: monitor.resendInterval,
+        maxretries: monitor.maxretries,
+        active: monitor.active,
+        pathName: monitor.pathName,
+        maintenance: monitor.maintenance,
+    };
+    // Add optional fields if they exist
+    if (monitor.url !== undefined)
+        filtered.url = monitor.url;
+    if (monitor.method !== undefined)
+        filtered.method = monitor.method;
+    if (monitor.hostname !== undefined)
+        filtered.hostname = monitor.hostname;
+    if (monitor.port !== undefined)
+        filtered.port = monitor.port;
+    if (monitor.tags !== undefined)
+        filtered.tags = monitor.tags;
+    if (monitor.notificationIDList !== undefined)
+        filtered.notificationIDList = monitor.notificationIDList;
+    if (monitor.accepted_statuscodes_json !== undefined)
+        filtered.accepted_statuscodes_json = monitor.accepted_statuscodes_json;
+    if (monitor.conditions !== undefined)
+        filtered.conditions = monitor.conditions;
+    return filtered;
+}
+//# sourceMappingURL=uptime-kuma-client.js.map

package/dist/uptime-kuma-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uptime-kuma-client.js","sourceRoot":"","sources":["../src/uptime-kuma-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAa9C;;GAEG;AACH,MAAM,OAAO,gBAAgB;IACnB,MAAM,GAAkB,IAAI,CAAC;IAC7B,GAAG,CAAS;IACZ,gBAAgB,GAAsB,EAAE,CAAC;IACzC,kBAAkB,GAAwB,EAAE,CAAC;IAErD,YAAY,GAAW;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;gBACzB,YAAY,EAAE,IAAI;gBAClB,iBAAiB,EAAE,IAAI;gBACvB,oBAAoB,EAAE,CAAC;aACxB,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;gBAC7B,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,KAAY,EAAE,EAAE;gBAC/C,MAAM,CAAC,IAAI,KAAK,CAAC,sBAAsB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,yBAAyB;YACzB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAC/B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YACjC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAE7B,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,CAAC;QAED,mBAAmB;QACnB,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;IAC/B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,QAAgB,EAAE,QAAgB,EAAE,KAAc;QACtD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;gBAC3C,MAAM,CAAC,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC,CAAC;gBAC7C,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GAA2D;gBACxE,QAAQ;gBACR,QAAQ;aACT,CAAC;YAEF,IAAI,KAAK,EAAE,CAAC;gBACV,SAAS,CAAC,KAAK,GAAG,KAAK,CAAC;YAC1B,CAAC;YAED,uEAAuE;YACvE,IAAI,CAAC,yBAAyB,EAAE,CAAC;YACjC,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAE/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,QAAuB,EAAE,EAAE;gBAC/D,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;oBAChB,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACpB,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,cAAc,CAAC,CAAC,CAAC;gBACpD,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,yBAAyB;QAC/B,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAO;QAEzB,0EAA0E;QAC1E,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,WAA8B,EAAE,EAAE;YAC/D,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,0CAA0C;QAC1C,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,uBAAuB,EAAE,CAAC,OAA0B,EAAE,EAAE;YACrE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,+BAA+B;QAC/B,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,uBAAuB,EAAE,CAAC,SAAiB,EAAE,EAAE;YAC5D,OAAO,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,uBAAuB;QAC7B,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAO;QAEzB,wDAAwD;QACxD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,SAAiB,EAAE,aAA0B,EAAE,SAA4B,EAAE,EAAE;YAC9G,kEAAkE;YAClE,2DAA2D;YAC3D,OAAO,CAAC,KAAK,CAAC,sCAAsC,SAAS,GAAG,EAAE,aAAa,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;YACtG,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,GAAG,aAAa,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,sDAAsD;QACtD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,SAAoB,EAAE,EAAE;YACnD,sDAAsD;YACtD,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;gBACzB,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,SAAS,CAAC,CAAC;gBAClE,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;YAEjD,wDAAwD;YACxD,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;gBACxC,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;YAC1C,CAAC;YAED,sDAAsD;YACtD,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAEtD,wEAAwE;YACxE,IAAI,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBACpD,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACxF,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,SAAiB;QAC1B,OAAO,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CAA2B,aAAgB,IAAS;QAClE,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,IAAI,CAAC,kBAAsC,CAAC;QACrD,CAAC;QAED,yDAAyD;QACzD,MAAM,gBAAgB,GAAmD,EAAE,CAAC;QAC5E,KAAK,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAC9E,gBAAgB,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO,gBAAoC,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACH,uBAAuB,CAA2B,SAAiB,EAAE,aAAgB,IAAS;QAC5F,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEjE,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,CAAC,UAAU,IAAI,EAAE,CAAyD,CAAC;QACpF,CAAC;QAED,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAyD,CAAC;IACnF,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAoC;IACtE,MAAM,QAAQ,GAAgB;QAC5B,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,cAAc,EAAE,OAAO,CAAC,cAAc;QACtC,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;KACjC,CAAC;IAEF,oCAAoC;IACpC,IAAI,OAAO,CAAC,GAAG,KAAK,SAAS;QAAE,QAAQ,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAC1D,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;QAAE,QAAQ,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACnE,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;QAAE,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IACzE,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,QAAQ,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC7D,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,QAAQ,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC7D,IAAI,OAAO,CAAC,kBAAkB,KAAK,SAAS;QAAE,QAAQ,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IACvG,IAAI,OAAO,CAAC,yBAAyB,KAAK,SAAS;QAAE,QAAQ,CAAC,yBAAyB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAC5H,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS;QAAE,QAAQ,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAE/E,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@davidfuchs/mcp-uptime-kuma",
+  "version": "0.2.0",
+  "description": "A Model Context Protocol server with TypeScript supporting stdio and streamable HTTP transports",
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": {
+    "mcp-uptime-kuma": "dist/index.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "start": "node dist/index.js",
+    "start:stdio": "node dist/index.js -t stdio",
+    "start:http": "node dist/index.js -t streamable-http",
+    "dev": "tsx src/index.ts",
+    "dev:stdio": "tsx src/index.ts -t stdio",
+    "dev:http": "tsx src/index.ts -t streamable-http",
+    "watch": "tsc --watch",
+    "inspector": "npx @modelcontextprotocol/inspector tsx src/index.ts"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "typescript",
+    "server",
+    "stdio",
+    "http",
+    "uptime",
+    "kuma",
+    "uptime kuma"
+  ],
+  "author": "David Fuchs <david@davidfuchs.ca>",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DavidFuchs/mcp-uptime-kuma.git"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.22.0",
+    "dotenv": "^17.2.3",
+    "express": "^4.21.2",
+    "socket.io-client": "^4.8.1",
+    "zod": "^3.24.1"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.0",
+    "@types/node": "^22.10.2",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}