kit AGENTS.md

A set of coding instructions for the Kit project, including build and test commands, code style, architecture, and rules for its public Go library.

In plain words
What is it for?
Use it when developing Kit to run builds, tests, linting, and formatting, and to follow its conventions for errors, logging, JSON, contexts, providers, tools, extensions, and the terminal interface.
Why use it?
It gives contributors consistent practices for checking, formatting, structuring, and extending the Kit codebase.

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

Made for: Codex, OpenCode.

Per session 1,791 This file is loaded in full into every session.
When invoked 1,791 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.01791 $0.01791
Opus 5 $0.00896 $0.00896
Sonnet 5 $0.00358 $0.00358
Haiku 4.5 $0.00179 $0.00179

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

Security

Grade A, and why

kit 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 · 129 lines

How it starts

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

KIT Agent Guidelines

Always talk in ASD-STE100 Simplified Technical English

Build/Test Commands

  • Build: go build -o output/kit ./cmd/kit
  • Test all: go test -race ./...
  • Test single: go test -race ./cmd -run TestScriptExecution
  • Lint: go vet ./...
  • Format: go fmt ./...

Code Style

  • Imports: stdlib → third-party → local (blank lines between)
  • Naming: camelCase (unexported), PascalCase (exported)
  • Errors: Always check, wrap with fmt.Errorf("context: %w", err)
  • Logging: Use github.com/charmbracelet/log structured logging
  • Types: Prefer any over interface{}
  • JSON: snake_case tags with omitempty where appropriate
  • Context: First parameter for blocking operations

Architecture

  • Multi-provider LLM support via llm.Provider interface
  • MCP client-server for tool integration
  • Builtin servers: bash, fetch, todo, fs
  • Extension system (internal/extensions/): Yaegi-interpreted Go, 13 lifecycle events, custom tools/commands/widgets/overlays/editor interceptors
  • TUI (internal/ui/): Bubble Tea v2 parent-child model (AppModelInputComponent, StreamComponent, etc.)
  • Decoupling pattern: cmd/root.go has converter functions (e.g. widgetProviderForUI()) that bridge internal/extensions/ types to internal/ui/ types — the UI never imports extensions directly
  • Public SDK (pkg/kit/): The public-facing Go SDK for embedding Kit as a library. See rules below.

Public SDK (pkg/kit/) Rules

pkg/kit/ is the public API surface consumed by external Go developers. All exported symbols, types, function names, and godoc comments in this package are part of the SDK contract.

No Dependency Name Leakage

Internal dependency names (e.g. charm.land/fantasy, library-specific jargon) must not appear in:

  • Exported function/method names — use generic terms (LLM, Provider, Message) instead of library names
  • Exported type names — type aliases should use domain names (e.g. LLMMessage, not FantasyMessage)
  • Godoc comments on exported symbols — these are visible in go doc output and pkg.go.dev
  • Struct field names and tags on exported types

Read the full file on GitHub · 129 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 · 129 lines · 1,791 tokens per session scan A d345be63612d

Subscribe to this mod's changes

kit AGENTS.md is an instructions file published in the GitHub repository mark3labs/kit (125 stars, last pushed 2d ago), licensed MIT. It adds 1,791 tokens to every session, about $0.0090 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