RHIDP-13413: Bootstrap basic AGENTS.md for RHDH AI workspaces by johnmcollier · Pull Request #3230 · redhat-developer/rhdh-plugins

johnmcollier · 2026-05-21T22:10:50Z

Hey, I just made a Pull Request!

Adds AGENTS.md to the following rhdh-ai maintained workspaces:

lightspeed
ai-integrations
mcp-integrations

✔️ Checklist

A changeset describing the change and affected packages. (more info)
Added or Updated documentation
Tests for new functionality and regression tests for bug fixes
Screenshots attached (for UI changes)

Assisted-by: Claude Sonnet 4.6 Signed-off-by: John Collier <jcollier@redhat.com>

rhdh-qodo-merge · 2026-05-21T22:11:06Z

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0)

1. MCP env var typo 🐞 Bug ≡ Correctness

Description

workspaces/mcp-integrations/AGENTS.md contains a malformed setup instruction that mentions
MCP_TOKENS, but the workspace documentation/config consistently uses MCP_TOKEN. Following the
new instruction will leave MCP_TOKEN unset and can break MCP auth in the dev environment.

Code

workspaces/mcp-integrations/AGENTS.md[27]

Evidence
The newly added AGENTS.md line includes MCP_TOKENS, but the workspace README and dev app-config
explicitly instruct/use MCP_TOKEN, showing MCP_TOKENS is incorrect here.
workspaces/mcp-integrations/AGENTS.md[27-27]
workspaces/mcp-integrations/README.md[5-12]
workspaces/mcp-integrations/app-config.yaml[40-45]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`workspaces/mcp-integrations/AGENTS.md` has an incorrect/malformed bullet:
- It includes an empty parenthetical `()`
- It mentions a non-existent env var name (`MCP_TOKENS`) alongside `MCP_TOKEN`

This contradicts the workspace’s existing setup docs and config, which use `MCP_TOKEN`.

## Issue Context
The workspace README and app-config both reference `MCP_TOKEN` (not `MCP_TOKENS`) for static token auth.

## Fix Focus Areas
- workspaces/mcp-integrations/AGENTS.md[27-27]

Suggested replacement text (example):
- `When running the workspace dev environment, set the MCP_TOKEN environment variable to an 8+ character value.`

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

sonarqubecloud · 2026-05-21T22:12:23Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

rhdh-qodo-merge · 2026-05-21T22:13:26Z

Review Summary by Qodo

Add AGENTS.md documentation for RHDH AI workspaces

📝 Documentation

Walkthroughs

Description

• Add AGENTS.md documentation to three RHDH AI workspaces
• Document build commands, conventions, and architecture for each workspace
• Create CLAUDE.md reference files pointing to AGENTS.md
• Establish AI model collaboration guidelines with Assisted-by footer requirement

Diagram

flowchart LR
  A["Three Workspaces<br/>lightspeed<br/>ai-integrations<br/>mcp-integrations"] -->|"Add AGENTS.md"| B["Workspace Documentation<br/>Build commands<br/>Conventions<br/>Architecture"]
  A -->|"Add CLAUDE.md"| C["Reference Files<br/>@AGENTS.md"]

File Changes

1. workspaces/ai-integrations/AGENTS.md 📝 Documentation +26/-0

AI Integrations workspace documentation

• Documents AI Integration Plugins workspace with build and test commands
• Describes Backstage plugin structure and backend module conventions
• Explains shared library architecture and PR requirements with Assisted-by footer

workspaces/ai-integrations/AGENTS.md

2. workspaces/ai-integrations/CLAUDE.md 📝 Documentation +1/-0

Reference to AI Integrations AGENTS.md
• Creates reference file pointing to AGENTS.md
workspaces/ai-integrations/CLAUDE.md

3. workspaces/lightspeed/AGENTS.md 📝 Documentation +28/-0

Lightspeed plugin workspace documentation

• Documents Lightspeed Plugin workspace with build, test, and E2E commands
• Describes PatternFly UI components and dual frontend variants (modern and legacy)
• Explains Knex database access and migration structure
• Specifies PR conventions requiring Assisted-by footer

workspaces/lightspeed/AGENTS.md

View more (3)

4. workspaces/lightspeed/CLAUDE.md 📝 Documentation +1/-0

Reference to Lightspeed AGENTS.md
• Creates reference file pointing to AGENTS.md
workspaces/lightspeed/CLAUDE.md

5. workspaces/mcp-integrations/AGENTS.md 📝 Documentation +33/-0

MCP Integrations workspace documentation

• Documents MCP Plugins workspace with build and test commands
• Describes MCP tool organization, authentication inheritance, and description guidelines
• Provides porting instructions from upstream Backstage repository
• Specifies environment variable requirements and PR conventions with upstream linking

workspaces/mcp-integrations/AGENTS.md

6. workspaces/mcp-integrations/CLAUDE.md 📝 Documentation +1/-0

Reference to MCP Integrations AGENTS.md
• Creates reference file pointing to AGENTS.md
workspaces/mcp-integrations/CLAUDE.md

codecov · 2026-05-21T22:15:03Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 53.09%. Comparing base (4866641) to head (1c38b2f).
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3230   +/-   ##
=======================================
  Coverage   53.09%   53.09%           
=======================================
  Files        2306     2306           
  Lines       88276    88276           
  Branches    24567    24583   +16     
=======================================
  Hits        46873    46873           
  Misses      41051    41051           
  Partials      352      352

Flag	Coverage Δ	*Carryforward flag
adoption-insights	`83.70% <ø> (ø)`	Carriedforward from 4866641
ai-integrations	`67.95% <ø> (ø)`
app-defaults	`69.79% <ø> (ø)`	Carriedforward from 4866641
augment	`46.39% <ø> (ø)`	Carriedforward from 4866641
boost	`74.96% <ø> (ø)`	Carriedforward from 4866641
bulk-import	`72.46% <ø> (ø)`	Carriedforward from 4866641
cost-management	`14.10% <ø> (ø)`	Carriedforward from 4866641
dcm	`61.79% <ø> (ø)`	Carriedforward from 4866641
extensions	`61.53% <ø> (ø)`	Carriedforward from 4866641
global-floating-action-button	`71.18% <ø> (ø)`	Carriedforward from 4866641
global-header	`59.71% <ø> (ø)`	Carriedforward from 4866641
homepage	`49.92% <ø> (ø)`	Carriedforward from 4866641
install-dynamic-plugins	`56.77% <ø> (ø)`	Carriedforward from 4866641
konflux	`91.49% <ø> (ø)`	Carriedforward from 4866641
lightspeed	`68.54% <ø> (ø)`
mcp-integrations	`85.46% <ø> (ø)`
orchestrator	`38.30% <ø> (ø)`	Carriedforward from 4866641
quickstart	`63.76% <ø> (ø)`	Carriedforward from 4866641
sandbox	`79.56% <ø> (ø)`	Carriedforward from 4866641
scorecard	`83.96% <ø> (ø)`	Carriedforward from 4866641
theme	`61.26% <ø> (ø)`	Carriedforward from 4866641
translations	`7.25% <ø> (ø)`	Carriedforward from 4866641
x2a	`57.25% <ø> (ø)`	Carriedforward from 4866641

*This pull request uses carry forward flags. Click here to find out more.

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4866641...1c38b2f. Read the comment docs.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Jdubrick

@johnmcollier what do you think about adding the required Node version to the files? I've had a few instances where the agent tries to run yarn commands and ends up on Node 18 and they fail and it "lists as a pre-existing issue"

gabemontero

just commented once but in theory could apply to all 3 agents.md

github-actions · 2026-06-09T18:49:20Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

github-actions · 2026-06-24T07:18:44Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

gabemontero · 2026-06-24T13:02:17Z

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

you still pursuing this PR @johnmcollier ?

there are a couple of review comments I haven't seen a response to yet ?

johnmcollier · 2026-06-24T14:16:31Z

Okay @gabemontero coming back to this.

I think it's still worthwhile to merge this, however I suspect rhdh-plugins will need its own strategy for agent readiness, given how it's organized as a monorepo. For now, let's just merge the AGENTS.md for each workspace we own.

Signed-off-by: John Collier <jcollier@redhat.com>

…addrhdhaiagentsmd

johnmcollier · 2026-06-25T21:39:31Z

@gabemontero Oops, PR finally updated, forgot to push yesterday.

sonarqubecloud · 2026-06-26T19:22:15Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

RHIDP-13413: Bootstrap basic AGENTS.md for RHDH AI workspaces

5e3161b

Assisted-by: Claude Sonnet 4.6 Signed-off-by: John Collier <jcollier@redhat.com>

johnmcollier requested review from a team, Lucifergene, gabemontero, karthikjeeyar, rohitkrai03, thepetk and yangcao77 as code owners May 21, 2026 22:10

github-actions Bot added workspace/ai-integrations workspace/lightspeed workspace/mcp-integrations labels May 21, 2026

rhdh-qodo-merge Bot added the documentation Improvements or additions to documentation label May 21, 2026

Jdubrick reviewed May 25, 2026

View reviewed changes

gabemontero reviewed May 26, 2026

View reviewed changes

Comment thread workspaces/ai-integrations/AGENTS.md

github-actions Bot added stale and removed stale labels Jun 9, 2026

github-actions Bot added stale and removed stale labels Jun 24, 2026

johnmcollier added 2 commits June 25, 2026 17:11

Address PR review

edfa1ad

Signed-off-by: John Collier <jcollier@redhat.com>

Merge branch 'main' of github.com:redhat-developer/rhdh-plugins into …

1c38b2f

…addrhdhaiagentsmd

johnmcollier force-pushed the addrhdhaiagentsmd branch from 61dd25f to 1c38b2f Compare June 25, 2026 21:13

gabemontero approved these changes Jun 26, 2026

View reviewed changes

johnmcollier merged commit b9f42ce into redhat-developer:main Jun 26, 2026
30 checks passed

Uh oh!

Conversation

johnmcollier commented May 21, 2026

Hey, I just made a Pull Request!

✔️ Checklist

Uh oh!

rhdh-qodo-merge Bot commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review by Qodo

Uh oh!

sonarqubecloud Bot commented May 21, 2026

Quality Gate passed

Uh oh!

rhdh-qodo-merge Bot commented May 21, 2026

Review Summary by Qodo

Walkthroughs

File Changes

Uh oh!

codecov Bot commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Jdubrick left a comment

Choose a reason for hiding this comment

Uh oh!

gabemontero left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions Bot commented Jun 9, 2026

Uh oh!

github-actions Bot commented Jun 24, 2026

Uh oh!

gabemontero commented Jun 24, 2026

Uh oh!

johnmcollier commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johnmcollier commented Jun 25, 2026

Uh oh!

Uh oh!

sonarqubecloud Bot commented Jun 26, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rhdh-qodo-merge Bot commented May 21, 2026 •

edited

Loading

codecov Bot commented May 21, 2026 •

edited

Loading

johnmcollier commented Jun 24, 2026 •

edited

Loading