-
Notifications
You must be signed in to change notification settings - Fork 106
RHIDP-13413: Bootstrap basic AGENTS.md for RHDH AI workspaces #3230
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
johnmcollier
wants to merge
1
commit into
redhat-developer:main
Choose a base branch
from
johnmcollier:addrhdhaiagentsmd
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+90
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,26 @@ | ||
| # AI Integration Plugins for RHDH | ||
|
|
||
| ## Build & Test Commands | ||
|
|
||
| - Install: `yarn install` | ||
| - Build: `yarn build:all` | ||
| - Test all: `yarn test:all` | ||
| - Test single file: `yarn test -- path/to/test.ts` | ||
| - Lint: `yarn lint:all` | ||
| - Lint single file: `yarn lint --fix path/to/file.ts` | ||
| - Type check: `yarn tsc` | ||
| - Dev environment: `yarn dev` | ||
|
|
||
| ## Key Conventions | ||
|
|
||
| - Follows standard Backstage plugin structure: frontend plugin, backend plugin, and common shared library | ||
| - Backend module (e.g. `catalog-backend-module-model-catalog`) extend Backstage catalog plugin | ||
|
|
||
| ## Architecture (only non-obvious parts) | ||
|
|
||
| - `packages/` in each plugin is strictly for the dev environment; do not add application code there | ||
| - `ai-experience-common` holds shared types and API definitions used by both frontend and backend | ||
|
|
||
| ## PR Conventions | ||
|
|
||
| - All commits must have an `Assisted-by: <model>` footer below the sign offs | ||
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 @@ | ||
| @AGENTS.md |
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,28 @@ | ||
| # Lightspeed Plugin for RHDH | ||
|
|
||
| ## Build & Test Commands | ||
|
|
||
| - Install: `yarn install` | ||
| - Build: `yarn build:all` | ||
| - Test all: `yarn test:all` | ||
| - Test single file: `yarn test -- path/to/test.ts` | ||
| - E2E tests: `yarn test:e2e` | ||
| - Lint: `yarn lint` | ||
| - Lint single file: `yarn lint --fix path/to/file.ts` | ||
| - Type check: `yarn tsc` | ||
| - Dev (modern): `yarn start` | ||
|
|
||
| ## Key Conventions | ||
|
|
||
| - UI uses PatternFly components for the chat interface, not MUI | ||
| - The frontend has two variants: modern (new Backstage plugin API) and legacy (old API) | ||
|
|
||
| ## Architecture (only non-obvious parts) | ||
|
|
||
| - `packages/app` uses the new Backstage frontend plugin API; `packages/app-legacy` uses the old API for backwards compatibility | ||
| - Backend uses Knex for database access; migrations live in `plugins/lightspeed-backend/migrations/` | ||
| - `packages/` is strictly for the dev environment; do not add application code there | ||
|
|
||
| ## PR Conventions | ||
|
|
||
| - All commits must have an `Assisted-by: <model>` footer below the sign offs |
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 @@ | ||
| @AGENTS.md |
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,33 @@ | ||
| # MCP Plugins for RHDH | ||
|
|
||
| ## Build & Test Commands | ||
|
|
||
| - Install: `yarn install` | ||
| - Build: `yarn build:all` | ||
| - Test all: `yarn test:all` | ||
| - Test single file: `yarn test -- path/to/test.ts` | ||
| - Lint: `yarn lint` | ||
| - Lint single file: `yarn lint --fix path/to/file.ts` | ||
| - Type check: `yarn tsc` | ||
| - Dev environment (no frontend): `yarn start-backend` | ||
|
|
||
| ## Key Conventions | ||
|
|
||
| - MCP tools are stored in separate files (one tool per file) | ||
| - MCP tools are organized based on the Backstage component/plugin they are associated with (e.g. src/scaffolder for scaffolder tools) | ||
| - MCP actions should inherit the authentication/credentials passed into the tool by the MCP framework, rather than acquiring new credentials | ||
| - MCP action descriptions should be kept short | ||
|
|
||
| ## Porting from Upstream | ||
|
|
||
| - Use https://github.com/redhat-ai-dev/rhdh-ai-skills/blob/main/skills/port-mcp-tool/SKILL.md when porting changes from upstream (github.com/backstage) to downstream (here) | ||
|
|
||
| ## Architecture (only non-obvious parts) | ||
|
|
||
| - When running the workspace dev environment (), the `MCP_TOKEN` environment variable `MCP_TOKENS` must be set to an 8+ character value | ||
| - packages/ is strictly a frontend for dev environment and autogenerated. Do not put changes under there unless it is to add new plugins to the dev environment | ||
|
|
||
| ## PR Conventions | ||
|
|
||
| - All commits must have an `Assisted-by: <model>` footer below the sign offs | ||
| - When porting upstream MCP PRs, link to the original branch in the PR text |
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 @@ | ||
| @AGENTS.md |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we also mention
yarn dev:debugoryarn inspector or the use of node and the backstage-cli for running in the debugger?