Skip to content

Add Multiple Agents Info #51

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.

Sign up for GitHub

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
pinkeshmars wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add Multiple Agents Info #51

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddfe445
Add Multiple Agents Info
pinkeshmars Dec 12, 2025
f645629
Addres review comments
pinkeshmars Dec 15, 2025
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
40 changes: 33 additions & 7 deletions docs/workspace/agent-panel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ Add a login screen.

#### Supported Rule Files

Dreamflow looks for one of the following files in your project root:
Copy link

@glgh glgh Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we:

  1. recommend using AGENTS.md
  2. say common rule file formats like CLAUDE.md, .cursorrules, ARCHITECTURE.md are compatible and supported
  3. remove the priority order table (internal implementation detail, and subject to change)

Dreamflow scans for the following rule files in your project, in this priority order:

| Priority | Filename | Typical Purpose |
| --- | --- | --- |
Expand All @@ -249,9 +249,7 @@ Dreamflow looks for one of the following files in your project root:
| 4️⃣ | [**ARCHITECTURE.md**](https://architecture.md/) | Documents your project’s structure, data flow, and design philosophy for better context. |

:::info

Only the **first file found** in this order is loaded. If multiple exist, Dreamflow stops scanning after the first match. For example, if .cursorrules exists, it will be used even if `AGENTS.md` is also present.

Dreamflow loads only the first matching file based on priority. For example, if `.cursorrules` exists, Dreamflow will ignore `CLAUDE.md`, `AGENTS.md`, and `ARCHITECTURE.md`.
:::

When any of the supported rule files is loaded into the Agent’s context:
Expand Down Expand Up @@ -310,18 +308,46 @@ features/[feature]/presentation/
- Sanitize UI error messages.
```

**Step 2: Place File in Project Root**
**Step 2: Place File in Your Project**

You can add project rules at **two levels**:

Upload the rule file at the **same level as `pubspec.yaml`**. Dreamflow **does not** scan subfolders. It should look like this:
**1. Root-level Rule File:** Place a global rule file (e.g., `AGENTS.md`, `.cursorrules`, `CLAUDE.md`, or `ARCHITECTURE.md`) in the **project root**, beside `pubspec.yaml`.

Copy link

@glgh glgh Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here and elsewhere - please only mention AGENTS.md

- This file has **global scope**.
- It is **always loaded** before every Agent action, no matter which part of the project you're working in.
- Use it only for your **most important, universal rules**, such as:
- Architecture pattern (BLoC, Riverpod, MVVM…)
- Folder structure
- Naming conventions
- Coding style
- Security guidelines

![project-rule-file.avif](imgs/project-rule-file.avif)

**2. Nested Rule File (Feature-Specific Rules)**: You may also create **`AGENTS.md` files inside subfolders**, such as:

```
/features/auth/AGENTS.md
/features/chat/AGENTS.md
/lib/widgets/common/AGENTS.md
```

Dreamflow will load these **only when the Agent is generating or editing code inside that folder**. Use nested rule files for:

- Feature-specific architecture
- Module boundaries
- API constraints
- UI or widget conventions
- Domain-level rules

**Step 3: Run Agent Action**

You can view or edit your rule file anytime from the Dreamflow File Editor. Once it’s saved, run any Agent command (for example, “Add a login screen”). Dreamflow will automatically load your rules and apply them to every generation.

#### Best Practices

- Keep the root-level `AGENTS.md` small and focused.
- Use nested `AGENTS.md` files for detailed, module-specific rules to avoid bloating the Agent’s context.
- Keep the rule file specific, short, and imperative.
- Keep must-follow standards at the top of the file.
- Avoid overly long explanations — keep it concise and readable.
Expand Down