-
Notifications
You must be signed in to change notification settings - Fork 40
LLMs: Scaffold AGENTS.md for LLM coding agents #2398
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
Hello! 👋 This repository uses Auto for releasing packages using PR labels. ✨ This PR can be merged but will not trigger a new release. To trigger a new release add the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Consolidates LLM/coding-agent guidance for scaffolded Grafana plugins by removing panel-specific AGENTS content and introducing a shared, common AGENTS.md + instructions file under the common template.
Changes:
- Removed panel template’s
AGENTS.mdand related agent instruction/task markdown files. - Added a common
AGENTS.mdentrypoint and a shared.config/AGENTS/instructions.mdwith documentation-fetching guidance and critical rules.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/create-plugin/templates/panel/AGENTS.md | Removed panel-specific agent scaffold entrypoint so common template can supply it. |
| packages/create-plugin/templates/panel/.config/AGENTS/instructions.md | Removed panel-specific agent fundamentals guidance. |
| packages/create-plugin/templates/panel/.config/AGENTS/tasks/add-panel-options.md | Removed panel-specific “add panel options” task doc. |
| packages/create-plugin/templates/common/AGENTS.md | Added shared agent scaffold entrypoint for all plugin templates. |
| packages/create-plugin/templates/common/.config/AGENTS/instructions.md | Added shared agent instructions, doc index links, and “critical rules”. |
| @@ -0,0 +1,2 @@ | |||
| ## Project knowledge | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why are we repeating this instead of using @AGENTS.md ?
because users tend to like their tools as they work. Claude likes claude.md and it'll try to modify (via its memory functions) and users might decide to remove AGENTS.md "because CLAUDE.md already exists" or similar with other agents that don't use either CLAUDE.md or GEMINI.md
so even though this is duplicated we are create a more future-proof approach for users with diverse coding tools and file preference.
Users are free to delete the agents files they don't need, but if we only have the real content in AGENTS.md and that's the one the user deletes we lose the any way to discover our instructions.md
What this PR does / why we need it:
This is a proof of concept alternative to #2322
The main differences are:
Tests
methodology
I did separate tests with coding agents and several coding models, with a brand new scaffolded data source (no changes only boilerplate) I asked the agent:
can you add variable query variable support to this datasource?cursor agent, with codex, claude code
cursor-agent doesn't have an integrated web_fetch tool, it follows instructions to use curl and fetches the documentation before trying to implement a solution. sometimes it hallucinates a documentation url but when it finds a 404 it fetches the index and then the real doc, this doesn't happen all the time
claude code with sonnet, haiku and opus
follows instructions and fetch documentation before trying to implement. sometimes it fetches the index first, sometimes just guesses the URL correctly.
Opencode with GLM 4.7
follows instructions, it hallucinated many documentation urls before deciding to fetch the index and get the real documentation url
Gemini-cli with gemini 2.5
ignored AGENTS.md and had to create a GEMINI.md instead. once created it followed instructions, first fetching the index then the correct documentation.