Skip to content

Commit 169f87c

Browse files
jeremyederclaude
andauthored
chore: disable prd-rfe-workflow from OOTB listing (#87)
* chore: disable prd-rfe-workflow from OOTB listing Set `"enabled": false` so this workflow is excluded from the platform UI workflow picker. Requires ambient-code/platform#1054. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: document enabled, greeting, and rubric fields in schema Adds documentation for optional ambient.json fields that were in use but not documented in AMBIENT_JSON_SCHEMA.md. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 4a058d0 commit 169f87c

2 files changed

Lines changed: 80 additions & 3 deletions

File tree

AMBIENT_JSON_SCHEMA.md

Lines changed: 79 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,15 @@ interface AmbientConfig {
1515
description: string; // Required
1616
systemPrompt: string; // Required
1717
startupPrompt: string; // Required
18+
enabled?: boolean; // Optional (default: true)
19+
greeting?: string; // Optional
1820
results?: { // Optional
1921
[artifactName: string]: string; // Glob pattern for artifact location
2022
};
23+
rubric?: { // Optional
24+
activationPrompt: string;
25+
schema: object;
26+
};
2127
}
2228
```
2329

@@ -163,6 +169,73 @@ All artifacts go in `artifacts/specsmith/`:
163169

164170
---
165171

172+
### `enabled` (boolean, optional)
173+
174+
**Purpose**: Controls whether the workflow appears in the platform UI and API
175+
176+
**Default**: `true`
177+
178+
**Guidelines**:
179+
180+
- Set to `false` to hide a workflow from the OOTB workflow listing
181+
- Workflows with `enabled: false` are completely excluded from the API response
182+
- Omitting the field is equivalent to `enabled: true`
183+
- Useful for hiding work-in-progress or deprecated workflows without removing them
184+
185+
**Examples**:
186+
187+
```json
188+
"enabled": false
189+
"enabled": true
190+
```
191+
192+
---
193+
194+
### `greeting` (string, optional)
195+
196+
**Purpose**: User-facing welcome message displayed immediately when the workflow is selected, rendered with a typewriter effect
197+
198+
**Guidelines**:
199+
200+
- Displayed instantly without LLM generation
201+
- Use markdown formatting (lists, bold, etc.)
202+
- List available slash commands
203+
- Keep concise — this is the first thing users see
204+
205+
**Example**:
206+
207+
```json
208+
"greeting": "Welcome to PRD & RFE Creation!\n\nAvailable commands:\n• /prd.discover — Start product discovery\n• /prd.create — Draft the PRD\n\nType /prd.discover to get started."
209+
```
210+
211+
---
212+
213+
### `rubric` (object, optional)
214+
215+
**Purpose**: Defines evaluation criteria for scoring workflow output quality
216+
217+
**Structure**:
218+
219+
- `activationPrompt` (string): Instructions for when and how to evaluate
220+
- `schema` (object): JSON Schema describing the scoring fields
221+
222+
**Example**:
223+
224+
```json
225+
"rubric": {
226+
"activationPrompt": "After creating the output, evaluate quality and produce a score out of 25.",
227+
"schema": {
228+
"type": "object",
229+
"properties": {
230+
"completeness": {"type": "number", "description": "Score (1-5)"},
231+
"clarity": {"type": "number", "description": "Score (1-5)"}
232+
}
233+
}
234+
}
235+
```
236+
237+
---
238+
166239
### `results` (object, optional)
167240

168241
**Purpose**: Map artifact names to output file paths/patterns
@@ -256,7 +329,10 @@ def _load_ambient_config(self, cwd_path: str) -> dict:
256329

257330
**Optional Fields**:
258331

332+
- `enabled` can be omitted (defaults to `true`)
333+
- `greeting` can be omitted (falls back to LLM-generated greeting)
259334
- `results` can be omitted (defaults to empty object)
335+
- `rubric` can be omitted (no quality evaluation)
260336

261337
**No Strict Validation**:
262338

@@ -429,9 +505,9 @@ workflow-repo/
429505

430506
## Summary
431507

432-
The `ambient.json` schema is intentionally simple with only 5 fields, but the `systemPrompt` field is where workflows become powerful. A well-crafted systemPrompt can define complex multi-phase workflows with specialized agents, API integrations, and sophisticated output structures.
508+
The `ambient.json` schema has 4 required fields and 4 optional fields, but the `systemPrompt` field is where workflows become powerful. A well-crafted systemPrompt can define complex multi-phase workflows with specialized agents, API integrations, and sophisticated output structures.
433509

434-
**Minimum viable ambient.json**: 4 required string fields
435-
**Maximum sophistication**: Thousands of characters in systemPrompt defining complete development workflows
510+
**Minimum viable ambient.json**: 4 required string fields (`name`, `description`, `systemPrompt`, `startupPrompt`)
511+
**Maximum sophistication**: Thousands of characters in systemPrompt defining complete development workflows, with `greeting`, `results`, and `rubric` for richer UX
436512

437513
The platform is lenient - missing optional fields default gracefully, allowing both simple and complex workflow configurations.

workflows/prd-rfe-workflow/.ambient/ambient.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
2+
"enabled": false,
23
"name": "Create PRDs and RFEs",
34
"description": "Create comprehensive Product Requirements Documents (PRDs) and break them down into Request for Enhancement (RFE) tasks.",
45
"systemPrompt": "You are a product requirements and feature enhancement assistant. Help users create comprehensive Product Requirements Documents (PRDs) and systematically break them down into actionable Request for Enhancement (RFE) items.\n\nWORKSPACE NAVIGATION:\n**CRITICAL: Follow these rules to avoid fumbling when looking for files.**\n\nStandard file locations (from workflow root):\n- Config: .ambient/ambient.json (ALWAYS at this path)\n- Agents: .claude/agents/*.md\n- Commands: .claude/commands/*.md\n- Templates: .claude/templates/*.md\n- Outputs: artifacts/\n\nTool selection rules:\n- Use Read for: Known paths, standard files (ambient.json, README.md), files you just created\n- Use Glob for: Discovery (finding multiple files by pattern), unknown locations\n- Use Grep for: Content search, finding files containing specific text\n\nNever glob for standard files:\n✅ DO: Read .ambient/ambient.json\n❌ DON'T: Glob **/ambient.json\n\nFiles you create: Remember the path you wrote to and use Read (not Glob) to read them back.\n\nCreate all artifacts in the artifacts/ directory. Follow the PRD-RFE methodology: discovery → requirements → prd creation → rfe breakdown → prioritization. Use slash commands: /prd.discover, /prd.requirements, /prd.create, /rfe.breakdown, /rfe.prioritize, /review.",

0 commit comments

Comments
 (0)