agentleFS
Sign inStart free
MicrosoftKnown publishermicrosoft/agent-framework-durable-extension/docs/features/durable-agents/AGENTS.md

agent-framework-durable-extension / durable-agents

AGENTS.md25 starsChanged 4 months agoMITView on GitHub

Instructions for AI coding agents working on durable agents documentation. This directory contains feature documentation for the durable agents integration. The source code and samples live elsewhere: Add new sibling documents when a topic is too detailed for the README (e.g., a new feature like reliable streaming or MCP tool exposure). Keep the README focused on orientation and link out to siblings for depth. Run markdownlint on all documents before committing, with line-length checks disabled:

  • 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,439 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 repository2 other files it gives its agents.

The file

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

7 rules. About 0 are common, 5 are distinctive, and 2 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.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Add new sibling documents when a topic is too detailed for the README (e.g., a new feature like reliable streaming or MCP tool exposure).

    line 22
  2. Distinctive:

    Both languages: Always include C# and Python examples side by side.

    line 28
  3. Very specific:

    Callout syntax: Use GitHub-flavored callouts (> [!NOTE], > [!IMPORTANT], > [!WARNING]) rather than bold-text callouts (> Note: ...).

    line 29
  4. Distinctive:

    Line length: Do not wrap long lines. Rely on text viewers / renderers for line wrapping.

    line 30
  5. Very specific:

    Tables: Use spaces around pipes in separator rows (| --- | not |---|).

    line 31
  6. Distinctive:

    Code snippets: Keep them minimal and self-contained.

    line 32
  7. Distinctive:

    Run markdownlint on all documents before committing, with line-length checks disabled:

    line 37

≈ “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

AGENTS.md

Instructions for AI coding agents working on durable agents documentation.

Scope

This directory contains feature documentation for the durable agents integration. The source code and samples live elsewhere:

  • .NET implementation: dotnet/src/Microsoft.Agents.AI.DurableTask/ and dotnet/src/Microsoft.Agents.AI.Hosting.AzureFunctions/
  • Python implementation: python/packages/durabletask/; Python Azure Functions hosting is in the agent-framework-azurefunctions package (python/packages/azurefunctions/)
  • .NET samples: dotnet/samples/DurableAgents/
  • Python samples: python/samples/
  • Official docs (Microsoft Learn): https://learn.microsoft.com/agent-framework/integrations/azure-functions

Document structure

FilePurpose
README.mdMain technical overview: architecture, hosting models, orchestration patterns, and links to samples.
durable-agents-ttl.mdDeep-dive on session Time-To-Live (TTL) configuration and behavior.

Add new sibling documents when a topic is too detailed for the README (e.g., a new feature like reliable streaming or MCP tool exposure). Keep the README focused on orientation and link out to siblings for depth.

Writing guidelines

  • Audience: Developers already familiar with the Microsoft Agent Framework who want to understand what durability adds and how to use it.
  • Host-agnostic first: Durable agents work in console apps, Azure Functions, and any Durable Task–compatible host. Show host-agnostic patterns (plain orchestration functions, IServiceCollection registration) before Azure Functions–specific patterns. Avoid giving the impression that Azure Functions is the only hosting option.
  • Both languages: Always include C# and Python examples side by side. Keep them equivalent in functionality.
  • Callout syntax: Use GitHub-flavored callouts (> [!NOTE], > [!IMPORTANT], > [!WARNING]) rather than bold-text callouts (> **Note:** ...).
  • Line length: Do not wrap long lines. Rely on text viewers / renderers for line wrapping.
  • Tables: Use spaces around pipes in separator rows (| --- | not |---|).
  • Code snippets: Keep them minimal and self-contained. Omit boilerplate (using statements, environment variable reads) unless the snippet is specifically about setup.
  • Cross-references: Link to Microsoft Learn for conceptual background (Durable Entities, Durable Task Scheduler, Azure Functions). Link to sibling docs within this directory for feature deep-dives.

Linting

Run markdownlint on all documents before committing, with line-length checks disabled:

markdownlint docs/features/durable-agents/ --disable MD013

When to update these docs

  • A new durable agent feature is added (e.g., a new orchestration pattern, hosting model, or configuration option).
  • The public API surface changes in a way that affects how developers use durable agents.
  • New sample directories are added — update the sample links in README.md.
  • The official Microsoft Learn documentation is restructured — update external links.

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