Commit an Agents.MD file to any-llm

[njbrake]

At this point, vibe coding/llm assisted coding is here. People are using it, and in my opinion it will likely make our lives easier if we work to embrace the incoming standards to help people maximize the usefulness of their agents and help give them all the info we can to avoid hallucinated/invalid PRs etc.

I propose that we create, commit, and maintain an Agents.md file to any-llm. At this point Agents.md is a relatively accepted standard (?) for giving coding agents basic info about a repo

https://agents.md/

Claude Code uses a Claude.md file instead of Agents.MD but theoretically they'll follow suite and accept Agents.MD soon too.

[iamgautamraj]

Hi @njbrake .good idea actually! I'd be happy to take this on.

I've been using agents.md with a few repos and can draft something that covers the essentials - project structure, key abstractions, contribution patterns, etc.

Mind if I give it a shot?

[njbrake]

Hi @iamgautamraj ! The implementation here will actually be pretty trivial, so I'm not too concerned about that part. Running /init in codex gets the starter Agents.md file, which then we can tweak slightly and amend as we get more runtime with what would be useful.

I'm interested here in gathering thoughts about

1. Is it a good idea to have our centralized agents.md file, or should we rely upon each developer to maintain their own files, as they see fit? It's sort of like how we all have our own particular Vscode configurations that we like, which we don't always commit to git
2. Should we have multiple agents.md files in relevant dirs, like one in the gateway folder, the tests folder, etc

[daavoo]

I'm interested here in gathering thoughts about

Is it a good idea to have our centralized agents.md file, or should we rely upon each developer to maintain their own files, as they see fit? It's sort of like how we all have our own particular Vscode configurations that we like, which we don't always commit to git
Should we have multiple agents.md files in relevant dirs, like one in the gateway folder, the tests folder, etc

I am fine with adding an agents.md file, I would just try to write it in a way that doesn't duplicate info and instead reference to existing docs like: https://github.com/apache/airflow/blob/main/AGENTS.md