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,177 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/github.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/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.

agentmods 80×15 button for substack-gateway-oss AGENTS.md

Your own site · 80×15
<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="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,177 This file is loaded in full into every session.
When invoked 1,177 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.01177 $0.01177
Opus 5.5 $0.00471 $0.00471
Sonnet 5.5 $0.00235 $0.00235
Haiku 4.5 $0.00118 $0.00118

Measured 12d ago against content hash 00543000388a, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-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 12d 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 · 35 lines

How it starts

The opening of the file, as written. The whole thing — 35 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/, plus the pytest-bdd integration scenarios in packages/gateway_oss/features/.
  • uv run pytest packages/gateway_oss/features/ runs only the BDD integration scenarios.
  • uv run pytest packages/gateway_oss/e2e/ runs the live E2E scenarios against SUBSTACK_GATEWAY_BASE_URL (or a local gateway on port 5001); they are skipped when neither is reachable and are not part of plain uv run pytest.

Read the full file on GitHub · 35 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. 12d ago Changed · +1 lines · +80 tokens per session 00543000388a
  2. 1mo ago Changed · -17 tokens per session ba8556652d31
  3. 2mo ago Changed · +2 lines · +311 tokens per session 45a8fa745051
  4. 2mo 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 (40 stars, last pushed 2d ago), licensed MIT. It adds 1,177 tokens to every session, about $0.0047 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-30.

Related

substack-gateway-oss AGENTS.md compared with instructions from other repositories

substack-gateway-oss AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
substack-gateway-oss AGENTS.mdjakub-k-slys/substack-gateway-ossInstructions file402d agoMITA1,177Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode