example-notification-server-go AGENTS.md

Contributor instructions for a Go server that receives messages from the XMTP messaging network and sends phone or webhook notifications through services such as APNS and FCM.

In plain words
What is it for?
Building the server, starting its API or message listener, running database-backed tests, checking shell scripts, and regenerating protocol code.
Why use it?
They collect the commands and testing requirements needed to build, run, lint, generate protocol code, and test the server reliably. XMTP is a network for exchanging messages between applications.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/xmtp/example-notification-server-go/agents-md
Clone the repo
git clone --depth 1 https://github.com/xmtp/example-notification-server-go

Made for: Codex, OpenCode.

Per session 951 This file is loaded in full into every session.
When invoked 951 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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.

ModelPer sessionOnce invoked
Fable 5 $0.00951 $0.00951
Opus 5 $0.00476 $0.00476
Sonnet 5 $0.00190 $0.00190
Haiku 4.5 $0.00095 $0.00095

Measured 2d ago against content hash a179d303d63c, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

example-notification-server-go 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 2d 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 · 86 lines

How it starts

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

AGENTS.md

This file provides guidance to AI coding agents when working with code in this repository.

Project Overview

XMTP push notification server in Go. Designed to be forked and customized per application. Receives messages from the XMTP network and delivers push notifications via APNS, FCM, or HTTP webhooks.

Common Commands

Build & Run

./dev/up              # Start Docker services (PostgreSQL, XMTP node) — run once
./dev/build           # Build binary to ./dist/
./dev/start           # Run server with both API and listener enabled
./dev/run --api       # Run API server only
./dev/run --help      # Show all CLI options

Testing

go test -p 1 ./...    # Unit tests (must run serially — shared database)
./dev/integration     # Integration tests (Docker-based, TypeScript/Bun)

Tests require ./dev/up to be running. The -p 1 flag is required because tests share a database instance that gets wiped between tests.

Linting

golangci-lint run --config dev/.golangci.yaml   # Go linter
./dev/lint-shellcheck                            # Shell script linter

Proto Generation

./dev/gen-proto       # Regenerate all proto code (requires buf CLI)
buf generate          # Regenerate notification protos only

Architecture

Two-Service Design

The server runs two optional components via flags:

  • API server (--api): Connect RPC over HTTP on port 8080. Handles device registration and topic subscriptions. Stateless, can scale horizontally.
  • XMTP listener (--xmtp-listener): Persistent gRPC stream to XMTP node. Receives messages, looks up subscriptions, delivers notifications. Should be a single instance.

Both are started as goroutines from cmd/server/main.go and shut down gracefully on SIGINT/SIGTERM.

Package Structure

  • cmd/server/main.go — Entry point, wires up dependencies, starts services
  • pkg/api/ — Connect RPC API server (registration, subscribe/unsubscribe endpoints)
  • pkg/xmtp/ — XMTP network listener with worker pool (default 50 workers, channel capacity 100)
  • pkg/delivery/ — Push notification delivery: APNS (apns.go), FCM (fcm.go), HTTP (http.go)
  • pkg/installations/ — Installation CRUD (device registration)
  • pkg/subscriptions/ — Subscription management (topic subscriptions with optional HMAC keys)
  • pkg/interfaces/ — Core interfaces (Installations, Subscriptions, Delivery) and domain types
  • pkg/db/ — SQLC queries, pgx/database/sql access, and golang-migrate migrations (see pkg/db/AGENTS.md)
  • pkg/topics/ — Topic parsing and message type detection (V3 MLS topics only)
  • pkg/options/ — CLI flag/env var configuration structs
  • pkg/proto/ — Generated protobuf/Connect code (~28K LOC, do not edit)

Read the full file on GitHub · 86 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.

  1. 2d ago First seen · 86 lines · 951 tokens per session scan A a179d303d63c

Subscribe to this mod's changes

example-notification-server-go AGENTS.md is an instructions file published in the GitHub repository xmtp/example-notification-server-go (21 stars, last pushed 2mo ago), licensed MIT. It adds 951 tokens to every session, about $0.0048 per session on Opus 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-30.

Related

Other instructions, from other repositories

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,345 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js AGENTS.md

Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens