gibrun AGENTS.md

A repository guide for coding agents working on a TypeScript project that connects tools such as PostgreSQL, HTTP services, Go builds, file access, and debugging hooks.

In plain words
What is it for?
It helps agents install dependencies, run the TypeScript compiler, use the development watcher, inspect the MCP server, and work with the example Go and PostgreSQL setup.
Why use it?
It puts the project layout, commands, naming practices, and testing expectations in one place, so contributors do not have to infer how the code is built or checked.

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

Made for: Codex, OpenCode.

Per session 795 This file is loaded in full into every session.
When invoked 795 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.00795 $0.00795
Opus 5 $0.00398 $0.00398
Sonnet 5 $0.00159 $0.00159
Haiku 4.5 $0.00080 $0.00080

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

Security

Grade A, and why

gibrun 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 · 24 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

Core MCP logic lives in src/index.ts, which registers every tool (Postgres queries, HTTP executor, Go build helpers, file IO, and DAP hooks). TypeScript output is written to build/ via tsc, and package.json points MCP clients to build/index.js. Repository-level docs (README.md, PROJECT_OVERVIEW.md, DAP_INTEGRATION.md, EXAMPLES.md, TROUBLESHOOTING_DAP.md) explain usage scenarios; reference config.example.json when wiring Claude, Cursor, or other hosts. The test-example/ folder provides an end-to-end playground: sample-api.go, schema.sql, go.mod, and a Dockerfile for spinning up the demo API alongside PostgreSQL, matching the docker-compose.yml stack.

Build, Test, and Development Commands

  • npm install — install the TypeScript SDK, pg client, and other runtime deps.
  • npm run dev — run tsc --watch, continuously emitting build/index.js while you iterate on tools.
  • npm run build — perform a one-shot strict compile/type-check; this must pass before publishing or cutting a release.
  • npx @modelcontextprotocol/inspector node build/index.js — attach the MCP Inspector to validate tool definitions and responses after building.
  • cd test-example && go run sample-api.go (or docker compose up) — launch the sample API plus database so you can practice the postgres→HTTP→verification workflow end to end.

Coding Style & Naming Conventions

Write modern TypeScript targeting ES2022 with Node16 resolution, as enforced by tsconfig.json. Use 4-space indentation, explicit async return types, and keep tool handlers small, composable functions (e.g., handlePostgresQuery). Tool identifiers stay snake_case to match MCP expectations, while variables and functions remain camelCase. Prefer structured errors that return { content, isError } payloads instead of throwing. Run npm run build before pushing to ensure the compiler’s strict mode stays green; no separate formatter runs today, so follow the existing style and keep descriptive JSDoc-style comments to explain non-obvious logic.

Read the full file on GitHub · 24 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 · 24 lines · 795 tokens per session scan A 6168a4968826

Subscribe to this mod's changes

gibrun AGENTS.md is an instructions file published in the GitHub repository wirnat/gibrun (1 stars, last pushed 9mo ago), licensed MIT. It adds 795 tokens to every session, about $0.0040 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-31.

Related

Other instructions, from other repositories

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

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

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