Skip to content
This repository was archived by the owner on Nov 10, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/mcp-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ This will:

Create a plan for a repository without executing any work.

This plan-only mode reads the codebase using read-only tools (Read, Glob, Grep, Bash) and outputs a structured plan with tasks and success criteria. No changes are made to the repository.
This plan-only mode reads the codebase using the planning tools configured in `config.tools.planning` (default: Read, Glob, Grep, WebFetch, WebSearch) and outputs a structured plan with tasks and success criteria. No changes are made to the repository.

**Parameters:**
| Parameter | Type | Required | Default | Description |
Expand Down
7 changes: 4 additions & 3 deletions docs/repo-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,18 +262,19 @@ plan_repo(

**What Happens:**

1. **Codebase Exploration** - Uses read-only tools (Read, Glob, Grep, Bash) to explore the repository
1. **Codebase Exploration** - Uses the planning tools configured in `config.tools.planning` to explore the repository
2. **Pattern Analysis** - Identifies existing patterns, architecture, and dependencies
3. **Plan Generation** - Creates a structured task list with markdown checkboxes
4. **Success Criteria Definition** - Defines measurable success criteria
5. **State Persistence** - Saves plan to `.claude-task-master/plan.md` and criteria to `.claude-task-master/criteria.txt`

**Read-Only Tools Used:**
**Default Planning Tools (`config.tools.planning`):**

- **Read** - Read specific files
- **Glob** - Find files by pattern
- **Grep** - Search file contents
- **Bash** - Run read-only commands (ls, grep, find, etc.)
- **WebFetch** - Fetch a web page
- **WebSearch** - Search the web

**No Changes Made:**

Expand Down
7 changes: 4 additions & 3 deletions src/claude_task_master/api/models_repo.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,10 @@ def _confine_work_dir(cls, v: str) -> str:
class PlanRepoRequest(BaseModel):
"""Request model for creating a plan for a repository.

Creates a plan without executing any work. Uses read-only tools
(Read, Glob, Grep) to analyze the codebase and outputs a structured
plan with tasks and success criteria.
Creates a plan without executing any work. Uses the planning tools
configured in config.tools.planning (read-only by default) to analyze
the codebase and outputs a structured plan with tasks and success
criteria.

Use this after cloning and setting up a repo to plan work before
execution, or to get a plan for a new goal in an existing repository.
Expand Down
7 changes: 4 additions & 3 deletions src/claude_task_master/api/routes_repo.py
Original file line number Diff line number Diff line change
Expand Up @@ -264,16 +264,17 @@ async def post_setup_repo(
summary="Plan Repository Work",
description=(
"Create a plan for a repository without executing any work. "
"Uses read-only tools to analyze the codebase and generate a task list."
"Uses the configured planning tools to analyze the codebase and "
"generate a task list."
),
)
async def post_plan_repo(
plan_request: PlanRepoRequest,
) -> PlanRepoResponse | JSONResponse:
"""Create a plan for a repository.

Uses read-only tools (Read, Glob, Grep) to analyze the codebase
and output a structured plan with tasks and success criteria.
Uses the planning tools configured in config.tools.planning to analyze
the codebase and output a structured plan with tasks and success criteria.
No changes are made to the repository.

Use this after cloning and setting up a repo to plan work before
Expand Down
6 changes: 3 additions & 3 deletions src/claude_task_master/mcp/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -260,9 +260,9 @@ async def plan_repo(
) -> dict[str, Any]:
"""Create a plan for a repository without executing any work.

This is a plan-only mode that reads the codebase using read-only tools
(Read, Glob, Grep) and outputs a structured plan with tasks and success
criteria. No changes are made to the repository.
This is a plan-only mode that reads the codebase using the planning tools
configured in config.tools.planning and outputs a structured plan with
tasks and success criteria. No changes are made to the repository.

Use this after `clone_repo` and `setup_repo` to plan work before execution,
or to get a plan for a new goal in an existing repository.
Expand Down
6 changes: 3 additions & 3 deletions src/claude_task_master/mcp/tool_handlers_repo.py
Original file line number Diff line number Diff line change
Expand Up @@ -310,9 +310,9 @@ def plan_repo(
) -> dict[str, Any]:
"""Create a plan for a repository without executing any work.

This is a plan-only mode that reads the codebase using read-only tools
(Read, Glob, Grep, Bash) and outputs a structured plan with tasks and
success criteria. No changes are made to the repository.
This is a plan-only mode that reads the codebase using the planning tools
configured in config.tools.planning and outputs a structured plan with
tasks and success criteria. No changes are made to the repository.

Use this after ``clone_repo`` and ``setup_repo`` to plan work before
execution, or to get a plan for a new goal in an existing repository.
Expand Down
Loading