openab AGENTS.md

A repository instruction guide for OpenAB, a Rust program that connects chat services such as Discord and Slack to coding tools. It describes the project’s architecture, message flow, configuration, and compatibility rules.

In plain words
What is it for?
Use it when working on OpenAB modules such as adapters, configuration, scheduling, media handling, formatting, speech-to-text, or setup.
Why use it?
It gives coding agents the project-specific context needed to make changes that fit the existing design and preserve backward-compatible behavior.

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/openabdev/openab/agents-md
Clone the repo
git clone --depth 1 https://github.com/openabdev/openab

Made for: Codex, OpenCode.

Per session 1,580 This file is loaded in full into every session.
When invoked 1,580 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.01580 $0.01580
Opus 5 $0.00790 $0.00790
Sonnet 5 $0.00316 $0.00316
Haiku 4.5 $0.00158 $0.00158

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

Security

Grade A, and why

openab 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 · 160 lines

How it starts

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

OpenAB — Agent Guidelines

You are contributing to OpenAB, a lightweight Rust-based ACP harness bridging Discord, Slack, and webhook platforms to coding CLIs over stdio JSON-RPC.

Architecture

src/
├── main.rs           # entrypoint, multi-adapter startup, graceful shutdown
├── adapter.rs        # ChatAdapter trait, AdapterRouter (platform-agnostic)
├── config.rs         # TOML config + ${ENV_VAR} expansion
├── discord.rs        # DiscordAdapter (serenity EventHandler)
├── slack.rs          # SlackAdapter (Socket Mode)
├── gateway.rs        # Custom Gateway WebSocket adapter
├── cron.rs           # Config-driven + usercron scheduler
├── media.rs          # Image resize/compress + STT download
├── format.rs         # Message splitting, thread name shortening
├── markdown.rs       # Discord markdown rendering
├── reactions.rs      # Emoji status controller (debounce, stall detection)
├── bot_turns.rs      # Bot turn tracking
├── error_display.rs  # User-facing error formatting
├── stt.rs            # Speech-to-text (Whisper API)
├── setup/            # Interactive setup wizard
│   ├── config.rs     # Setup config helpers
│   ├── validate.rs   # Input validation
│   └── wizard.rs     # CLI setup flow
└── acp/
    ├── protocol.rs   # JSON-RPC types + ACP event classification
    ├── connection.rs # Spawn CLI, stdio JSON-RPC, env_clear whitelist
    └── pool.rs       # Session key → AcpConnection map + lifecycle

Helm chart: charts/openab/ — Go templates, values.yaml, NOTES.txt Gateway: gateway/ — standalone Rust binary for Telegram/LINE/Teams Docs: docs/ — user-facing guides, ADRs, config reference

Message Flow

Discord/Slack event
  → channel allowlist check
  → user allowlist check (bot messages bypass this)
  → bot message filter (off/mentions/all)
  → thread detection (thread_metadata = thread, NOT parent_id)
  → bot ownership check (bot_owns = thread creator matches bot user ID)
  → multibot detection (allowUserMessages mode)
  → handle_message → pool.get_or_create → ACP JSON-RPC

Read the full file on GitHub · 160 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 · 160 lines · 1,580 tokens per session scan A 1c6b46cd4181

Subscribe to this mod's changes

openab AGENTS.md is an instructions file published in the GitHub repository openabdev/openab (778 stars, last pushed 5d ago), licensed MIT. It adds 1,580 tokens to every session, about $0.0079 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

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

buildNext

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

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

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

spec-kit 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,040 tokens

langchain 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