Skip to content

Commit b9f42ce

Browse files
authored
RHIDP-13413: Bootstrap basic AGENTS.md for RHDH AI workspaces (#3230)
* RHIDP-13413: Bootstrap basic AGENTS.md for RHDH AI workspaces Assisted-by: Claude Sonnet 4.6 Signed-off-by: John Collier <jcollier@redhat.com> * Address PR review Signed-off-by: John Collier <jcollier@redhat.com> --------- Signed-off-by: John Collier <jcollier@redhat.com>
1 parent c2e3749 commit b9f42ce

6 files changed

Lines changed: 92 additions & 0 deletions

File tree

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# AI Integration Plugins for RHDH
2+
3+
## Build & Test Commands
4+
5+
- Install: `yarn install`
6+
- Build: `yarn build:all`
7+
- Test all: `yarn test:all`
8+
- Test single file: `yarn test -- path/to/test.ts`
9+
- Lint: `yarn lint:all`
10+
- Lint single file: `yarn lint --fix path/to/file.ts`
11+
- Type check: `yarn tsc`
12+
- Dev environment: `yarn dev`
13+
- Debug: `yarn dev:debug`
14+
15+
## Key Conventions
16+
17+
- Follows standard Backstage plugin structure: frontend plugin, backend plugin, and common shared library
18+
- Backend module (e.g. `catalog-backend-module-model-catalog`) extend Backstage catalog plugin
19+
20+
## Architecture (only non-obvious parts)
21+
22+
- `packages/` in each plugin is strictly for the dev environment; do not add application code there
23+
- `ai-experience-common` holds shared types and API definitions used by both frontend and backend
24+
25+
## PR Conventions
26+
27+
- All commits must have an `Assisted-by: <model>` footer below the sign offs
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

workspaces/lightspeed/AGENTS.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Lightspeed Plugin for RHDH
2+
3+
## Build & Test Commands
4+
5+
- Install: `yarn install`
6+
- Build: `yarn build:all`
7+
- Test all: `yarn test:all`
8+
- Test single file: `yarn test -- path/to/test.ts`
9+
- E2E tests: `yarn test:e2e`
10+
- Lint: `yarn lint`
11+
- Lint single file: `yarn lint --fix path/to/file.ts`
12+
- Type check: `yarn tsc`
13+
- Dev (modern): `yarn start`
14+
15+
## Key Conventions
16+
17+
- UI uses PatternFly components for the chat interface, not MUI
18+
- The frontend has two variants: modern (new Backstage plugin API) and legacy (old API)
19+
20+
## Architecture (only non-obvious parts)
21+
22+
- `packages/app` uses the new Backstage frontend plugin API; `packages/app-legacy` uses the old API for backwards compatibility
23+
- Backend uses Knex for database access; migrations live in `plugins/lightspeed-backend/migrations/`
24+
- `packages/` is strictly for the dev environment; do not add application code there
25+
26+
## PR Conventions
27+
28+
- All commits must have an `Assisted-by: <model>` footer below the sign offs

workspaces/lightspeed/CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# MCP Plugins for RHDH
2+
3+
## Build & Test Commands
4+
5+
- Install: `yarn install`
6+
- Build: `yarn build:all`
7+
- Test all: `yarn test:all`
8+
- Test single file: `yarn test -- path/to/test.ts`
9+
- Lint: `yarn lint`
10+
- Lint single file: `yarn lint --fix path/to/file.ts`
11+
- Type check: `yarn tsc`
12+
- Dev environment (no frontend): `yarn start-backend`
13+
- Debug: `yarn dev:debug`
14+
15+
## Key Conventions
16+
17+
- MCP tools are stored in separate files (one tool per file)
18+
- MCP tools are organized based on the Backstage component/plugin they are associated with (e.g. src/scaffolder for scaffolder tools)
19+
- MCP actions should inherit the authentication/credentials passed into the tool by the MCP framework, rather than acquiring new credentials
20+
- MCP action descriptions should be kept short
21+
22+
## Porting from Upstream
23+
24+
- 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)
25+
26+
## Architecture (only non-obvious parts)
27+
28+
- When running the workspace dev environment (), the `MCP_TOKEN` environment variable `MCP_TOKENS` must be set to an 8+ character value
29+
- 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
30+
31+
## PR Conventions
32+
33+
- All commits must have an `Assisted-by: <model>` footer below the sign offs
34+
- When porting upstream MCP PRs, link to the original branch in the PR text
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

0 commit comments

Comments
 (0)