Microsoft AzureKnown publisherAzure/azure-sdk-for-rust/sdk/cosmos/docs/AGENTS.md

azure-sdk-for-rust / cosmos

AGENTS.md887 starsChanged 29 days agoMITView on GitHub

- Start with README.md (README.md), then read Project.md (Project.md) and Architecture.md (Architecture.md) for project context. - Inventory the available specs, ADRs, and reports through README, then read only the documents relevant to the task. Do not load the entire documentation set. - Keep durable Cosmos design documentation under this directory. - Keep only Project.md, Architecture.md, README.md, and AGENTS.md at the top level. - Put mutable feature designs in specs/ using the next available NNNN-kebab-case-name.md number. - Put only finalized, cross-cutting…

Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,774 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository22 other files it gives its agents.
- AGENTS.mdAGENTS.md
- eng/tools/generate_api/AGENTS.mdAGENTS.md
- samples/AGENTS.mdAGENTS.md
- sdk/core/AGENTS.mdAGENTS.md
- sdk/cosmos/AGENTS.mdAGENTS.md
- sdk/cosmos/azure_data_cosmos_emulator/AGENTS.mdAGENTS.md
- agentic-workflowsSkill
- analyze-codeSkill
- check-spellingSkill
- create-crateSkill
- create-hotfixSkill
- create-perf-testSkill
- create-recorded-testSkill
- document-cratesSkill
- export-apiSkill
- lint-markdownSkill
- prepare-releaseSkill
- review-doc-commentsSkill
- update-emitterSkill
- update-rustSkill
- cosmos-design-structSkill
- cosmos-pre-commit-validationSkill

The file

We split this AGENTS.md into the rules it gives an agent

11 rules. About 0 are common, 5 are distinctive, and 6 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
This author's own choices. Worth a look.
6
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
Start with README.md (README.md), then read Project.md (Project.md) and Architecture.md (Architecture.md) for project context.
line 3
Distinctive:
Keep durable Cosmos design documentation under this directory.
line 8
Very specific:
Keep only Project.md, Architecture.md, README.md, and AGENTS.md at the top level.
line 9
Very specific:
Put mutable feature designs in specs/ using the next available NNNN-kebab-case-name.md number.
line 11
Very specific:
Put only finalized, cross-cutting architecture decisions in adrs/ using the next available NNNN-kebab-case-name.md number.
line 13
Distinctive:
Keep feature-specific choices, detailed mechanics, and evolving design rationale in the relevant spec, even when the choice is important.
line 17
Distinctive:
Treat the decision text of accepted ADRs as immutable.
line 19
Very specific:
Update the old ADR's Status field with the superseding ADR number and update the README index so readers can discover the current decision …
line 21
Very specific:
Put historical investigations and measurement results in reports/ without sequence numbers.
line 27
Distinctive:
Update README.md (README.md) and affected links whenever adding, moving, or superseding a document.
line 29
Distinctive:
Leave crate READMEs, changelogs, contributor guidance, and source-consumed Rustdoc fragments with their crates.
line 33

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

AGENTS.md

Cosmos Documentation Instructions

Start with README.md (README.md), then read Project.md (Project.md) and Architecture.md (Architecture.md) for project context.
Inventory the available specs, ADRs, and reports through README, then read only the documents relevant to the task. Do not load the entire documentation set.
Keep durable Cosmos design documentation under this directory.
Keep only Project.md, Architecture.md, README.md, and AGENTS.md at the top level.
Put mutable feature designs in specs/ using the next available NNNN-kebab-case-name.md number.
Put only finalized, cross-cutting architecture decisions in adrs/ using the next available NNNN-kebab-case-name.md number. An ADR must capture a core constraint with meaningful alternatives that agents and maintainers must respect across features.
Keep feature-specific choices, detailed mechanics, and evolving design rationale in the relevant spec, even when the choice is important.
Treat the decision text of accepted ADRs as immutable. Add a new ADR that explicitly supersedes an old decision instead of rewriting the old ADR. Update the old ADR's Status field with the superseding ADR number and update the README index so readers can discover the current decision without reading every later ADR.
The 2026 core-ADR rewrite was a one-time, human-approved cleanup of the pre-existing feature ADRs. It does not create a general exception to ADR immutability.
Put historical investigations and measurement results in reports/ without sequence numbers.
Update README.md (README.md) and affected links whenever adding, moving, or superseding a document.
Link to detailed specs and ADRs instead of duplicating their content in Project.md or Architecture.md.
Leave crate READMEs, changelogs, contributor guidance, and source-consumed Rustdoc fragments with their crates.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free