Skip to content

Conversation

johnsaigle
Copy link
Contributor

@johnsaigle johnsaigle commented Aug 27, 2025

LLM agent tools are very popular for developers and auditors alike. Providing an AGENTS.md file should allow them to be more effective with their tools. We may as well add one here because people using these tools will be creating their own versions of it anyway.

I used the nomenclature from https://agents.md because it seems to be the most general/least vendor-specific, but I'm open to using a different style or name.

It's important to keep these files pretty concise in order to not waste context window space or otherwise 'poison' the window with irrelevant or misleading info. As a result, I tried to avoid content that's already well-covered by README, CONTRIBUTING, and DEVELOP or items that are already handled by CI.

@johnsaigle johnsaigle added the documentation Improvements or additions to documentation label Aug 27, 2025
@johnsaigle johnsaigle marked this pull request as ready for review August 27, 2025 16:51
Copy link
Collaborator

@djb15 djb15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a good idea what a strong AGENTS.md looks like, but I don't see any reason why we shouldn't add this and try it out. We can always modify it over time

@johnsaigle
Copy link
Contributor Author

@djb15 For reference, most of these tools have some sort of init command that scans existing tests, makefiles, build scripts and so on to auto-generate the AGENTS.md (or equivalent). This one was generated by opencode.

We can absolutely iterate on the exact contents and try multiple approaches.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants