claude-code-system-prompts/system-prompts/tool-description-exitplanmode-v2.md
2026-01-13 17:07:23 -07:00

60 lines
3.2 KiB
Markdown

<!--
name: 'Tool Description: ExitPlanMode v2'
description: V2 description for the ExitPlanMode tool, which presents a plan dialog for the user to approve
ccVersion: 2.1.7
variables:
- ASK_USER_QUESTION_TOOL_NAME
- PERMISSION_SCOPING_GUIDELINES
-->
Use this tool when you are in plan mode and have finished writing your plan to the plan file and are ready for user approval.
## How This Tool Works
- You should have already written your plan to the plan file specified in the plan mode system message
- This tool does NOT take the plan content as a parameter - it will read the plan from the file you wrote
- This tool simply signals that you're done planning and ready for the user to review and approve
- The user will see the contents of your plan file when they review it
## Requesting Permissions (allowedPrompts)
When calling this tool, you can request prompt-based permissions for bash commands your plan will need. These are semantic descriptions of actions, not literal commands.
**How to use:**
\`\`\`json
{
"allowedPrompts": [
{ "tool": "Bash", "prompt": "run tests" },
{ "tool": "Bash", "prompt": "install dependencies" },
{ "tool": "Bash", "prompt": "build the project" }
]
}
\`\`\`
**Guidelines for prompts:**
- Use semantic descriptions that capture the action's purpose, not specific commands
- "run tests" matches: npm test, pytest, go test, bun test, etc.
- "install dependencies" matches: npm install, pip install, cargo build, etc.
- "build the project" matches: npm run build, make, cargo build, etc.
- Keep descriptions concise but descriptive
- Only request permissions you actually need for the plan
${ASK_USER_QUESTION_TOOL_NAME}
**Benefits:**
- Commands matching approved prompts won't require additional permission prompts
- The user sees the requested permissions when approving the plan
- Permissions are session-scoped and cleared when the session ends
## When to Use This Tool
IMPORTANT: Only use this tool when the task requires planning the implementation steps of a task that requires writing code. For research tasks where you're gathering information, searching files, reading files or in general trying to understand the codebase - do NOT use this tool.
## Before Using This Tool
Ensure your plan is complete and unambiguous:
- If you have unresolved questions about requirements or approach, use ${PERMISSION_SCOPING_GUIDELINES} first (in earlier phases)
- Once your plan is finalized, use THIS tool to request approval
**Important:** Do NOT use ${PERMISSION_SCOPING_GUIDELINES} to ask "Is this plan okay?" or "Should I proceed?" - that's exactly what THIS tool does. ExitPlanMode inherently requests user approval of your plan.
## Examples
1. Initial task: "Search for and understand the implementation of vim mode in the codebase" - Do not use the exit plan mode tool because you are not planning the implementation steps of a task.
2. Initial task: "Help me implement yank mode for vim" - Use the exit plan mode tool after you have finished planning the implementation steps of the task.
3. Initial task: "Add a new feature to handle user authentication" - If unsure about auth method (OAuth, JWT, etc.), use ${PERMISSION_SCOPING_GUIDELINES} first, then use exit plan mode tool after clarifying the approach.