← All IntelClip / AI Agentsagents.md is not a README, and the glossary is for the agent's output
From I made Claude smarter by writing it a letter · ≈24:19
Reframes both files: the README tells humans what the project is, the agents file tells an agent how to change it — and a glossary of even obvious terms mainly fixes how the agent talks back to you.
What’s in it
- Reframes both files: the README tells humans what the project is, the agents file tells an agent how to change it — and a glossary of even obvious terms mainly fixes how the agent talks back to you.
Clip transcript
than now to dive into our agents MD file. Another very important thing is that your agent MD should be incredibly different from your readme MD. The point of a readme is context on the project and what it is that is useful for humans and agents that are trying to decide if they want to pull in this code. The point of the agent and cloudmd files is to tell the agent how to change things in the codebase and what it should know before it makes those changes. So yes, there are parts of this that should be descriptions of the project, but the majority of what's going on here really should be focused on how your agents will work in the project. While there is a lot of overlap between developers contributing to a project and agents doing those contributions, this file really should not be written for devs. It should be written for agents to help the agent interact with the dev better. And with that said, one of the most important details you can get right in these is a glossery. I like writing these not just so the agent understands me because it's usually pretty good at that. It can infer what I mean when I talk about a thing that I want it to do. The glossery can help it understand what I'm saying a little bit, but the glossery is much more helpful for the agent to describe things to me the way I want it to. And a lot of these base terms are really simple. Most of them are terms that it probably already knew. But when you give it this type of really simple language to describe things with, it becomes much easier to talk to the agent because it knows how you're thinking and how you and your team are working. So our glossery is really simple here. The first word defined in the glossery is you, which means the agent reading this file and changing T3 code. We, us, and maintainers mean Theo,
Comments
Checking sign-in…
Loading comments…