@riotprompt/riotplan 1.0.4 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -556,6 +556,11 @@ export declare interface ElaborationRecord {
556
556
  content: string;
557
557
  }
558
558
 
559
+ /**
560
+ * Method used to gather evidence
561
+ */
562
+ declare type EvidenceGatheringMethod = "manual" | "model-assisted";
563
+
559
564
  /**
560
565
  * Evidence record for inception phase materials
561
566
  *
@@ -579,6 +584,10 @@ export declare interface EvidenceRecord {
579
584
  summary?: string;
580
585
  /** Tags for categorization */
581
586
  tags?: string[];
587
+ /** How evidence was gathered */
588
+ gatheringMethod?: EvidenceGatheringMethod;
589
+ /** Relevance score (0-1) from model if model-assisted */
590
+ relevanceScore?: number;
582
591
  }
583
592
 
584
593
  /**
@@ -0,0 +1,127 @@
1
+ # Create Plan Workflow
2
+
3
+ You are helping the user create a new plan with AI-generated, actionable steps for a complex task or feature.
4
+
5
+ ## Your Task
6
+
7
+ Follow this workflow to create a comprehensive plan using the riotplan MCP tools available to you.
8
+
9
+ ## Step 1: Review Provided Information
10
+
11
+ Check what information has already been provided as prompt arguments:
12
+ - **code**: ${code}
13
+ - **description**: ${description}
14
+ - **directory**: ${directory}
15
+ - **steps**: ${steps}
16
+
17
+ ## Step 2: Gather Missing Information
18
+
19
+ For any information marked as "[code]", "[description]", "[directory]", or "[steps]", ask the user to provide it:
20
+
21
+ 1. **Plan Code** (if missing) - Ask for a short identifier (e.g., "auth-system", "dark-mode", "refactor-db")
22
+ 2. **Plan Description** (if missing) - Ask for a clear, detailed description of what they want to accomplish
23
+ 3. **Target Directory** (if missing) - Ask where to create the plan. Suggest using a `plans/` directory if one exists, or offer to create one. If they don't specify, default to current directory.
24
+ 4. **Number of Steps** (if missing) - Ask how many steps to generate, or let the AI determine automatically
25
+ 5. **AI Provider** (optional) - Which provider to use (anthropic, openai, gemini). Default to anthropic if not specified.
26
+
27
+ ## Step 3: Create the Plan Using MCP Tools
28
+
29
+ IMPORTANT: Use the `riotplan_create` MCP tool to create the plan. DO NOT shell out to CLI commands.
30
+
31
+ Once you have all the required information (code, description, directory), call the `riotplan_create` tool:
32
+
33
+ ```
34
+ {
35
+ "code": "the-plan-code",
36
+ "name": "Human Readable Name (optional)",
37
+ "description": "Detailed description of what to accomplish",
38
+ "directory": "path/to/parent/directory",
39
+ "steps": 8,
40
+ "provider": "anthropic",
41
+ "direct": false
42
+ }
43
+ ```
44
+
45
+ Parameters:
46
+ - `code` (required) - Plan identifier
47
+ - `description` (required) - What to accomplish
48
+ - `name` (optional) - Human-readable name
49
+ - `directory` (optional) - Parent directory for the plan
50
+ - `steps` (optional) - Number of steps to generate
51
+ - `direct` (optional) - Set to true to skip analysis phase
52
+ - `provider` (optional) - AI provider (anthropic, openai, gemini)
53
+ - `model` (optional) - Specific model to use
54
+ - `noAi` (optional) - Use templates only, no AI generation
55
+
56
+ ## Step 4: Review the Generated Plan
57
+
58
+ After creation, use the `riotplan_status` tool to check the plan:
59
+
60
+ ```
61
+ {
62
+ "path": "./path/to/plan",
63
+ "verbose": true
64
+ }
65
+ ```
66
+
67
+ Inform the user about:
68
+ - The plan location
69
+ - Number of steps generated
70
+ - The plan structure (SUMMARY.md, EXECUTION_PLAN.md, step files)
71
+
72
+ ## Step 5: Validate the Plan
73
+
74
+ Use the `riotplan_validate` tool to ensure the plan structure is correct:
75
+
76
+ ```
77
+ {
78
+ "path": "./path/to/plan"
79
+ }
80
+ ```
81
+
82
+ If validation fails, report the issues to the user.
83
+
84
+ ## Step 6: Prepare for Execution
85
+
86
+ Inform the user that they can:
87
+ - Review the generated plan files
88
+ - Start the first step using `riotplan_step_start`
89
+ - Track progress using `riotplan_status`
90
+ - Add or modify steps as needed
91
+
92
+ ## Important Guidelines
93
+
94
+ - **Always use MCP tools** - Never shell out to CLI commands like `riotplan create`
95
+ - **Ask about directory** - Don't assume where the plan should be created
96
+ - **Be specific** - Encourage detailed descriptions for better plan generation
97
+ - **Right-size steps** - Suggest 5-10 steps for most tasks
98
+ - **Use analysis** - Don't set `direct: true` unless the user specifically requests it
99
+ - **Validate** - Always validate the plan after creation
100
+
101
+ ## Example Interaction
102
+
103
+ User: "I want to build a dog behavior tracking system"
104
+
105
+ You should:
106
+ 1. Ask clarifying questions:
107
+ - "What specific features should the system include?"
108
+ - "Where would you like me to create the plan? I can create it in a `plans/` directory if you'd like."
109
+ - "How many steps would you like? I recommend 8-10 for a system like this."
110
+
111
+ 2. Once you have the information, call `riotplan_create`:
112
+ ```
113
+ {
114
+ "code": "dog-tracker",
115
+ "name": "Dog Behavior and Training Tracking System",
116
+ "description": "Build a comprehensive dog behavior and training tracking system. The system should allow users to log daily behaviors, track training sessions, monitor progress over time, set training goals, and generate insights about patterns. Include features for multiple dogs, behavior categorization, training exercises library, progress visualization, and reporting capabilities.",
117
+ "directory": "./plans",
118
+ "steps": 10,
119
+ "provider": "anthropic"
120
+ }
121
+ ```
122
+
123
+ 3. Review the result with `riotplan_status`
124
+
125
+ 4. Validate with `riotplan_validate`
126
+
127
+ 5. Inform the user the plan is ready and they can begin execution