Add AGENTS.md and Cursor project rules#52
Add AGENTS.md and Cursor project rules#52bburt-rh wants to merge 2 commits intoredhat-documentation:mainfrom
Conversation
Made-with: Cursor
📝 WalkthroughWalkthroughAdds Cursor rule documents and a new AGENTS.md describing repository conventions for agent plugins (plugin layout, skill naming, script invocation, metadata sync, build targets). Updates CLAUDE.md to reference AGENTS.md and restrict its scope to Cursor-specific guidance. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
⚔️ Resolve merge conflicts
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.cursor/rules/project.mdc:
- Line 21: The generated-files exclusion list is missing the root plugins.md
entry; update the list in the project generated-file rules (the block that
currently mentions docs/plugins.md, docs/plugins/, and docs/install/) to also
include plugins.md so the root plugins.md is ignored by the generated-file
policy.
In @.cursor/rules/skill-naming-and-scripts.mdc:
- Line 10: The rule "Always use fully qualified `plugin:skill` names" is too
broad and rewrites intentional short-form Skill IDs in auto-generated
index/reference displays; update the rule text and matching logic to apply only
to invocation/reference contexts (invocations, frontmatter, inline calls, and
cross-references) and exclude index/table display IDs (e.g.,
docs/cursor-skills-index.md style index entries). Specifically, narrow the rule
scope to check contexts for invocation syntax and frontmatter keys and skip or
whitelist rows/columns used as display IDs in generated index tables so
short-form Skill IDs remain unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: ea0d70fb-7111-4d7c-ba2a-a742e2999891
📒 Files selected for processing (4)
.cursor/rules/project.mdc.cursor/rules/skill-naming-and-scripts.mdcAGENTS.mdCLAUDE.md
| README.md # Plugin documentation | ||
| ``` | ||
|
|
||
| ## Docs site development commands |
There was a problem hiding this comment.
Can we move all generic repo details into AGENTS.md, and keep CLAUDE.md specific only to Claude details?
AFAIK, Claude will read AGENTS.md, and the CLAUDE.md
There was a problem hiding this comment.
Agreed — moved all shared conventions (repo structure, naming, contributing rules, script patterns) into AGENTS.md as the single source of truth. CLAUDE.md now just references AGENTS.md and documents the one Claude Code-specific detail (${CLAUDE_PLUGIN_ROOT} for cross-skill calls).
Note: Claude Code reads CLAUDE.md but AFAIK does not automatically read AGENTS.md, so CLAUDE.md now opens with an explicit directive to follow AGENTS.md for shared conventions. That way both tools get the full picture from their respective entry points.
aireilly
left a comment
aireilly
left a comment
There was a problem hiding this comment.
/lgtm, pending one comment and whatever coderabbit says that makes sense.
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CLAUDE.md (1)
15-15: Consider clarifying the scope of this Cursor note.While this cross-reference helps readers understand the difference between Claude Code and Cursor approaches, placing Cursor-specific guidance in a Claude Code-scoped document (line 3 states "apply only to Claude Code") might be slightly confusing.
Consider either:
- Rewording for clarity: "Note: If you're using Cursor instead, see AGENTS.md for workspace-relative path guidance."
- Moving this note to AGENTS.md where it would be more contextually appropriate
✍️ Proposed rewording for clarity
-Cursor users should use workspace-relative paths instead. See [AGENTS.md](AGENTS.md) for details. +**Note for Cursor users:** If you're using Cursor instead of Claude Code, see [AGENTS.md](AGENTS.md) for workspace-relative path guidance.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CLAUDE.md` at line 15, The note "Cursor users should use workspace-relative paths instead." appears inside a Claude Code–scoped doc and may confuse readers; update the sentence to clarify scope by either rewording it to "Note: If you're using Cursor instead, see AGENTS.md for workspace-relative path guidance." or moving that sentence out of the Claude Code section into AGENTS.md; look for the paragraph containing "apply only to Claude Code" and the Cursor note and apply the chosen change.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@CLAUDE.md`:
- Line 15: The note "Cursor users should use workspace-relative paths instead."
appears inside a Claude Code–scoped doc and may confuse readers; update the
sentence to clarify scope by either rewording it to "Note: If you're using
Cursor instead, see AGENTS.md for workspace-relative path guidance." or moving
that sentence out of the Claude Code section into AGENTS.md; look for the
paragraph containing "apply only to Claude Code" and the Cursor note and apply
the chosen change.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: b80d615d-e5bb-4bdb-9ac5-82d387fdc0cb
📒 Files selected for processing (3)
.cursor/rules/skill-naming-and-scripts.mdcAGENTS.mdCLAUDE.md
✅ Files skipped from review due to trivial changes (2)
- .cursor/rules/skill-naming-and-scripts.mdc
- AGENTS.md
2 participants
Adds Cursor-oriented project instructions and rules for this repository.
Summary by CodeRabbit