docs AGENTS.md

Repository guidance for project documentation that explains the Kessel platform and how to author its content and examples. It also describes source repositories used to generate or support the documentation.

In plain words
What is it for?
Use it when adding or updating platform guides, API or SDK documentation, code examples, diagrams, or generated documentation.
Why use it?
It helps agents find the correct writing rules, technical references, examples, and source code repositories before editing docs.

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

Made for: Codex, OpenCode.

Per session 2,241 This file is loaded in full into every session.
When invoked 2,241 The same file — it is already loaded in full.
Security scan A 1 finding. 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.02241 $0.02241
Opus 5 $0.01120 $0.01120
Sonnet 5 $0.00448 $0.00448
Haiku 4.5 $0.00224 $0.00224

Measured yesterday against content hash 198b0b9172b2, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

docs AGENTS.md scanned grade A with 1 finding 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 yesterday.

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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

- Variant naming: `example.curl.sh` and `example.grpcurl.sh` produce separate tabs ("curl" and "grpcurl")
AGENTS.md · 174 lines

How it starts

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

AGENTS.md

This file provides onboarding context for AI agents working in the docs repository. It covers cross-cutting conventions, architectural context, and pointers to detailed guidelines. For the project overview, see README.md. For contribution basics, see CONTRIBUTING.md.

Guidelines Index

Guideline Covers
KESSEL-INTEGRATION-GUIDE.md Kessel platform knowledge: API contracts (v1beta2), SDKs, auth (OAuth2/TLS/SpiceDB), DB schema, CDC/outbox, Kafka, monitoring KPIs, gRPC patterns
src/content/docs/GUIDELINES.md Docs content authoring: file formats, Diataxis, content placement, diagrams, security in docs, client-package system
src/examples/GUIDELINES.md Code examples: region markers, language coverage, error handling patterns, CodeExamples component

Source Repositories

This documentation project references multiple source code repositories. The docs/sources.yaml file lists all relevant repositories and metadata. AI agents use this file to:

  • Discover which repositories to analyze
  • Understand repository types (api, sdk, schema, service)
  • Get GitHub URLs for cloning if needed
  • Generate documentation from implementation details

The file structure:

repositories:
  - name: inventory-api
    type: api
    github: https://github.com/project-kessel/inventory-api
    description: Brief description
    technologies: [Go, gRPC, ...]

To locate repositories locally:

  1. Check parent directory: ../repository-name/
  2. Search common project directories
  3. If not found, ask the user for the path or offer to clone from GitHub

When generating documentation from source code (e.g., explaining architectural patterns, documenting APIs), always check docs/sources.yaml first to discover relevant repositories. If you discover new repositories that should be documented, suggest updating this file.

Read the full file on GitHub · 174 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. yesterday First seen · 174 lines · 2,241 tokens per session scan A 198b0b9172b2

Subscribe to this mod's changes

docs AGENTS.md is an instructions file published in the GitHub repository project-kessel/docs (2 stars, last pushed 7d ago), licensed Apache-2.0. It adds 2,241 tokens to every session, about $0.0112 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). 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

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