Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions workspaces/ai-integrations/AGENTS.md
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
1 change: 1 addition & 0 deletions workspaces/ai-integrations/CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
28 changes: 28 additions & 0 deletions workspaces/lightspeed/AGENTS.md
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
1 change: 1 addition & 0 deletions workspaces/lightspeed/CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
33 changes: 33 additions & 0 deletions workspaces/mcp-integrations/AGENTS.md
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
1 change: 1 addition & 0 deletions workspaces/mcp-integrations/CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
Loading