You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-5Lines changed: 22 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ If you want reproducible installs instead of automatic plugin refreshes, pin an
29
29
}
30
30
```
31
31
32
-
You can also customize the `plan` agent in the same config. The plugin keeps its default planner prompt and appends your custom prompt, so this is a good place to add repo-specific planning rules or a dedicated model with a specific reasoning level:
32
+
You can also customize the `plan` agent in the same config. If you set `agent.plan.prompt`, it replaces the plugin's base planning prompt, so this is a good place to add repo-specific planning rules or a dedicated model with a specific reasoning level:
33
33
34
34
```json
35
35
{
@@ -44,21 +44,22 @@ You can also customize the `plan` agent in the same config. The plugin keeps its
44
44
}
45
45
```
46
46
47
-
This extends the built-in planning instructions rather than replacing them.
47
+
This replaces the plugin's base planning prompt. The plugin still injects a separate runtime planner reminder to keep the agent in planning mode.
48
48
49
49
## What it does
50
50
51
51
- adds a `plan` agent intended for design and implementation planning
52
52
- constrains that agent to read-only tools plus markdown plan editing
53
53
- injects a system reminder that keeps the planning workflow explicit
54
-
- lets users extend the plugin's base `plan` prompt with their own `agent.plan.prompt`
54
+
- lets users replace the plugin's base `plan` prompt with their own `agent.plan.prompt`
55
55
- lets users override agent settings such as `agent.plan.model` and provider-specific options like `agent.plan.reasoningEffort`
56
+
- exposes a `plan_prompt` tool so the `plan` agent can reveal the plugin's prompt basis for customization
56
57
- uses `submit_plan` for review when available, otherwise falls back to manual chat review
57
58
- can leave planner mode with `plan_exit` after approval when experimental plan mode is enabled in the CLI runtime
58
59
59
60
## Customize the plan agent
60
61
61
-
If you set `agent.plan.prompt`, the plugin appends your text after its built-in planning instructions. Other agent settings, such as `agent.plan.model` and provider-specific options like `agent.plan.reasoningEffort`, are merged in normally.
62
+
If you set `agent.plan.prompt`, the plugin replaces its built-in base planning prompt with your text. Other agent settings, such as `agent.plan.model` and provider-specific options like `agent.plan.reasoningEffort`, are merged in normally.
62
63
63
64
```json
64
65
{
@@ -74,6 +75,22 @@ If you set `agent.plan.prompt`, the plugin appends your text after its built-in
74
75
75
76
The runtime planner reminder still applies, so the agent stays in planner mode and continues to use the review handoff flow. That reminder is injected by the plugin at runtime and is not customized through `agent.plan.prompt`.
76
77
78
+
## Reveal the plugin prompt basis
79
+
80
+
The plugin also adds a read-only `plan_prompt` tool. Ask the `plan` agent to use it when you want the plugin's own prompt text and planner reminder as a starting point for customization.
81
+
82
+
Example:
83
+
84
+
```text
85
+
Use the plan_prompt tool and show me the plugin prompt so I can customize it.
86
+
```
87
+
88
+
The tool returns:
89
+
90
+
- the plugin base prompt
91
+
- the injected planner reminder, which is plugin-controlled runtime guidance and is not customized via `agent.plan.prompt`
92
+
- a short note explaining that the final runtime prompt can still differ because of user config, other plugins, or runtime tool availability like `plan_exit`
93
+
77
94
## Auto-updates
78
95
79
96
OpenCode installs npm plugins automatically. During the prerelease phase, `opencode-planner@beta` gives the smoothest update path for most users.
@@ -94,7 +111,7 @@ npm run debug:plan
94
111
npm run opencode:no-plannotator -- debug config
95
112
```
96
113
97
-
`npm run debug:plan` checks the active OpenCode runtime and reports whether the local repo plugin is loaded, whether `submit_plan` and `plan_exit` are allowed by the `plan` agent, and whether they are actually registered as runtime tools.
114
+
`npm run debug:plan` checks the active OpenCode runtime and reports whether the local repo plugin is loaded, whether `plan_prompt`, `submit_plan`, and `plan_exit` are allowed by the `plan` agent, and whether they are actually registered as runtime tools.
0 commit comments