How real projects brief Codex, Cursor and every other agent that reads AGENTS.md.
PydanticAGENTS.mdpydantic/pydantic-ai/AGENTS.md
project and its users Being an open source library, the public API, abstractions, documentation, and the code itself _are_ the product and deserve careful consideration, as much as the functionality
PydanticAGENTS.mdpydantic/pydantic-ai/docs/AGENTS.md
docs/` guidelines Follow the general [documentation guidance](../agent_docs/documentation.md). These rules cover published Markdown under `docs/`. ## Links and structure - Use reference-style links for API elements: `[ElementName][module.path.ElementName]`. They provide hover
PydanticAGENTS.mdpydantic/pydantic-ai/pydantic_ai_slim/pydantic_ai/AGENTS.md
check time and improve IDE autocomplete; when `Any` is unavoidable due to external constraints, document expected structure in docstrings - Use `TypedDict` or dataclass instead of `dict[str, Any]` when structure
PydanticAGENTS.mdpydantic/pydantic-ai/pydantic_ai_slim/pydantic_ai/durable_exec/AGENTS.md
once if the process fails after the side effect but before its checkpoint commits. Document the engine's guarantees and require idempotency or expose an engine-native at-most-once
PydanticAGENTS.mdpydantic/pydantic-ai/pydantic_ai_slim/pydantic_ai/models/AGENTS.md
Design - Silently ignore unsupported generic tuning settings (`temperature`, sampling params, penalties, …) at runtime and document them in docstrings — a model that simply no-ops an unsupported knob keeps client code
PydanticAGENTS.mdpydantic/pydantic-ai/pydantic_ai_slim/pydantic_ai/native_tools/AGENTS.md
there; model settings remain as an alternative for backward compat - Provider support must be documented in three places: the tool class docstring 'Supported by' list, `docs/native-tools.md` provider table, and field
PydanticAGENTS.mdpydantic/pydantic-ai/pydantic_ai_slim/pydantic_ai/realtime/AGENTS.md
nodes, no `before_model_request`, deferred results resolved inline), the difference must be deliberate, documented in [docs/realtime/](../../../docs/realtime/), and covered by a parity test in `tests/realtime/`. ## Provider adapters - Parse provider
PydanticAGENTS.mdpydantic/pydantic-ai/pydantic_ai_slim/pydantic_ai/ui/AGENTS.md
that way — see [7106](https://github.com/pydantic/pydantic-ai/pull/7106#discussion_r3723844005), which closed [7105](https://github.com/pydantic/pydantic-ai/issues/7105) by documenting the wiring instead of exposing `AGUIAdapter.context`. A field earns an adapter property when **both** hold
PydanticAGENTS.mdpydantic/pydantic-ai/src/pydantic_ai_harness/AGENTS.md
reference When implementing a new capability, reference these docs: - <https://pydantic.dev/docs/ai/capabilities/overview/> -- main capabilities documentation, usage patterns, built-in capabilities - <https://pydantic.dev/docs/ai/core-concepts/hooks/> -- lifecycle hooks reference, hook ordering, all hook
PydanticAGENTS.mdpydantic/pydantic-ai/src/pydantic_clai2/AGENTS.md
code review. 3. Fire it from exactly one place in the shell. 4. Document it in `PLUGINS.md` in the table it belongs to. ## The `/plugins`, `/set`, `/theme`, `/model`, and `/add_model
PydanticAGENTS.mdpydantic/pydantic-ai/tests/AGENTS.md
tests/assets/` - `image_content` - `BinaryImage` (kiwi.jpg) - `audio_content` - `BinaryContent` (marcelo.mp3) - `video_content` - `BinaryContent` (small_video.mp4) - `document_content` - `BinaryContent` (dummy.pdf) - `text_document_content` - `BinaryContent` (dummy.txt) #### SSRF protection for URL downloads - `disable_ssrf
Hugging FaceAGENTS.mdhuggingface/trl/.ai/AGENTS.md
function, parameter, or branch is maintenance burden. The best abstraction is often no abstraction. ## Documentation ### Docstrings Docstrings must follow the repository format below. Do **not** convert docstrings to other styles
nesquenaAGENTS.mdnesquena/hermes-webui/AGENTS.md
personal machine setup, private network details, credentials, tokens, or local-only workflow notes here. ## Documentation by task Use the references that match the change; there is no blanket reading list
nukeopAGENTS.mdnukeop/nuclear/AGENTS.md
demos - `@nuclearplayer/videos` - Remotion videos rendered from UI components - `@nuclearplayer/tools` - Build and maintenance utilities - `@nuclearplayer/docs` - Documentation - `@nuclearplayer/website` - Project website (Astro) ## Commands ```bash # Development pnpm dev # Run player in dev mode pnpm
VercelAGENTS.mdvercel-labs/json-render/AGENTS.md
installed globally. ## Workflow - Run `pnpm type-check` after each turn to ensure type safety - Documentation lives in `apps/web/content/docs/` and uses Geistdocs frontmatter. Keep public `/docs` URLs, heading IDs, `lib/page-titles.ts`, `lib/docs-navigation.ts
LangChainAGENTS.mdlangchain-ai/langchainjs/AGENTS.md
AGENTS.md - AI Agent Guidelines for LangChain.js This document provides guidance for AI coding agents working with the LangChain.js codebase. ## Corridor security analysis When Corridor's `analyzePlan` tool is available, create
rowboatlabsAGENTS.mdrowboatlabs/rowboat/AGENTS.md
with the date and the decision or PR they implement. The code says what. - Documents own one kind of fact each and link to each other rather than restate. There
AgriciDanielAGENTS.mdAgriciDaniel/claude-seo/AGENTS.md
docs.x.ai/build/features/skills-plugins-marketplaces). | | **OpenAI Codex CLI** | Reads `AGENTS.md` from project root. Bash tools work as documented; some Claude-specific tool names (Read/Write/Edit) are aliased to Codex equivalents transparently. | | **Cline** | Loads `AGENTS.md
Google CloudAGENTS.mdGoogleCloudPlatform/generative-ai/search/gemini-enterprise/ge-demo-generator/AGENTS.md
matched; double-bracing does NOT escape. - WRONG in instruction text: `.../collection/{document_id}`, `/form/item_{i}_name` - RIGHT: `.../collection/ `, `/form/item_i_name` (or `[i]`) `[BRACKET]` and ` ` notations are safe. This
Google CloudAGENTS.mdGoogleCloudPlatform/generative-ai/search/gemini-enterprise/group-licensing/AGENTS.md
this codebase**, any skill, agent, or subagent **MUST first read the service Technical Design Document (TDD)** located at [docs/TDD.md](file:///usr/local/google/home/williamsmt/Projects/development/generative-ai/search/gemini-enterprise/group-licensing/docs/TDD.md) (in the `docs/` subdirectory). This document contains the definitive
An open format for instructions to coding agents, read by Codex, Cursor and others. Think of it as a README written for agents.
At the repository root, with more specific files in subdirectories. Agents read the one closest to the file they're editing.
Setup and test commands, code style, and the rules a new contributor would need to know.
Claude Code reads CLAUDE.md. A one-line CLAUDE.md that points at AGENTS.md covers both.
