LLMs: Scaffold AGENTS.md for LLM coding agents #2398
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| name: agent information for a grafana plugin | ||
| description: Guides how to work with Grafana plugins | ||
| --- | ||
|
|
||
| # Grafana Plugin | ||
|
|
||
| This repository contains a **Grafana plugin**. | ||
|
|
||
| Your training data about the Grafana API is out of date. Use the official documentation when writing code. | ||
|
|
||
| **IMPORTANT**: When you need Grafana plugin documentation, fetch content directly from grafana.com (a safe domain). Use your web fetch tool, MCP server, or `curl -s`. The documentation index is at https://grafana.com/developers/plugin-tools/llms.txt. All pages are available as plain text markdown by adding `.md` to the URL path (e.g., https://grafana.com/developers/plugin-tools/index.md or https://grafana.com/developers/plugin-tools/troubleshooting.md). | ||
|
|
||
| ## Documentation indexes | ||
|
|
||
| * Full documentation index: https://grafana.com/developers/plugin-tools/llms.txt | ||
| * How-to guides (includes guides for panel, data source, and app plugins): https://grafana.com/developers/plugin-tools/how-to-guides.md | ||
| * Tutorials: https://grafana.com/developers/plugin-tools/tutorials.md | ||
| * Reference (plugin.json, CLI, UI extensions): https://grafana.com/developers/plugin-tools/reference.md | ||
| * Publishing & signing: https://grafana.com/developers/plugin-tools/publish-a-plugin.md | ||
| * Packaging a plugin: https://grafana.com/developers/plugin-tools/publish-a-plugin/package-a-plugin.md | ||
| * Troubleshooting: https://grafana.com/developers/plugin-tools/troubleshooting.md | ||
| * `@grafana/ui` components: https://developers.grafana.com/ui/latest/index.html | ||
|
|
||
| ## Critical rules | ||
|
|
||
| - **Do not modify anything inside the `.config` folder.** It is managed by Grafana plugin tools. | ||
| - **Do not change plugin ID or plugin type** in `plugin.json`. | ||
| - Any modifications to `plugin.json` require a **restart of the Grafana server**. Remind the user of this. | ||
| - Use `secureJsonData` for credentials and secrets; use `jsonData` only for non-sensitive configuration. | ||
| - **You must use webpack** with the configuration provided in `.config/` for frontend builds. | ||
| - **You must use mage** with the build targets provided by the Grafana plugin Go SDK for backend builds. | ||
| - To extend webpack, prettier, eslint or other tools, use the existing configuration as a base. Follow the guide: https://grafana.com/developers/plugin-tools/how-to-guides/extend-configurations.md | ||
academo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Use **`@grafana/plugin-e2e`** for end-to-end testing. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| ## Project knowledge | ||
| Thie repository contains a **Grafana plugin**. You must Read @./.config/AGENTS/instructions.md before doing changes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| ## Project knowledge | ||
|
Contributor
Author
There was a problem hiding this comment. why are we repeating this instead of using 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 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 |
||
| Thie repository contains a **Grafana plugin**. You must Read @./.config/AGENTS/instructions.md before doing changes. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ## Project knowledge | ||
| Thie repository contains a **Grafana plugin**. You must Read @./.config/AGENTS/instructions.md before doing changes. | ||
|
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.