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 50Worked for most · soon
MicrosoftAGENTS.md

PhiCookBook / zh-HK

microsoft/PhiCookBook/translations/zh-HK/AGENTS.md

PhiCookBook 是一個全面的食譜庫,包含了 Microsoft Phi 系列小語言模型(SLMs)的實作範例、教學及文件。此庫展示了包括推論、微調、量化、RAG 實現及多模態應用於不同平台與框架的多種使用案例。 關鍵技術: - 語言: Python、C#/.NET、JavaScript/Node.js - 框架: ONNX Runtime、PyTorch、Transformers、MLX、OpenVINO、Semantic Kernel - 平台: Microsoft Foundry、GitHub Models、Hugging Face、Ollama - 模型類型: Phi-3、Phi-3.5、Phi-4(文字、視覺、多模態、推理變體) 倉庫結構: - /code/ - 工作代碼範例與示範實作 - /md/ - 詳細文件、教學及操作指南 - /translations/ - 多語言翻譯(通過自動化工作流程支持超過50種語言) - /.devcontainer/ - 開發容器設定(含 Python 3.12 與 Ollama) Prerequisites: - Python 3.12 or later - .NET 8.0 SDK (for C# examples) - Node.js 18+ and npm (for JavaScript examples) - 16GB RAM minimum recommended Installation: For Python Examples: Navigate to specific example directories…

3.9k7mo agoDiscuss
MicrosoftAGENTS.md

PhiCookBook / zh-MO

microsoft/PhiCookBook/translations/zh-MO/AGENTS.md

PhiCookBook 是一個全面的廚房書庫,包含針對微軟 Phi 系列小型語言模型(SLMs)進行操作的實務範例、教學和文件。該庫展示了多種使用案例,包括推理、微調、量化、RAG 實作以及跨不同平台與框架的多模態應用。 主要技術: - 語言: Python、C#/.NET、JavaScript/Node.js - 框架: ONNX Runtime、PyTorch、Transformers、MLX、OpenVINO、Semantic Kernel - 平台: Microsoft Foundry、GitHub Models、Hugging Face、Ollama - 模型類型: Phi-3、Phi-3.5、Phi-4(文本、視覺、多模態、推理變體) 倉庫結構: - /code/ - 實作程式碼範例及樣本 - /md/ - 詳細的文件、教程和操作指南 - /translations/ - 多語言翻譯(50 多種語言通過自動化工作流程) - /.devcontainer/ - 開發容器配置(Python 3.12 搭配 Ollama) 先決條件: - Python 3.12 或更新版本 - .NET 8.0 SDK(用於 C# 範例) - Node.js 18+ 及 npm(用於 JavaScript 範例) - 建議最低 16GB RAM Python 範例: 進入指定範例目錄並安裝依賴: JavaScript/Web 範例: 大多數範例以 Jupyter 筆記本形式提供: 本倉庫包含範例代碼及教程,而非傳統帶有單元測試的軟件項目。驗證通常通過以下方式完成: 常見驗證方式: - 在目標環境中測試範例執行 - 驗證依賴安裝正確…

3.9k7mo agoDiscuss
MicrosoftAGENTS.md

PhiCookBook / zh-TW

microsoft/PhiCookBook/translations/zh-TW/AGENTS.md

PhiCookBook 是一個綜合性的食譜存放庫,包含針對 Microsoft Phi 系列小型語言模型(SLMs)的實作範例、教學與文件。此存放庫展示多種使用案例,涵蓋推論、微調、量化、RAG 實作,以及跨不同平台和框架的多模態應用。 主要技術: - 語言: Python、C#/.NET、JavaScript/Node.js - 框架: ONNX Runtime、PyTorch、Transformers、MLX、OpenVINO、Semantic Kernel - 平台: Microsoft Foundry、GitHub Models、Hugging Face、Ollama - 模型類型: Phi-3、Phi-3.5、Phi-4(文本、視覺、多模態、推理變種) 存放庫結構: - /code/ - 可操作的程式碼範例與示範實作 - /md/ - 詳細文件、教學與操作指南 - /translations/ - 多語言翻譯(超過50種語言透過自動化工作流程) - /.devcontainer/ - 開發容器配置(Python 3.12 與 Ollama) 前置需求: - Python 3.12 或更新版本 - .NET 8.0 SDK(用於 C# 範例) - Node.js 18+ 與 npm(用於 JavaScript 範例) - 建議記憶體至少16GB Python 範例: 進入特定範例目錄並安裝相依套件: JavaScript/網頁範例: 大部分範例均為 Jupyter 筆記本形式: 本存放庫提供的是範例程式碼與教學,而非傳統軟體專案單元測試。驗證通常透過: 常見驗證方式: - 在目標環境測試範例執行 - 確認套件正確安裝 - 驗證模型能下載/載入成功 -…

3.9k7mo agoDiscuss
OpenAIAGENTS.md

openai-agents-js

openai/openai-agents-js/AGENTS.md

This guide helps new contributors get started with the OpenAI Agents JS monorepo. It covers repo structure, how to test your work, available utilities, file locations, and guidelines for commits and PRs. Location: AGENTS.md at the repository root. Follow SECURITY.md for repository scope and private vulnerability reporting, and CONTRIBUTING.md for contributor security practices. These requirements guide work; their presence does not prove that GitHub or registry controls are configured or that a security scan has completed.

3.9k8mo agoReads credentialsDiscuss
MicrosoftAGENTS.md

mcp

microsoft/mcp/AGENTS.md

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

3.7k30d agoReads credentialsDiscuss
Model Context ProtocolAGENTS.md

java-sdk

modelcontextprotocol/java-sdk/AGENTS.md

Java SDK for the Model Context Protocol, enabling Java applications to implement MCP clients and servers (sync and async) over stdio, SSE, and Streamable HTTP transports. Formatting (spring-javaformat) is validated automatically as part of every build (bound to the validate phase), so a formatting violation fails ./mvnw test before any tests run. Fix violations with: Records in McpSchema are serialized directly to the MCP JSON wire format, so changing one is a wire-format change, not a routine refactor. Whether a…

3.7k3mo agoDiscuss
ElasticAGENTS.md

elasticsearch-net

elastic/elasticsearch-net/AGENTS.md

The repository builds with the standard .NET SDK CLI; the SDK version is pinned in global.json. - Build the client: dotnet build src/Elastic.Clients.Elasticsearch/Elastic.Clients.Elasticsearch.csproj - Build and test the request converter: dotnet test RequestConverter.sln (requires the wasm-tools workload: dotnet workload install wasm-tools) A legacy Bullseye build system (./build.sh, .\build.bat, driven by the F# project build/scripts/scripts.fsproj) still backs a few CI workflows. It is planned to be modernized or removed; do not use it for local development. There is no separate lint…

3.6k58d agoDiscuss
GoogleAGENTS.md

recaptcha

google/recaptcha/AGENTS.md

This file provides authoritative context, architectural invariants, branching policies, and verification requirements for AI coding agents and maintainers working on google/recaptcha.

3.6k8d agoDiscuss
NVIDIAAGENTS.md

TransformerEngine

NVIDIA/TransformerEngine/AGENTS.md

This file provides repository-specific guidance for working on Transformer Engine. README.rst, CONTRIBUTING.rst, docs/, qa/ remain the authoritative sources for user documentation, contribution policy, and executable CI behavior. Transformer Engine provides optimized building blocks for Transformer models on NVIDIA GPUs. It is not a complete model-training system. Higher-level frameworks and toolkits compose its operations and modules into models and own model-level orchestration. Most functionality is at or below the level of an individual Transformer layer. Tensor, sequence, expert, and context parallel…

3.6k8d agoDeletes or force-pushesDiscuss
VercelAGENTS.md

wterm

vercel-labs/wterm/AGENTS.md

All apps and examples with dev servers use portless to avoid hardcoded ports. Portless assigns random ports and exposes each app via .localhost URLs. Naming convention: - Docs app: docs.wterm → docs.wterm.localhost - Examples: <name>.wterm → <name>.wterm.localhost When adding a new app or example that runs a dev server, wrap its dev script with portless <name>: Do not add --port flags — portless handles port assignment automatically. Do not add portless as a project dependency; it must be installed globally.

3.5k6mo agoDiscuss
VercelAGENTS.md

wterm / nextjs

vercel-labs/wterm/examples/nextjs/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 monorepos the next package may not be visible from the repo root) before writing any code. Heed deprecation notices. This block is written and re-added by next dev — verify at node_modules/next/dist/server/lib/generate-agent-files.js. Removing it from a diff only re-creates the uncommitted change; committing it with your work keeps the tree…

3.5k6mo agoDiscuss
OpenAIAGENTS.md

openai-go

openai/openai-go/AGENTS.md

Most SDK source is generated by Castiron. Follow CONTRIBUTING.md before changing generated files. Handwritten policy, automation, tests, and examples should remain small and should not alter exported SDK APIs unless the change explicitly requires it. Follow the custom-code guidance. Budget changes belong in a separate PR containing only .castiron-ratchet.json, with an explicit justification in the PR description. Increases require a human approving review before merging. Agents may investigate and draft proposals, but must not approve budget increases (including through a…

3.5k40d agoReads credentialsDiscuss
AWSAGENTS.md

agentcore-samples / codex

awslabs/agentcore-samples/01-features/02-host-your-agent/01-runtime/04-coding-agents/03-code-agents-competition-e2e/coding_agents/codex/AGENTS.md

You are a coding agent running on AWS Bedrock AgentCore. You fix bugs in GitHub repositories by reading issues, applying fixes, and submitting PRs. You have a gateway MCP server connected that provides GitHub tools. Use them directly — they are available as native tools. When given a prompt, act immediately: 1. Extract the repository owner, repository name, and issue number from the user's message. 2. Use the MCP tools to read the issue, fix the code, and submit a…

3.4k4mo agoDiscuss
AWSAGENTS.md

agentcore-samples / open-code

awslabs/agentcore-samples/01-features/02-host-your-agent/01-runtime/04-coding-agents/03-code-agents-competition-e2e/coding_agents/open-code/AGENTS.md

You are a coding agent running on AWS Bedrock AgentCore. You fix bugs in GitHub repositories by reading issues, applying fixes, and submitting PRs. You have a gateway MCP server connected that provides GitHub tools. Use them directly — they are available as native tools. When given a prompt, act immediately: 1. Extract the repository owner, repository name, and issue number from the user's message. 2. Use the MCP tools to read the issue, fix the code, and submit a…

3.4k4mo agoDiscuss
AWSAGENTS.md

agentcore-samples / private-idp-ping-agent

awslabs/agentcore-samples/01-features/05-authenticate-and-authorize/01-inbound-auth/04-inbound-auth-pingfederate/agent/private-idp-ping-agent/AGENTS.md

This project contains configuration and infrastructure for an Amazon Bedrock AgentCore application. The agentcore/ directory is a declarative model of the project. The agentcore/cdk/ subdirectory uses the @aws/agentcore-cdk L3 constructs to deploy the configuration to AWS. The project uses a flat resource model. Agents, memories, credentials, gateways, evaluators, and policies are independent top-level arrays in agentcore.json. There is no binding between resources in the schema — each resource is provisioned independently. Agents discover memories and credentials at runtime via environment…

3.4k4mo agoReads credentialsDiscuss
AWSAGENTS.md

agentcore-samples / bankingassistant

awslabs/agentcore-samples/01-features/07-centralize-and-govern-your-ai-infrastructure/02-policy/03-temporal-policies/bankingassistant/AGENTS.md

This project contains configuration and infrastructure for an Amazon Bedrock AgentCore application. The agentcore/ directory is a declarative model of the project. The agentcore/cdk/ subdirectory uses the @aws/agentcore-cdk L3 constructs to deploy the configuration to AWS. The project uses a flat resource model. Agents, memories, credentials, gateways, evaluators, and policies are independent top-level arrays in agentcore.json. There is no binding between resources in the schema — each resource is provisioned independently. Agents discover memories and credentials at runtime via environment…

3.4k4mo agoReads credentialsDiscuss
AWSAGENTS.md

agentcore-samples / 01-payments-skills-and-cli

awslabs/agentcore-samples/01-features/08-agents-that-transact/01-payments-skills-and-cli/AGENTS.md

This file is for the coding assistant (Claude Code, Codex, Cursor, Kiro). It is a thin orchestration layer that loads the aws-agents payments skill and hands off to it. Do not reinvent the skill's content -- load it and follow it. This runbook supports exactly two scenarios: A short request such as "use this folder to add AgentCore payments" is sufficient. If the scenario (existing vs new) cannot be determined from the prompt or workspace, ask one routing question before…

3.4k4mo agoReads credentialsDiscuss
AWSAGENTS.md

agentcore-samples / event-driven-claims-agent

awslabs/agentcore-samples/02-use-cases/02-workflow-automation-agents/event-driven-claims-agent/AGENTS.md

For humans: This file provides context for AI coding assistants (Kiro, Cursor, Claude Code, GitHub Copilot). For the human-readable documentation, see docs/, README.md, or docs/tutorial.md. This project is an event-driven insurance claims processor built on Amazon Bedrock AgentCore. It uses a dual-agent architecture (Claims Processor + Validation Agent) with cost-based model routing (Sonnet for reasoning, Haiku for validation) and a deterministic execution phase. Deploys as a single CloudFormation stack (AgentCore-ClaimsAgent-dev) via the AgentCore CLI. Important: AgentCore resources (Runtime, Gateway, Memory,…

3.4k4mo 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.