我的 agent.md,用于提升 LLM 辅助代码质量
My agent.md to improve LLM-assisted code quality

原始链接: https://fabiensanglard.net/agent.md/index.html

作者分享了他们将大语言模型(LLM)整合进编码工作流的历程。2025至2026年间的初步尝试效果欠佳,代码不仅无法编译,还充斥着混乱的“面条式”结构。随着代理式集成开发环境(Agentic IDEs)的兴起,迭代改进成为可能,但手动纠正模型的编码风格和结构依然十分繁琐。 为解决这一问题,作者引入了 `agent.md`,这是一个注入到大语言模型提示词中的配置文件。该文件作为持久化的风格指南,强制执行特定的编码标准——例如避免硬编码数字、遵守分层架构边界、以及要求在修复漏洞时采用测试驱动开发(TDD)——从而免去了重复的人工修正。 作者指出,尽管 `agent.md` 显著提升了代码质量,但大语言模型仍易出现“上下文稀释”和幻觉。为应对这些问题,他们建议保持较短的上下文窗口,频繁重新加载 `agent.md` 指令,并允许代理自主更新配置文件。最终,这种方法将开发者的角色从修复语法和风格转变为专注于高层架构与验证,有效地将大语言模型转变为一名纪律严明、但偶尔仍会出错的初级开发人员。

这篇 Hacker News 帖子讨论了使用专门的 `agents.md` 文件来引导大语言模型保持代码质量的利弊。 社区对此反响不一。一些用户认为,此类文件中提供的建议(例如强制要求使用大括号或保持代码简洁)应当通过自动化的 Lint 工具来处理,这样无论是对人类开发者还是 AI 都有益处。另一些人则批评了其中的具体建议(例如要求撰写“是什么”的注释),认为 AI 已经生成了太多的“冗余”和“废话”式文档。 一个反复出现的话题是,有效的 AI 提示词极其依赖语境;贡献者指出,通用的代理指令往往不如针对项目的经验或维护良好的 `CONTRIBUTING.md` 文档有效。最终,一些评论者认为 `agents.md` 是一种多余的抽象,并建议如果能被 AI 工具正确引用,标准的文档实践就已经足够了。
相关文章

原文
My agent.md to improve LLM-assisted code quality

Aug 21, 2026

My agent.md to improve LLM-assisted code quality

The first time I tried to use an LLM to speed up coding was in mid-2025. I was not impressed. I was working on libadbmdns back then, an mDNS implementation in Rust. The code produced would not even compile.

I revisited LLMs in January 2026. This time it worked better. Not only did it write a complex indexed-binary heap class, it was able to pinpoint an obscure bug in the polling crate due to the Windows IOCP implementation.

However, the code quality was abysmal. It was spaghetti code with no comments and no structure. It was cool but not realistic to work with LLMs if the speed gain was lost to cleaning up the code until it met the production-level bar.

Iterating and repeating myself over and over again

In March 2026, I tried to use agentic IDEs like Antigravity and VS Code's Claude Code plugin. I was now able to "iterate" over the "staged" code. I found myself reviewing the code of an infinitely patient junior CS major with suggestions like "don't use magic numbers", "add a short comment here to explain yourself", or "use short function names".

The code quality improved dramatically. It was very close to what I would have produced "by hand" but it was tedious. I ended up repeating myself over and over again in each new session.

Agent.md to the rescue

When a coding session starts, the coding harness loads a file named agent.md and injects it into the prompt. This is the perfect location to super fine-tune coding style preferences. When I found myself repeating the same suggestion to improve the code, I added it in there.

Here is my version of agent.md as a starting point if you need one. Placing it in the root of a project should be enough. Alternatively, gemini.md/claude.md can be symlinked toward an agent.md to have it active anywhere.

# FAB's AGENT.MD

- When writing something intended for human consumption, (comment, commit message, reply to prompt) use as few words as possible. Pick every word meticulously to reduce the volume to a strict minimum. Be down to the point. Less is more.

- Avoid superlatives and praise. Stop telling me I am absolutely right. Give me the cold hard truth.

- Avoid magic numbers and strings by extracting recurring or meaningful values into descriptive constants (const) or enums. Keep self-explanatory, one-off values inline to avoid clutter. If a value comes from a spec (e.g. HTTP 200 OK), use a constant regardless.

- Reduce code indentation. Avoid Arrow Anti-Pattern. Leverage early return and continue.

- Keep function names short. Less than 30 characters.

- Use enums instead of booleans for function parameters.

- Let the reader of the code breathe. Add empty lines between logical blocks of code.

- Add a small, to the point, comment to explain *what* the block does and *why*. Use examples when possible. Propose ASCII drawings to explain complete systems.

- Treat member visibility changes as a breaking design shift. Keep all fields and functions private unless external access is strictly required by the design. Prompt the user for explicit approval before changing any access modifier from private to internal or public.

- Program to levels of abstraction. Lower-level mechanics (e.g., raw hardware I/O, sector parsing, direct socket streams) must be encapsulated in a dedicated driver/abstraction layer. Expose clean, high-level APIs to the rest of the application so calling code works with domain concepts, not raw implementation details.

- Don't touch blocks of code unrelated to the feature you implement. e.g. Don't add comments to a block of code if you did not create it or modify it. As much as possible try to minimize the number of changed lines when implementing a feature.

- Strictly adhere to the layered boundary hierarchy: each layer may only communicate with its immediate neighbor directly below it. Never "punch holes" through layers (e.g., controllers or UI components must never directly call database queries, raw hardware drivers, or low-level network clients; always route through the intermediate service/abstraction layer).

- Always use {}, even on a one-line "if" statement.

When you write a commit message, follow these 7 rules:
Rule 1: Separate the subject line from the body with a single blank line.
Rule 2: Limit the subject line to 50 characters (72 is the absolute hard limit).
Rule 3: Capitalize the first letter of the subject line.
Rule 4: Do not end the subject line with a period.
Rule 5: Use the imperative mood in the subject line (e.g., "Fix bug," "Add feature," 
        not "Fixed" or "Adds"). Test formula: It must complete the sentence: "If applied,
        this commit will [your subject line here]".
Rule 6: Wrap the body text manually at 72 characters to prevent Git formatting issues.
Rule 7: Use the body to explain what and why vs. how. Assume the code explains the how;
        the message must explain the context and reasoning. 

- If the prompt indicates that a bug is being fixed, don't write the fix right away. First write the test. Observe it failing. Then write the fix. And observe the test passing.        

While this "trick" has considerably improved the code generated, this is not a magic bullet that lets me avoid reading the code. LLMs constantly hallucinate and cannot be trusted. I still have to verify and iterate a lot but now I usually focus on architecture and design instead of code style.

How to deal with dilutions

There is an annoying phenomenon with LLMs called "context dilution" or "attention dilution" that was outlined in the Lost in the Middle paper. As the context grows, a model starts paying less attention to instructions in the middle of the context in favor of what is at the beginning and the end. The reasons why this happens are not well understood at the time I am typing this. I have found only two ways to minimize the impact.

  1. Keep the context short. This means starting a new session per feature.
  2. Explicitly ask the harness to reload agent.md. "Reload agent.md" is enough when I see code quality dropping.
Auto-update agent.md

You don't need to open an editor every time you want to add a new rule. What I do now is ask the agent to update agent.md.


*
联系我们 contact @ memedata.com