Skip to content

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

Open
johnmcollier wants to merge 1 commit into
redhat-developer:mainfrom
johnmcollier:addrhdhaiagentsmd
Open

RHIDP-13413: Bootstrap basic AGENTS.md for RHDH AI workspaces#3230
johnmcollier wants to merge 1 commit into
redhat-developer:mainfrom
johnmcollier:addrhdhaiagentsmd

Conversation

@johnmcollier
Copy link
Copy Markdown
Member

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
Copy link
Copy Markdown

rhdh-qodo-merge Bot commented May 21, 2026

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0)

Grey Divider


Remediation recommended

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


Grey Divider

Qodo Logo

@sonarqubecloud
Copy link
Copy Markdown

@rhdh-qodo-merge
Copy link
Copy Markdown

Review Summary by Qodo

Add AGENTS.md documentation for RHDH AI workspaces

📝 Documentation

Grey Divider

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"]

Loading

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


Grey Divider

Qodo Logo

@rhdh-qodo-merge rhdh-qodo-merge Bot added the documentation Improvements or additions to documentation label May 21, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 60.90%. Comparing base (41e0cb2) to head (5e3161b).
⚠️ Report is 88 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3230      +/-   ##
==========================================
- Coverage   61.06%   60.90%   -0.17%     
==========================================
  Files        2071     2075       +4     
  Lines       64170    64246      +76     
  Branches    16644    16647       +3     
==========================================
- Hits        39187    39127      -60     
- Misses      24770    24905     +135     
- Partials      213      214       +1     
Flag Coverage Δ *Carryforward flag
adoption-insights 83.58% <ø> (ø) Carriedforward from 41e0cb2
ai-integrations 70.03% <ø> (ø)
app-defaults 69.60% <ø> (ø) Carriedforward from 41e0cb2
augment 69.36% <ø> (ø) Carriedforward from 41e0cb2
bulk-import 72.45% <ø> (ø) Carriedforward from 41e0cb2
cost-management 16.49% <ø> (ø) Carriedforward from 41e0cb2
dcm 32.85% <ø> (ø) Carriedforward from 41e0cb2
extensions 61.79% <ø> (ø) Carriedforward from 41e0cb2
global-floating-action-button 73.75% <ø> (ø) Carriedforward from 41e0cb2
global-header 61.68% <ø> (ø) Carriedforward from 41e0cb2
homepage 50.84% <ø> (ø) Carriedforward from 41e0cb2
konflux 91.01% <ø> (ø) Carriedforward from 41e0cb2
lightspeed 68.33% <ø> (-2.03%) ⬇️
mcp-integrations 81.59% <ø> (ø)
orchestrator 35.14% <ø> (ø) Carriedforward from 41e0cb2
quickstart 62.64% <ø> (ø) Carriedforward from 41e0cb2
sandbox 79.49% <ø> (ø) Carriedforward from 41e0cb2
scorecard 83.61% <ø> (ø) Carriedforward from 41e0cb2
theme 64.54% <ø> (ø) Carriedforward from 41e0cb2
translations 8.49% <ø> (ø) Carriedforward from 41e0cb2
x2a 82.47% <ø> (ø) Carriedforward from 41e0cb2

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


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 41e0cb2...5e3161b. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant