gravitee-api-management
AGENTS.md469 starsChanged 5 months agoApache-2.0View on GitHub
Root conventions also apply: read ../AGENTS.md; where they disagree, the closest file wins for its directory and below. If your tool cannot read it, restart it from the repository root. This directory is the source of the repository's AI context:
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository31 other files it gives its agents.
- AGENTS.mdAGENTS.md
- gravitee-apim-common/AGENTS.mdAGENTS.md
- gravitee-apim-console-webui/AGENTS.mdAGENTS.md
- gravitee-apim-definition/AGENTS.mdAGENTS.md
- gravitee-apim-distribution/AGENTS.mdAGENTS.md
- gravitee-apim-gateway/AGENTS.mdAGENTS.md
- gravitee-apim-plugin/AGENTS.mdAGENTS.md
- gravitee-apim-portal-webui/AGENTS.mdAGENTS.md
- gravitee-apim-portal-webui-next/AGENTS.mdAGENTS.md
- gravitee-apim-reporter/AGENTS.mdAGENTS.md
- gravitee-apim-repository/AGENTS.mdAGENTS.md
- gravitee-apim-rest-api/AGENTS.mdAGENTS.md
- .ai/CLAUDE.mdCLAUDE.md
- CLAUDE.mdCLAUDE.md
- gravitee-apim-common/CLAUDE.mdCLAUDE.md
- gravitee-apim-console-webui/CLAUDE.mdCLAUDE.md
- gravitee-apim-definition/CLAUDE.mdCLAUDE.md
- gravitee-apim-distribution/CLAUDE.mdCLAUDE.md
- gravitee-apim-gateway/CLAUDE.mdCLAUDE.md
- gravitee-apim-plugin/CLAUDE.mdCLAUDE.md
- gravitee-apim-portal-webui/CLAUDE.mdCLAUDE.md
- gravitee-apim-portal-webui-next/CLAUDE.mdCLAUDE.md
- gravitee-apim-reporter/CLAUDE.mdCLAUDE.md
- gravitee-apim-repository/CLAUDE.mdCLAUDE.md
- gravitee-apim-rest-api/CLAUDE.mdCLAUDE.md
- .cursor/rules/graphene.mdCursor rule
- .cursor/rules/graphene-snippets/context-sidebar-detail-page.tsxCursor rule
- .cursor/rules/graphene-snippets/creation-wizard-page.tsxCursor rule
- .cursor/rules/graphene-snippets/data-table-list-page.tsxCursor rule
- .cursor/rules/graphene-snippets/json-schema-form-simple.tsxCursor rule
- .cursor/rules/graphene-snippets/json-schema-form-with-meta.tsxCursor rule
The file
We split this AGENTS.md into the rules it gives an agent
1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 21
Only add rules that earn their token cost — not things easily inferred from context (scripts in package.json, standard framework behaviour, …
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
<!--
Generated by gravitee-ai. Do not edit directly.
Edit the source rules and re-run: gbuddy setup
Source rules:
- .ai/rules/ai-context-authoring.md
-->Root conventions also apply: read ../AGENTS.md; where they disagree, the closest file wins for its directory and below. If your tool cannot read it, restart it from the repository root.
AI Context Authoring
This directory is the source of the repository's AI context:
manifest.yaml— the repository's identity for assembly (productandmodules). Declaring a new module takes three steps together: add its path undermodules:, add itsCLAUDE.mdnegation to.gitignore(or the new shim silently never enters git), and rungbuddy setup, committing the generated files. Every directory where product code is written is declared; deliberately not modules: dependency-management poms (gravitee-apim-bom,gravitee-apim-parent), thegravitee-gammareactor root (its children are declared),gamma-ui-shared(no build file), and repository tooling (.circleci,release).rules/— repo-specific always-on rules, assembled into the generatedAGENTS.mdfiles together with the shared organisation-wide layers. A rule withdirs:in its frontmatter lands in those directories' files instead of root.guides/— depth loaded on demand; rules point at guides with one-line breadcrumbs.generated.yaml— the record of generated files;AGENTS.md,CLAUDE.md, and.github/instructions/**are generated from the sources above. Never edit generated files by hand — edit a rule, rungbuddy setup, and commit the result;gbuddy checkverifies no generated file was hand-edited since the last regeneration. Ifgenerated.yamlconflicts on a rebase or merge, do not resolve it by hand: once the source rules are resolved, delete.ai/generated.yaml, rungbuddy setup, add the regenerated files, and continue the rebase or merge.gbuddyis a Gravitee-internal tool: if you cannot run it, edit only the source rule under.ai/rules/, say so in your PR, and leave the generated files untouched for a maintainer to regenerate.
What earns a rule
- Only add rules that earn their token cost — not things easily inferred from context (scripts in
package.json, standard framework behaviour, language syntax). - The best rules come from observed agent mistakes; if an agent hasn't failed at it here, it probably doesn't need writing down.
- Place content at the right level, and ask of every always-on line: would a competent agent do this anyway (cut it); does it apply to every task or only some (move it beside the moment it applies — a guide or a
dirs:-scoped rule); is it a constraint or a procedure (procedures load on demand); can an agent check it while writing, or only believe it (reframe until it is binary or checkable)?
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

