substack-gateway-oss: Instructions file for Codex

AGENTS.md

substack-gateway-oss AGENTS.md is an instructions file for Codex, OpenCode from jakub-k-slys/substack-gateway-oss. It costs 1,114 tokens per session, scanned A, original, MIT.

Repository instructions for Substack Gateway OSS, including its folder structure, coding conventions, build commands, and testing rules. The project exposes Substack data through an API and MCP endpoints.

In plain words
What is it for?
Use them when editing this repository to locate routes, services, clients, models, converters, and tests, then run linting, type checks, builds, unit tests, and behavior tests.
Why use it?
They help a coding agent understand where changes belong and which checks the project expects before work is considered complete.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

This is jakub-k-slys/substack-gateway-oss's own configuration. It tells Codex and OpenCode how to work on substack-gateway-oss itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything substack-gateway-oss configures →

Reuse

Borrowing it

Nothing to install: this file belongs to jakub-k-slys/substack-gateway-oss. 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/jakub-k-slys/substack-gateway-oss/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/jakub-k-slys/substack-gateway-oss

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.

agentmods badge for substack-gateway-oss AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/jakub-k-slys/substack-gateway-oss/agents-md.svg)](https://agentmods.dev/instructions/jakub-k-slys/substack-gateway-oss/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/jakub-k-slys/substack-gateway-oss/agents-md"><img src="https://agentmods.dev/badge/instructions/jakub-k-slys/substack-gateway-oss/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,114 This file is loaded in full into every session.
When invoked 1,114 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.01114 $0.01114
Opus 5 $0.00557 $0.00557
Sonnet 5 $0.00223 $0.00223
Haiku 4.5 $0.00111 $0.00111

Measured today against content hash 45a8fa745051, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

substack-gateway-oss 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 today.

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 · 34 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

The root src/substack_gateway/ package composes the Starlette app (app_factory.py, api_app.py, mcp_app.py, registry.py, ext_loader.py, runtime.py); it does not hold domain logic itself. packages/gateway_core/ is the shared foundation: auth, HTTP clients, config, the capability protocol, converters, and models. Each domain (notes, posts, profiles, following, comments, drafts, stats, ...) ships as a trio of packages — gateway_<domain> for the service layer, gateway_<domain>_rest for its FastAPI router, gateway_<domain>_mcp for its FastMCP tools — each _rest/_mcp package registering itself through the substack_gateway.capabilities entry-point group. me is an exception: gateway_me_rest/gateway_me_mcp exist as a two-package (REST + MCP only) capability pair with no gateway_me service package, composing NotesService, PostsService, and ProfilesService from other domains instead. packages/gateway_oss/ is now an aggregator: health routes, the extension protocol, versioning, and backward-compat shims. Unit tests live under each package's tests/; BDD coverage is in packages/gateway_oss/features/ with step definitions under features/steps/. Use packages/gateway_oss/samples/ for request examples and treat dist/ as build output.

Build, Test, and Development Commands

Install the pinned toolchain and dev dependencies with uv sync --all-packages --dev. Run the app locally with uv run python -m substack_gateway.main; this serves the API and MCP endpoints on port 5001 by default. Build distributable artifacts with uv build --all-packages.

Quality checks:

  • uv run ruff check . runs lint rules.
  • uv run ruff format --check . verifies formatting.
  • uv run ty check . runs static type checks.
  • uv build --all-packages verifies every package builds.
  • uv run pytest runs unit tests across every package, including packages/gateway_drafts/tests/ and packages/gateway_stats/tests/.
  • uv run behave packages/gateway_oss/features/ runs BDD and integration scenarios.

Read the full file on GitHub · 34 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. today Changed · +2 lines · +311 tokens per session 45a8fa745051
  2. 8d ago First seen · 32 lines · 803 tokens per session scan A 21603e2e245a

Subscribe to this mod's changes

substack-gateway-oss AGENTS.md is an instructions file published in the GitHub repository jakub-k-slys/substack-gateway-oss (25 stars, last pushed today), licensed MIT. It adds 1,114 tokens to every session, about $0.0056 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

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

next.js AGENTS.md

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

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,469 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

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