What is uptime-kuma-notifier AGENTS.md?

Project instructions for a native macOS menu bar app that connects to Uptime Kuma, a service for monitoring whether websites and servers are up. The app receives live monitor updates and shows macOS notifications.

Use them when building, running, testing, or modifying this Swift and SwiftUI application, especially its server connections, monitors, notifications, and settings.

They give a coding agent the project layout, build commands, platform requirements, and important implementation details before it changes the code.

How unicornops/uptime-kuma-notifier configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to unicornops/uptime-kuma-notifier. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/unicornops/uptime-kuma-notifier/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/unicornops/uptime-kuma-notifier

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/unicornops/uptime-kuma-notifier/agents-md/github.svg)](https://agentmods.dev/instructions/unicornops/uptime-kuma-notifier/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/unicornops/uptime-kuma-notifier/agents-md"><img src="https://agentmods.dev/badge/instructions/unicornops/uptime-kuma-notifier/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/unicornops/uptime-kuma-notifier/agents-md"><img src="https://agentmods.dev/badge/instructions/unicornops/uptime-kuma-notifier/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 718 This file is loaded in full into every session.

When invoked 718 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00718	$0.00718
Opus 5.5	$0.00287	$0.00287
Sonnet 5.5	$0.00144	$0.00144
Haiku 4.5	$0.00072	$0.00072

Measured 2mo ago against content hash 7c36c3afd8b1, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

uptime-kuma-notifier AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 73 lines

How it starts

The opening of the file, as written. The whole thing — 73 lines — stays where its author put it; the contents beside it link to each section on GitHub.

CLAUDE.md

Project Overview

Uptime Kuma Notifier — a native macOS menu bar application (Swift/SwiftUI) that monitors Uptime Kuma servers via Socket.IO and provides real-time status updates with native notifications.

Build & Run

swift build              # Debug build
swift build -c release   # Release build
swift run                # Build and run

Project Structure

Package.swift — SPM config, depends on socket.io-client-swift
Sources/UptimeKumaNotifier/
- App/ — @main entry point with MenuBarExtra
- Models/ — Server, Monitor, Heartbeat, MonitorStatus, ServerConnectionState
- Services/ — KeychainService, SocketIOService, NotificationService
- ViewModels/ — ServerManager (multi-server orchestrator), ServerConnectionViewModel (per-server state)
- Views/ — MenuBarView, MonitorListView, MonitorRowView, SettingsView, ServerFormView
Info.plist — LSUIElement=true (menu bar only app), macOS 15+
UptimeKumaNotifier.entitlements — Sandbox + network.client

Key Technical Details

Target: macOS 15 (Sequoia) minimum
Swift version: 6.0 (strict concurrency)
Dependency: socket.io-client-swift v16.x with .version(.three) (matches Uptime Kuma's Socket.IO v4 server)
Credentials: Passwords and JWT tokens stored in macOS Keychain via Security framework. Server configs (non-secret) in UserDefaults.
Architecture: @Observable pattern, @MainActor for all UI/ViewModel code. SocketIOService is @unchecked Sendable with delegate callbacks dispatched to MainActor

Conventions

All commits must use conventional commit format (e.g., feat:, fix:, chore:, ci:, docs:)
Versioning and changelog management are handled by release-please
Follow Apple platform best practices (SwiftUI, Keychain, UserNotifications, app sandbox)
No third-party dependencies beyond Socket.IO client — use system frameworks (Security, UserNotifications)

Read the full file on GitHub · 73 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 73 lines · 718 tokens per session scan A 7c36c3afd8b1

Subscribe to this mod's changes

uptime-kuma-notifier AGENTS.md is an instructions file published in the GitHub repository unicornops/uptime-kuma-notifier (6 stars, last pushed 1mo ago), licensed MIT. It adds 718 tokens to every session, about $0.0029 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

uptime-kuma-notifier AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
uptime-kuma-notifier AGENTS.mdunicornops/uptime-kuma-notifier	Instructions file	6	1mo ago	MIT	A	718	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	5,649	GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	today	MIT	A	4,680	Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	3,093	GitHub Copilot
vscode ai-customization.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	1,907	GitHub Copilot

uptime-kuma-notifier: Instructions file for Codex