agentleFS
Sign inSign up

AGENTS.md examples from real projects

How real projects brief Codex, Cursor and every other agent that reads AGENTS.md.

Most stars first · from page 31Worked for most · soon
Hugging FaceAGENTS.md

smolagents / reference

huggingface/smolagents/docs/source/hi/reference/agents.md

Smolagents एक experimental API है जो किसी भी समय बदल सकता है। एजेंट्स द्वारा लौटाए गए परिणाम भिन्न हो सकते हैं क्योंकि APIs या underlying मॉडल बदलने की संभावना रखते हैं। Agents और tools के बारे में अधिक जानने के लिए introductory guide पढ़ना सुनिश्चित करें। यह पेज underlying क्लासेज के लिए API docs को शामिल करता है। हमारे एजेंट्स [MultiStepAgent] से इनहेरिट करते हैं, जिसका अर्थ है कि वे कई चरणों में कार्य कर सकते हैं, प्रत्येक चरण में…

30k14mo agoReads credentialsDiscuss
Hugging FaceAGENTS.md

smolagents / reference

huggingface/smolagents/docs/source/ko/reference/agents.md

Smolagents는 실험적인 API로 언제든지 변경될 수 있습니다. API나 사용되는 모델이 변경될 수 있기 때문에 에이전트가 반환하는 결과도 달라질 수 있습니다. 에이전트와 도구에 대해 더 자세히 알아보려면 소개 가이드를 꼭 읽어보세요. 이 페이지에는 기본 클래스에 대한 API 문서가 포함되어 있습니다. 저희 에이전트는 [MultiStepAgent]를 상속받으며, 이는 하나의 생각과 하나의 도구 호출 및 실행으로 구성된 여러 단계를 수행할 수 있음을 의미합니다. 이 개념 가이드에서 더 자세히 알아보세요. 저희는 메인 [Agent] 클래스를 기반으로 두 가지 유형의 에이전트를 제공합니다. - [CodeAgent]는 Python 코드로 도구 호출을…

30k14mo agoDiscuss
Hugging FaceAGENTS.md

smolagents / reference

huggingface/smolagents/docs/source/zh/reference/agents.md

Smolagents 是一个实验性的 API,可能会随时发生变化。由于 API 或底层模型可能发生变化,代理返回的结果也可能有所不同。 要了解有关智能体和工具的更多信息,请务必阅读入门指南。本页面包含基础类的 API 文档。 我们的智能体继承自 [MultiStepAgent],这意味着它们可以执行多步操作,每一步包含一个思考(thought),然后是一个工具调用和执行。请阅读概念指南以了解更多信息。 我们提供两种类型的代理,它们基于主要的 [Agent] 类: - [CodeAgent] 是默认代理,它以 Python 代码编写工具调用。 - [ToolCallingAgent] 以 JSON 编写工具调用。 两者在初始化时都需要提供参数 model 和工具列表 tools。 [[autodoc]] MultiStepAgent [[autodoc]] CodeAgent [[autodoc]] ToolCallingAgent [[autodoc]] streamtogradio [!TIP] 您必须安装 gradio 才能使用 UI。如果尚未安装,请运行 pip install 'smolagents[gradio]'。 [[autodoc]] GradioUI [[autodoc]] smolagents.agents.PromptTemplates [[autodoc]] smolagents.agents.PlanningPromptTemplate [[autodoc]] smolagents.agents.ManagedAgentPromptTemplate [[autodoc]] smolagents.agents.FinalAnswerPromptTemplate

30k14mo agoDiscuss
chroma-coreAGENTS.md

chroma

chroma-core/chroma/AGENTS.md

See CLAUDE.md for codebase conventions (commit message format, etc.).

29k3y agoDiscuss
alibabaAGENTS.md

page-agent

alibaba/page-agent/AGENTS.md

This is a monorepo with npm workspaces: Internal packages: Source-first monorepo: library package.json exports point to src/*.ts during development. At publish time, scripts/pre-publish.js promotes publishConfig fields to top-level (swapping to dist/), and scripts/post-publish.js restores the originals. workspaces in package.json must be in topological order. All communication is async and isolated:

29k3mo agoDiscuss
rohitg00AGENTS.md

agentmemory

rohitg00/agentmemory/AGENTS.md

agentmemory is a persistent memory system for AI coding agents, built on iii-engine's three primitives (Worker/Function/Trigger). Everything goes through registerFunction/registerTrigger/sdk.trigger() — never bypass iii-engine with standalone SQLite or in-process alternatives. When adding or removing MCP tools, you MUST update ALL of the following: 1. src/mcp/tools-registry.ts — tool definition + getAllTools() array 2. src/mcp/server.ts — handler case in the mcp::tools::call switch 3. src/triggers/api.ts — REST endpoint registration 4. src/index.ts — function registration + endpoint count in the log line 5. test/mcp-standalone.test.ts…

29k53d agoDiscuss
MongoDBAGENTS.md

mongo / jstests

mongodb/mongo/jstests/AGENTS.md

ALWAYS use our own assertion library that is defined at src/mongo/shell/assert.js and automatically loaded into the global scope before running each test. ALWAYS wrap commands with assert.commandWorked(), unless failures are…

29k5mo agoDiscuss
yamadashyAGENTS.md

repomix

yamadashy/repomix/AGENTS.md

.agents/rules/base.md

29k45d agoDiscuss
kestra-ioAGENTS.md

kestra

kestra-io/kestra/AGENTS.md

This document provides essential information for AI coding agents working on the Kestra codebase. IMPORTANT — READ FIRST The default is no comment. Small methods with accurate names need no explanation, and every comment is a second thing that has to be kept in sync with the code. Over-commenting is easy to slip into: the next line gets narrated, the method name gets restated above the method, and // Step 1 / // Step 2 scaffolding is left behind. None…

28k20d agoReads credentialsDiscuss
kestra-ioAGENTS.md

kestra / ui

kestra-io/kestra/ui/AGENTS.md

Scope: this file applies to everything under ui/. AI coding agents (Claude Code, Cursor, etc.) load this file automatically when working in this directory; humans should treat it as the source of truth for frontend conventions in Kestra. The Kestra design system lives at ui/packages/design-system/ and is the single source of truth for every visual element of the product — colors, fonts, spacing, buttons, forms, dialogs, tables, charts, and so on. Anything rendered to a user must come from it.

28k20d agoDiscuss
BloopAIAGENTS.md

vibe-kanban

BloopAI/vibe-kanban/AGENTS.md

ts-rs allows you to derive TypeScript types from Rust structs/enums. By annotating your Rust types with #[derive(TS)] and related macros, ts-rs will generate .ts declaration files for those types. When making changes to the types, you can regenerate them using pnpm run generate-types Do not manually edit shared/types.ts, instead edit crates/server/src/bin/generate_types.rs For remote/cloud types, regenerate using pnpm run remote:generate-types Do not manually edit shared/remote-types.ts, instead edit crates/remote/src/bin/remote-generate-types.rs (see crates/remote/AGENTS.md for details).

28k6mo agoReads credentialsDiscuss
BloopAIAGENTS.md

vibe-kanban

BloopAI/vibe-kanban/docs/AGENTS.md

You are an AI writing assistant specialised in creating exceptional technical documentation using Mintlify components and following industry-leading technical writing practices. Example of a single code block: Example of a code group:

28k6mo agoReads credentialsDiscuss
Hugging FaceAGENTS.md

lerobot

huggingface/lerobot/AGENTS.md

**User-facing help → AGENT_GUIDE.md** (SO-101 setup, recording, picking a policy, training duration, eval — with copy-pasteable commands). LeRobot is a PyTorch-based library for real-world robotics, providing datasets, pretrained policies, and tools for training, evaluation, data collection, and robot control. It integrates with Hugging Face Hub for model/dataset sharing. Python 3.12+ · PyTorch · Hugging Face (datasets, Hub, accelerate) · draccus (config/CLI) · Gymnasium (envs) · uv (package management)

28k7d agoDiscuss
MicrosoftAGENTS.md

vcpkg

microsoft/vcpkg/AGENTS.md

No summary in the file. Open it to read it.

28k9d agoDiscuss
gastownhallAGENTS.md

beads

gastownhall/beads/AGENTS.md

See AGENT_INSTRUCTIONS.md for full instructions. This file exists for compatibility with tools that look for AGENTS.md. The marker above tells bd doctor that the intentional divergence between this file and CLAUDE.md (different audiences, different reading orders) is expected and should not be flagged. Before adding new feature surface area, read engdocs/PROJECT_CHARTER.md. Beads owns issue tracking primitives and should not encode orchestration-layer policy, become a storage engine, or casually expand the database schema when metadata would work. Before triaging, reviewing, landing,…

27k6mo agoDeletes or force-pushesDiscuss
manaflow-aiAGENTS.md

cmux / cmux-browser

manaflow-ai/cmux/cmux-browser/AGENTS.md

The Chromium-based cmux Browser product: a source overlay and build harness, not a Chromium checkout. Never vendor Chromium, generated build output, signed applications, update keys, or private builder configuration here.

27k4d agoDiscuss
manaflow-aiAGENTS.md

cmux / cmux-tui

manaflow-ai/cmux/cmux-tui/AGENTS.md

Maintainers do not run cargo, rustc, or Zig on their local Mac and do not use a local build as a fallback. Commit and push the exact branch head to…

27k4d agoDiscuss
manaflow-aiAGENTS.md

cmux / ios

manaflow-ai/cmux/ios/AGENTS.md

iOS app-target work in this directory follows Packages/iOS/AGENTS.md, including its Apple Human Interface Guidelines rule. Read it before changing UI. For connectivity, auth, lifecycle, workspace or terminal changes, follow docs/ios-connectivity-soak.md.…

27k4d agoReads credentialsDiscuss
manaflow-aiAGENTS.md

cmux / cmux-browser

manaflow-ai/cmux/skills/cmux-browser/AGENTS.md

Read SKILL.md before using the cmux browser CLI. - Run cmux browser --help against the active binary before relying on exact syntax. - Discover an existing browser with cmux tree…

27k4d agoDiscuss
manaflow-aiAGENTS.md

cmux / web

manaflow-ai/cmux/web/AGENTS.md

This version has breaking changes — APIs, conventions, and file structure may all differ from your training data. Read the relevant guide in node_modules/next/dist/docs/ (resolved from this file's directory; in…

27k4d agoDiscuss
CLAUDE.md vs AGENTS.md

About AGENTS.md

What is AGENTS.md?

An open format for instructions to coding agents, read by Codex, Cursor and others. Think of it as a README written for agents.

Where does it go?

At the repository root, with more specific files in subdirectories. Agents read the one closest to the file they're editing.

What should it contain?

Setup and test commands, code style, and the rules a new contributor would need to know.

Does Claude Code read it?

Claude Code reads CLAUDE.md. A one-line CLAUDE.md that points at AGENTS.md covers both.