improve some file naming towards consistency
This commit is contained in:
Brian Madison
@@ -10,7 +10,7 @@ The Agent Orchestrator in V3 utilizes a build script to package various agent as
|
||||
|
||||
### Overview
|
||||
|
||||
The build process is managed by the `build-bmad-orchestrator.js` Node.js script. This script reads its configuration from `build-agent-cfg.js`, processes files from an asset directory, and outputs the bundled assets into a designated build directory.
|
||||
The build process is managed by the `build-bmad-orchestrator.js` Node.js script. This script reads its configuration from `build-web-agent.cfg.js`, processes files from an asset directory, and outputs the bundled assets into a designated build directory.
|
||||
|
||||
Quickstart: see [this below](#running-the-build-script)
|
||||
|
||||
@@ -18,9 +18,9 @@ Quickstart: see [this below](#running-the-build-script)
|
||||
|
||||
- **Node.js**: Ensure you have Node.js installed to run the build script. Python version coming soon...
|
||||
|
||||
### Configuration (`build-agent-cfg.js`)
|
||||
### Configuration (`build-web-agent.cfg.js`)
|
||||
|
||||
The build process is configured via `build-agent-cfg.js`. Key parameters include:
|
||||
The build process is configured via `build-web-agent.cfg.js`. Key parameters include:
|
||||
|
||||
- `orchestrator_agent_prompt`: Specifies the path to the main prompt file for the orchestrator agent, such as `bmad-agent/web-bmad-orchestrator-agent.md`. This file will be copied to `agent-prompt.txt` in the build directory.
|
||||
- Example: `./bmad-agent/web-bmad-orchestrator-agent.md`
|
||||
@@ -29,9 +29,9 @@ The build process is configured via `build-agent-cfg.js`. Key parameters include
|
||||
- `build_dir`: Specifies the directory where the bundled output files and the `agent-prompt.txt` will be created.
|
||||
- Example: `./bmad-agent/build/`
|
||||
- `agent_cfg`: Specifies the path to the md cfg file that defines the agents the Orchestrator can embody.
|
||||
- Example: `./bmad-agent/web-bmad-orchestrator-agent-cfg.md`
|
||||
- Example: `./bmad-agent/web-bmad-orchestrator-agent.cfg.md`
|
||||
|
||||
Paths in the configuration file (`build-agent-cfg.js`) are relative to the `BETA-V3` directory (where `build-agent-cfg.js` and the build script `build-bmad-orchestrator.js` are located).
|
||||
Paths in the configuration file (`build-web-agent.cfg.js`) are relative to the `BETA-V3` directory (where `build-web-agent.cfg.js` and the build script `build-bmad-orchestrator.js` are located).
|
||||
|
||||
### Asset Directory Structure
|
||||
|
||||
@@ -52,7 +52,7 @@ The script expects a specific structure within the `asset_root` directory:
|
||||
NOTE the build will skip any files with the `.ide.<extension>` - so you can have ide specific agents or files also that do not make sense for the web, such as `dev.ide.md` - or a specific ide `sm.ide.md`.
|
||||
|
||||
1. ```cmd
|
||||
node build-bmad-web-orchestrator.js
|
||||
node build-web-agent.js
|
||||
```
|
||||
|
||||
The script will log its progress, including discovered source directories, any issues found (like duplicate base filenames), and the output files being generated.
|
||||
@@ -73,9 +73,9 @@ These bundled files and the agent prompt are then ready to be used by the Agent
|
||||
|
||||
The text in agent-prompt.txt gets entered into the window of the main custom web agent instruction set. The other files in the build folder all need to be attached as files for the Gem or GPT.
|
||||
|
||||
### Orchestrator Agent Configuration (e.g., `BETA-V3/bmad-agent/web-bmad-orchestrator-agent-cfg.md`)
|
||||
### Orchestrator Agent Configuration (e.g., `BETA-V3/bmad-agent/web-bmad-orchestrator-agent.cfg.md`)
|
||||
|
||||
While `build-bmad-orchestrator.js` packages assets, the Orchestrator's core behavior, agent definitions, and personality are defined in a Markdown configuration file. An example is `bmad-agent/web-bmad-orchestrator-agent-cfg.md` (path relative to `BETA-V3/`, specified in `build-agent-cfg.js` via `agent_cfg`). This file is key to the Orchestrator's adaptability.
|
||||
While `build-bmad-orchestrator.js` packages assets, the Orchestrator's core behavior, agent definitions, and personality are defined in a Markdown configuration file. An example is `bmad-agent/web-bmad-orchestrator-agent.cfg.md` (path relative to `BETA-V3/`, specified in `build-web-agent.cfg.js` via `agent_cfg`). This file is key to the Orchestrator's adaptability.
|
||||
|
||||
**Key Features and Configurability:**
|
||||
|
||||
@@ -113,7 +113,7 @@ While `build-bmad-orchestrator.js` packages assets, the Orchestrator's core beha
|
||||
|
||||
**How it Works (Conceptual Flow from `orchestrator-agent.md`):**
|
||||
|
||||
1. The Orchestrator (initially BMad) loads and parses the Markdown agent configuration file (e.g., `web-bmad-orchestrator-agent-cfg.md`).
|
||||
1. The Orchestrator (initially BMad) loads and parses the Markdown agent configuration file (e.g., `web-bmad-orchestrator-agent.cfg.md`).
|
||||
2. When a user request matches an agent's `title`, `name`, `description`, or `classification_label`, the Orchestrator identifies the target agent.
|
||||
3. It then loads the agent's `persona` and any associated `templates`, `checklists`, `data_sources`, and `tasks` by:
|
||||
- Identifying the correct bundled `.txt` file (e.g., `personas.txt` for `personas#pm`).
|
||||
@@ -121,7 +121,7 @@ While `build-bmad-orchestrator.js` packages assets, the Orchestrator's core beha
|
||||
4. The `Customize` instructions from the Markdown configuration are applied, potentially modifying the agent's behavior.
|
||||
5. The Orchestrator then _becomes_ that agent, adopting its complete persona, knowledge, and operational parameters defined in the Markdown configuration and the loaded asset sections.
|
||||
|
||||
This system makes the Agent Orchestrator highly adaptable. You can easily define new agents, modify existing ones, tweak personalities with the `Customize` field (in the Markdown agent configuration file like `web-bmad-orchestrator-agent-cfg.md`), or change their knowledge base, main prompt, and asset paths (in `build-agent-cfg.js` and the corresponding asset files), then re-running the build script if asset content was changed.
|
||||
This system makes the Agent Orchestrator highly adaptable. You can easily define new agents, modify existing ones, tweak personalities with the `Customize` field (in the Markdown agent configuration file like `web-bmad-orchestrator-agent.cfg.md`), or change their knowledge base, main prompt, and asset paths (in `build-web-agent.cfg.js` and the corresponding asset files), then re-running the build script if asset content was changed.
|
||||
|
||||
## IDE Agent Setup and Usage
|
||||
|
||||
@@ -137,8 +137,8 @@ A powerful alternative is the `ide-bmad-orchestrator.md`. This agent provides th
|
||||
|
||||
#### How the IDE Orchestrator Works
|
||||
|
||||
1. **Configuration (`ide-bmad-orchestrator-cfg.md`):**
|
||||
The orchestrator's behavior is primarily driven by a Markdown configuration file (e.g., `BETA-V3/bmad-agent/ide-bmad-orchestrator-cfg.md`, the path to which is specified within the `ide-bmad-orchestrator.md` itself). This config file has two main parts:
|
||||
1. **Configuration (`ide-bmad-orchestrator.cfg.md`):**
|
||||
The orchestrator's behavior is primarily driven by a Markdown configuration file (e.g., `BETA-V3/bmad-agent/ide-bmad-orchestrator.cfg.md`, the path to which is specified within the `ide-bmad-orchestrator.md` itself). This config file has two main parts:
|
||||
|
||||
- **Data Resolution:**
|
||||
Located at the top of the config file, this section defines key-value pairs for base paths. These paths tell the orchestrator where to find different types of asset files (personas, tasks, checklists, templates, data).
|
||||
@@ -186,7 +186,7 @@ A powerful alternative is the `ide-bmad-orchestrator.md`. This agent provides th
|
||||
```
|
||||
|
||||
2. **Operational Workflow (inside `ide-bmad-orchestrator.md`):**
|
||||
- **Initialization:** Upon activation in your IDE, the `ide-bmad-orchestrator.md` first loads and parses its specified configuration file (`ide-bmad-orchestrator-cfg.md`). If this fails, it will inform you and halt.
|
||||
- **Initialization:** Upon activation in your IDE, the `ide-bmad-orchestrator.md` first loads and parses its specified configuration file (`ide-bmad-orchestrator.cfg.md`). If this fails, it will inform you and halt.
|
||||
- **Greeting & Persona Listing:** It will greet you. If your initial instruction isn't clear or if you ask, it will list the available specialist personas (by `Title`, `Name`, and `Description`) and the `Tasks` each can perform, all derived from the loaded configuration.
|
||||
- **Persona Activation:** When you request a specific persona (e.g., "Become the Analyst" or "I need Larry to help with research"), the orchestrator:
|
||||
- Finds the persona in its configuration.
|
||||
@@ -201,8 +201,8 @@ A powerful alternative is the `ide-bmad-orchestrator.md`. This agent provides th
|
||||
|
||||
#### Usage Instructions for IDE Orchestrator
|
||||
|
||||
1. **Set up your configuration (`ide-bmad-orchestrator-cfg.md`):**
|
||||
- Ensure you have an `ide-bmad-orchestrator-cfg.md` file. You can use the one located in `BETA-V3/bmad-agent/` as a template or starting point.
|
||||
1. **Set up your configuration (`ide-bmad-orchestrator.cfg.md`):**
|
||||
- Ensure you have an `ide-bmad-orchestrator.cfg.md` file. You can use the one located in `BETA-V3/bmad-agent/` as a template or starting point.
|
||||
- Verify that the `Data Resolution` paths at the top correctly point to your asset folders (personas, tasks, templates, checklists, data) relative to your project structure.
|
||||
- Define your desired agents with their `Title`, `Name`, `Customize` instructions, `Persona` file, and `Tasks`. Ensure the referenced persona and task files exist in the locations specified by your `Data Resolution` paths.
|
||||
2. **Set up your persona and task files:**
|
||||
@@ -222,7 +222,7 @@ A powerful alternative is the `ide-bmad-orchestrator.md`. This agent provides th
|
||||
- **Switching Personas:**
|
||||
- If you need to switch: "I need to talk to the Architect now."
|
||||
- The orchestrator will advise a new chat. If you want to switch in the current chat, you'll need to give an explicit override command when prompted (e.g., "Override safety protocol and switch to Architect").
|
||||
- **Follow Persona Instructions:** Once a persona is active, it will guide you based on its definition and the task it's performing. Remember that resource files like templates or checklists referenced by a task will be resolved using the global `Data Resolution` paths in the `ide-bmad-orchestrator-cfg.md`.
|
||||
- **Follow Persona Instructions:** Once a persona is active, it will guide you based on its definition and the task it's performing. Remember that resource files like templates or checklists referenced by a task will be resolved using the global `Data Resolution` paths in the `ide-bmad-orchestrator.cfg.md`.
|
||||
|
||||
This setup allows for a highly flexible and dynamically configured multi-persona agent directly within your IDE, streamlining various development and project management workflows.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user