|
[ |
|
{ |
|
"name": "Agent", |
|
"description": "Launch a new agent to handle complex, multi-step tasks autonomously.\n\nThe Agent tool launches specialized agents (subprocesses) that autonomously handle complex tasks. Each agent type has specific capabilities and tools available to it.\n\nAvailable agent types and the tools they have access to:\n- general-purpose: General-purpose agent for researching complex questions, searching for code, and executing multi-step tasks. When you are searching for a keyword or file and are not confident that you will find the right match in the first few tries use this agent to perform the search for you. (Tools: *)\n- statusline-setup: Use this agent to configure the user's Claude Code status line setting. (Tools: Read, Edit)\n- Explore: Fast agent specialized for exploring codebases. Use this when you need to quickly find files by patterns (eg. \"src/components/**/*.tsx\"), search code for keywords (eg. \"API endpoints\"), or answer questions about the codebase (eg. \"how do API endpoints work?\"). When calling this agent, specify the desired thoroughness level: \"quick\" for basic searches, \"medium\" for moderate exploration, or \"very thorough\" for comprehensive analysis across multiple locations and naming conventions. (Tools: All tools except Agent, ExitPlanMode, Edit, Write, NotebookEdit)\n- Plan: Software architect agent for designing implementation plans. Use this when you need to plan the implementation strategy for a task. Returns step-by-step plans, identifies critical files, and considers architectural trade-offs. (Tools: All tools except Agent, ExitPlanMode, Edit, Write, NotebookEdit)\n- claude-code-guide: Use this agent when the user asks questions (\"Can Claude...\", \"Does Claude...\", \"How do I...\") about: (1) Claude Code (the CLI tool) - features, hooks, slash commands, MCP servers, settings, IDE integrations, keyboard shortcuts; (2) Claude Agent SDK - building custom agents; (3) Claude API (formerly Anthropic API) - API usage, tool use, Anthropic SDK usage. **IMPORTANT:** Before spawning a new agent, check if there is already a running or recently completed claude-code-guide agent that you can resume using the \"resume\" parameter. (Tools: Glob, Grep, Read, WebFetch, WebSearch)\n\nWhen using the Agent tool, specify a subagent_type parameter to select which agent type to use. If omitted, the general-purpose agent is used.\n\nWhen NOT to use the Agent tool:\n- If you want to read a specific file path, use the Read tool or the Glob tool instead of the Agent tool, to find the match more quickly\n- If you are searching for a specific class definition like \"class Foo\", use the Glob tool instead, to find the match more quickly\n- If you are searching for code within a specific file or set of 2-3 files, use the Read tool instead of the Agent tool, to find the match more quickly\n- Other tasks that are not related to the agent descriptions above\n\n\nUsage notes:\n- Always include a short description (3-5 words) summarizing what the agent will do\n- Launch multiple agents concurrently whenever possible, to maximize performance; to do that, use a single message with multiple tool uses\n- When the agent is done, it will return a single message back to you. The result returned by the agent is not visible to the user. To show the user the result, you should send a text message back to the user with a concise summary of the result.\n- You can optionally run agents in the background using the run_in_background parameter. When an agent runs in the background, you will be automatically notified when it completes — do NOT sleep, poll, or proactively check on its progress. Continue with other work or respond to the user instead.\n- **Foreground vs background**: Use foreground (default) when you need the agent's results before you can proceed — e.g., research agents whose findings inform your next steps. Use background when you have genuinely independent work to do in parallel.\n- Agents can be resumed using the `resume` parameter by passing the agent ID from a previous invocation. When resumed, the agent continues with its full previous context preserved. When NOT resuming, each invocation starts fresh and you should provide a detailed task description with all necessary context.\n- When the agent is done, it will return a single message back to you along with its agent ID. You can use this ID to resume the agent later if needed for follow-up work.\n- Provide clear, detailed prompts so the agent can work autonomously and return exactly the information you need.\n- The agent's outputs should generally be trusted\n- Clearly tell the agent whether you expect it to write code or just to do research (search, file reads, web fetches, etc.), since it is not aware of the user's intent\n- If the agent description mentions that it should be used proactively, then you should try your best to use it without the user having to ask for it first. Use your judgement.\n- If the user specifies that they want you to run agents \"in parallel\", you MUST send a single message with multiple Agent tool use content blocks. For example, if you need to launch both a build-validator agent and a test-runner agent in parallel, send a single message with both tool calls.\n- You can optionally set `isolation: \"worktree\"` to run the agent in a temporary git worktree, giving it an isolated copy of the repository. The worktree is automatically cleaned up if the agent makes no changes; if changes are made, the worktree path and branch are returned in the result.\n\nExample usage:\n\n<example_agent_descriptions>\n\"test-runner\": use this agent after you are done writing code to run tests\n\"greeting-responder\": use this agent to respond to user greetings with a friendly joke\n</example_agent_descriptions>\n\n<example>\nuser: \"Please write a function that checks if a number is prime\"\nassistant: I'm going to use the Write tool to write the following code:\n<code>\nfunction isPrime(n) {\n if (n <= 1) return false\n for (let i = 2; i * i <= n; i++) {\n if (n % i === 0) return false\n }\n return true\n}\n</code>\n<commentary>\nSince a significant piece of code was written and the task was completed, now use the test-runner agent to run the tests\n</commentary>\nassistant: Uses the Agent tool to launch the test-runner agent\n</example>\n\n<example>\nuser: \"Hello\"\n<commentary>\nSince the user is greeting, use the greeting-responder agent to respond with a friendly joke\n</commentary>\nassistant: \"I'm going to use the Agent tool to launch the greeting-responder agent\"\n</example>\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"description": { |
|
"description": "A short (3-5 word) description of the task", |
|
"type": "string" |
|
}, |
|
"prompt": { |
|
"description": "The task for the agent to perform", |
|
"type": "string" |
|
}, |
|
"subagent_type": { |
|
"description": "The type of specialized agent to use for this task", |
|
"type": "string" |
|
}, |
|
"resume": { |
|
"description": "Optional agent ID to resume from. If provided, the agent will continue from the previous execution transcript.", |
|
"type": "string" |
|
}, |
|
"run_in_background": { |
|
"description": "Set to true to run this agent in the background. You will be notified when it completes.", |
|
"type": "boolean" |
|
}, |
|
"isolation": { |
|
"description": "Isolation mode. \"worktree\" creates a temporary git worktree so the agent works on an isolated copy of the repo.", |
|
"type": "string", |
|
"enum": [ |
|
"worktree" |
|
] |
|
} |
|
}, |
|
"required": [ |
|
"description", |
|
"prompt" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "TaskOutput", |
|
"description": "- Retrieves output from a running or completed task (background shell, agent, or remote session)\n- Takes a task_id parameter identifying the task\n- Returns the task output along with status information\n- Use block=true (default) to wait for task completion\n- Use block=false for non-blocking check of current status\n- Task IDs can be found using the /tasks command\n- Works with all task types: background shells, async agents, and remote sessions", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"task_id": { |
|
"description": "The task ID to get output from", |
|
"type": "string" |
|
}, |
|
"block": { |
|
"description": "Whether to wait for completion", |
|
"default": true, |
|
"type": "boolean" |
|
}, |
|
"timeout": { |
|
"description": "Max wait time in ms", |
|
"default": 30000, |
|
"type": "number", |
|
"minimum": 0, |
|
"maximum": 600000 |
|
} |
|
}, |
|
"required": [ |
|
"task_id", |
|
"block", |
|
"timeout" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "Bash", |
|
"description": "Executes a given bash command and returns its output.\n\nThe working directory persists between commands, but shell state does not. The shell environment is initialized from the user's profile (bash or zsh).\n\nIMPORTANT: Avoid using this tool to run `find`, `grep`, `cat`, `head`, `tail`, `sed`, `awk`, or `echo` commands, unless explicitly instructed or after you have verified that a dedicated tool cannot accomplish your task. Instead, use the appropriate dedicated tool as this will provide a much better experience for the user:\n\n - File search: Use Glob (NOT find or ls)\n - Content search: Use Grep (NOT grep or rg)\n - Read files: Use Read (NOT cat/head/tail)\n - Edit files: Use Edit (NOT sed/awk)\n - Write files: Use Write (NOT echo >/cat <<EOF)\n - Communication: Output text directly (NOT echo/printf)\nWhile the Bash tool can do similar things, it’s better to use the built-in tools as they provide a better user experience and make it easier to review tool calls and give permission.\n\n# Instructions\n - If your command will create new directories or files, first use this tool to run `ls` to verify the parent directory exists and is the correct location.\n - Always quote file paths that contain spaces with double quotes in your command (e.g., cd \"path with spaces/file.txt\")\n - Try to maintain your current working directory throughout the session by using absolute paths and avoiding usage of `cd`. You may use `cd` if the User explicitly requests it.\n - You may specify an optional timeout in milliseconds (up to 600000ms / 10 minutes). By default, your command will timeout after 120000ms (2 minutes).\n - You can use the `run_in_background` parameter to run the command in the background. Only use this if you don't need the result immediately and are OK being notified when the command completes later. You do not need to check the output right away - you'll be notified when it finishes. You do not need to use '&' at the end of the command when using this parameter.\n - Write a clear, concise description of what your command does. For simple commands, keep it brief (5-10 words). For complex commands (piped commands, obscure flags, or anything hard to understand at a glance), include enough context so that the user can understand what your command will do.\n - When issuing multiple commands:\n - If the commands are independent and can run in parallel, make multiple Bash tool calls in a single message. Example: if you need to run \"git status\" and \"git diff\", send a single message with two Bash tool calls in parallel.\n - If the commands depend on each other and must run sequentially, use a single Bash call with '&&' to chain them together.\n - Use ';' only when you need to run commands sequentially but don't care if earlier commands fail.\n - DO NOT use newlines to separate commands (newlines are ok in quoted strings).\n - For git commands:\n - Prefer to create a new commit rather than amending an existing commit.\n - Before running destructive operations (e.g., git reset --hard, git push --force, git checkout --), consider whether there is a safer alternative that achieves the same goal. Only use destructive operations when they are truly the best approach.\n - Never skip hooks (--no-verify) or bypass signing (--no-gpg-sign, -c commit.gpgsign=false) unless the user has explicitly asked for it. If a hook fails, investigate and fix the underlying issue.\n - Avoid unnecessary `sleep` commands:\n - Do not sleep between commands that can run immediately — just run them.\n - If your command is long running and you would like to be notified when it finishes – simply run your command using `run_in_background`. There is no need to sleep in this case.\n - Do not retry failing commands in a sleep loop — diagnose the root cause or consider an alternative approach.\n - If waiting for a background task you started with `run_in_background`, you will be notified when it completes — do not poll.\n - If you must poll an external process, use a check command (e.g. `gh run view`) rather than sleeping first.\n - If you must sleep, keep the duration short (1-5 seconds) to avoid blocking the user.\n\n\n# Committing changes with git\n\nOnly create commits when requested by the user. If unclear, ask first. When the user asks you to create a new git commit, follow these steps carefully:\n\nGit Safety Protocol:\n- NEVER update the git config\n- NEVER run destructive git commands (push --force, reset --hard, checkout ., restore ., clean -f, branch -D) unless the user explicitly requests these actions. Taking unauthorized destructive actions is unhelpful and can result in lost work, so it's best to ONLY run these commands when given direct instructions \n- NEVER skip hooks (--no-verify, --no-gpg-sign, etc) unless the user explicitly requests it\n- NEVER run force push to main/master, warn the user if they request it\n- CRITICAL: Always create NEW commits rather than amending, unless the user explicitly requests a git amend. When a pre-commit hook fails, the commit did NOT happen — so --amend would modify the PREVIOUS commit, which may result in destroying work or losing previous changes. Instead, after hook failure, fix the issue, re-stage, and create a NEW commit\n- When staging files, prefer adding specific files by name rather than using \"git add -A\" or \"git add .\", which can accidentally include sensitive files (.env, credentials) or large binaries\n- NEVER commit changes unless the user explicitly asks you to. It is VERY IMPORTANT to only commit when explicitly asked, otherwise the user will feel that you are being too proactive\n\n1. You can call multiple tools in a single response. When multiple independent pieces of information are requested and all commands are likely to succeed, run multiple tool calls in parallel for optimal performance. run the following bash commands in parallel, each using the Bash tool:\n - Run a git status command to see all untracked files. IMPORTANT: Never use the -uall flag as it can cause memory issues on large repos.\n - Run a git diff command to see both staged and unstaged changes that will be committed.\n - Run a git log command to see recent commit messages, so that you can follow this repository's commit message style.\n2. Analyze all staged changes (both previously staged and newly added) and draft a commit message:\n - Summarize the nature of the changes (eg. new feature, enhancement to an existing feature, bug fix, refactoring, test, docs, etc.). Ensure the message accurately reflects the changes and their purpose (i.e. \"add\" means a wholly new feature, \"update\" means an enhancement to an existing feature, \"fix\" means a bug fix, etc.).\n - Do not commit files that likely contain secrets (.env, credentials.json, etc). Warn the user if they specifically request to commit those files\n - Draft a concise (1-2 sentences) commit message that focuses on the \"why\" rather than the \"what\"\n - Ensure it accurately reflects the changes and their purpose\n3. You can call multiple tools in a single response. When multiple independent pieces of information are requested and all commands are likely to succeed, run multiple tool calls in parallel for optimal performance. run the following commands:\n - Add relevant untracked files to the staging area.\n - Create the commit with a message ending with:\n Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>\n - Run git status after the commit completes to verify success.\n Note: git status depends on the commit completing, so run it sequentially after the commit.\n4. If the commit fails due to pre-commit hook: fix the issue and create a NEW commit\n\nImportant notes:\n- NEVER run additional commands to read or explore code, besides git bash commands\n- NEVER use the TodoWrite or Agent tools\n- DO NOT push to the remote repository unless the user explicitly asks you to do so\n- IMPORTANT: Never use git commands with the -i flag (like git rebase -i or git add -i) since they require interactive input which is not supported.\n- IMPORTANT: Do not use --no-edit with git rebase commands, as the --no-edit flag is not a valid option for git rebase.\n- If there are no changes to commit (i.e., no untracked files and no modifications), do not create an empty commit\n- In order to ensure good formatting, ALWAYS pass the commit message via a HEREDOC, a la this example:\n<example>\ngit commit -m \"$(cat <<'EOF'\n Commit message here.\n\n Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>\n EOF\n )\"\n</example>\n\n# Creating pull requests\nUse the gh command via the Bash tool for ALL GitHub-related tasks including working with issues, pull requests, checks, and releases. If given a Github URL use the gh command to get the information needed.\n\nIMPORTANT: When the user asks you to create a pull request, follow these steps carefully:\n\n1. You can call multiple tools in a single response. When multiple independent pieces of information are requested and all commands are likely to succeed, run multiple tool calls in parallel for optimal performance. run the following bash commands in parallel using the Bash tool, in order to understand the current state of the branch since it diverged from the main branch:\n - Run a git status command to see all untracked files (never use -uall flag)\n - Run a git diff command to see both staged and unstaged changes that will be committed\n - Check if the current branch tracks a remote branch and is up to date with the remote, so you know if you need to push to the remote\n - Run a git log command and `git diff [base-branch]...HEAD` to understand the full commit history for the current branch (from the time it diverged from the base branch)\n2. Analyze all changes that will be included in the pull request, making sure to look at all relevant commits (NOT just the latest commit, but ALL commits that will be included in the pull request!!!), and draft a pull request title and summary:\n - Keep the PR title short (under 70 characters)\n - Use the description/body for details, not the title\n3. You can call multiple tools in a single response. When multiple independent pieces of information are requested and all commands are likely to succeed, run multiple tool calls in parallel for optimal performance. run the following commands in parallel:\n - Create new branch if needed\n - Push to remote with -u flag if needed\n - Create PR using gh pr create with the format below. Use a HEREDOC to pass the body to ensure correct formatting.\n<example>\ngh pr create --title \"the pr title\" --body \"$(cat <<'EOF'\n## Summary\n<1-3 bullet points>\n\n## Test plan\n[Bulleted markdown checklist of TODOs for testing the pull request...]\n\n🤖 Generated with [Claude Code](https://claude.com/claude-code)\nEOF\n)\"\n</example>\n\nImportant:\n- DO NOT use the TodoWrite or Agent tools\n- Return the PR URL when you're done, so the user can see it\n\n# Other common operations\n- View comments on a Github PR: gh api repos/foo/bar/pulls/123/comments", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"command": { |
|
"description": "The command to execute", |
|
"type": "string" |
|
}, |
|
"timeout": { |
|
"description": "Optional timeout in milliseconds (max 600000)", |
|
"type": "number" |
|
}, |
|
"description": { |
|
"description": "Clear, concise description of what this command does in active voice. Never use words like \"complex\" or \"risk\" in the description - just describe what it does.\n\nFor simple commands (git, npm, standard CLI tools), keep it brief (5-10 words):\n- ls → \"List files in current directory\"\n- git status → \"Show working tree status\"\n- npm install → \"Install package dependencies\"\n\nFor commands that are harder to parse at a glance (piped commands, obscure flags, etc.), add enough context to clarify what it does:\n- find . -name \"*.tmp\" -exec rm {} \\; → \"Find and delete all .tmp files recursively\"\n- git reset --hard origin/main → \"Discard all local changes and match remote main\"\n- curl -s url | jq '.data[]' → \"Fetch JSON from URL and extract data array elements\"", |
|
"type": "string" |
|
}, |
|
"run_in_background": { |
|
"description": "Set to true to run this command in the background. Use TaskOutput to read the output later.", |
|
"type": "boolean" |
|
}, |
|
"dangerouslyDisableSandbox": { |
|
"description": "Set this to true to dangerously override sandbox mode and run commands without sandboxing.", |
|
"type": "boolean" |
|
} |
|
}, |
|
"required": [ |
|
"command" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "Glob", |
|
"description": "- Fast file pattern matching tool that works with any codebase size\n- Supports glob patterns like \"**/*.js\" or \"src/**/*.ts\"\n- Returns matching file paths sorted by modification time\n- Use this tool when you need to find files by name patterns\n- When you are doing an open ended search that may require multiple rounds of globbing and grepping, use the Agent tool instead\n- You can call multiple tools in a single response. It is always better to speculatively perform multiple searches in parallel if they are potentially useful.", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"pattern": { |
|
"description": "The glob pattern to match files against", |
|
"type": "string" |
|
}, |
|
"path": { |
|
"description": "The directory to search in. If not specified, the current working directory will be used. IMPORTANT: Omit this field to use the default directory. DO NOT enter \"undefined\" or \"null\" - simply omit it for the default behavior. Must be a valid directory path if provided.", |
|
"type": "string" |
|
} |
|
}, |
|
"required": [ |
|
"pattern" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "Grep", |
|
"description": "A powerful search tool built on ripgrep\n\n Usage:\n - ALWAYS use Grep for search tasks. NEVER invoke `grep` or `rg` as a Bash command. The Grep tool has been optimized for correct permissions and access.\n - Supports full regex syntax (e.g., \"log.*Error\", \"function\\s+\\w+\")\n - Filter files with glob parameter (e.g., \"*.js\", \"**/*.tsx\") or type parameter (e.g., \"js\", \"py\", \"rust\")\n - Output modes: \"content\" shows matching lines, \"files_with_matches\" shows only file paths (default), \"count\" shows match counts\n - Use Agent tool for open-ended searches requiring multiple rounds\n - Pattern syntax: Uses ripgrep (not grep) - literal braces need escaping (use `interface\\{\\}` to find `interface{}` in Go code)\n - Multiline matching: By default patterns match within single lines only. For cross-line patterns like `struct \\{[\\s\\S]*?field`, use `multiline: true`\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"pattern": { |
|
"description": "The regular expression pattern to search for in file contents", |
|
"type": "string" |
|
}, |
|
"path": { |
|
"description": "File or directory to search in (rg PATH). Defaults to current working directory.", |
|
"type": "string" |
|
}, |
|
"glob": { |
|
"description": "Glob pattern to filter files (e.g. \"*.js\", \"*.{ts,tsx}\") - maps to rg --glob", |
|
"type": "string" |
|
}, |
|
"output_mode": { |
|
"description": "Output mode: \"content\" shows matching lines (supports -A/-B/-C context, -n line numbers, head_limit), \"files_with_matches\" shows file paths (supports head_limit), \"count\" shows match counts (supports head_limit). Defaults to \"files_with_matches\".", |
|
"type": "string", |
|
"enum": [ |
|
"content", |
|
"files_with_matches", |
|
"count" |
|
] |
|
}, |
|
"-B": { |
|
"description": "Number of lines to show before each match (rg -B). Requires output_mode: \"content\", ignored otherwise.", |
|
"type": "number" |
|
}, |
|
"-A": { |
|
"description": "Number of lines to show after each match (rg -A). Requires output_mode: \"content\", ignored otherwise.", |
|
"type": "number" |
|
}, |
|
"-C": { |
|
"description": "Alias for context.", |
|
"type": "number" |
|
}, |
|
"context": { |
|
"description": "Number of lines to show before and after each match (rg -C). Requires output_mode: \"content\", ignored otherwise.", |
|
"type": "number" |
|
}, |
|
"-n": { |
|
"description": "Show line numbers in output (rg -n). Requires output_mode: \"content\", ignored otherwise. Defaults to true.", |
|
"type": "boolean" |
|
}, |
|
"-i": { |
|
"description": "Case insensitive search (rg -i)", |
|
"type": "boolean" |
|
}, |
|
"type": { |
|
"description": "File type to search (rg --type). Common types: js, py, rust, go, java, etc. More efficient than include for standard file types.", |
|
"type": "string" |
|
}, |
|
"head_limit": { |
|
"description": "Limit output to first N lines/entries, equivalent to \"| head -N\". Works across all output modes: content (limits output lines), files_with_matches (limits file paths), count (limits count entries). Defaults to 0 (unlimited).", |
|
"type": "number" |
|
}, |
|
"offset": { |
|
"description": "Skip first N lines/entries before applying head_limit, equivalent to \"| tail -n +N | head -N\". Works across all output modes. Defaults to 0.", |
|
"type": "number" |
|
}, |
|
"multiline": { |
|
"description": "Enable multiline mode where . matches newlines and patterns can span lines (rg -U --multiline-dotall). Default: false.", |
|
"type": "boolean" |
|
} |
|
}, |
|
"required": [ |
|
"pattern" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "ExitPlanMode", |
|
"description": "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.\n\n## How This Tool Works\n- You should have already written your plan to the plan file specified in the plan mode system message\n- This tool does NOT take the plan content as a parameter - it will read the plan from the file you wrote\n- This tool simply signals that you're done planning and ready for the user to review and approve\n- The user will see the contents of your plan file when they review it\n\n## When to Use This Tool\nIMPORTANT: 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.\n\n## Before Using This Tool\nEnsure your plan is complete and unambiguous:\n- If you have unresolved questions about requirements or approach, use AskUserQuestion first (in earlier phases)\n- Once your plan is finalized, use THIS tool to request approval\n\n**Important:** Do NOT use AskUserQuestion 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.\n\n## Examples\n\n1. 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.\n2. 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.\n3. Initial task: \"Add a new feature to handle user authentication\" - If unsure about auth method (OAuth, JWT, etc.), use AskUserQuestion first, then use exit plan mode tool after clarifying the approach.\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"allowedPrompts": { |
|
"description": "Prompt-based permissions needed to implement the plan. These describe categories of actions rather than specific commands.", |
|
"type": "array", |
|
"items": { |
|
"type": "object", |
|
"properties": { |
|
"tool": { |
|
"description": "The tool this prompt applies to", |
|
"type": "string", |
|
"enum": [ |
|
"Bash" |
|
] |
|
}, |
|
"prompt": { |
|
"description": "Semantic description of the action, e.g. \"run tests\", \"install dependencies\"", |
|
"type": "string" |
|
} |
|
}, |
|
"required": [ |
|
"tool", |
|
"prompt" |
|
], |
|
"additionalProperties": false |
|
} |
|
} |
|
}, |
|
"additionalProperties": {} |
|
} |
|
}, |
|
{ |
|
"name": "Read", |
|
"description": "Reads a file from the local filesystem. You can access any file directly by using this tool.\nAssume this tool is able to read all files on the machine. If the User provides a path to a file assume that path is valid. It is okay to read a file that does not exist; an error will be returned.\n\nUsage:\n- The file_path parameter must be an absolute path, not a relative path\n- By default, it reads up to 2000 lines starting from the beginning of the file\n- You can optionally specify a line offset and limit (especially handy for long files), but it's recommended to read the whole file by not providing these parameters\n- Any lines longer than 2000 characters will be truncated\n- Results are returned using cat -n format, with line numbers starting at 1\n- This tool allows Claude Code to read images (eg PNG, JPG, etc). When reading an image file the contents are presented visually as Claude Code is a multimodal LLM.\n- This tool can read PDF files (.pdf). For large PDFs (more than 10 pages), you MUST provide the pages parameter to read specific page ranges (e.g., pages: \"1-5\"). Reading a large PDF without the pages parameter will fail. Maximum 20 pages per request.\n- This tool can read Jupyter notebooks (.ipynb files) and returns all cells with their outputs, combining code, text, and visualizations.\n- This tool can only read files, not directories. To read a directory, use an ls command via the Bash tool.\n- You can call multiple tools in a single response. It is always better to speculatively read multiple potentially useful files in parallel.\n- You will regularly be asked to read screenshots. If the user provides a path to a screenshot, ALWAYS use this tool to view the file at the path. This tool will work with all temporary file paths.\n- If you read a file that exists but has empty contents you will receive a system reminder warning in place of file contents.", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"file_path": { |
|
"description": "The absolute path to the file to read", |
|
"type": "string" |
|
}, |
|
"offset": { |
|
"description": "The line number to start reading from. Only provide if the file is too large to read at once", |
|
"type": "number" |
|
}, |
|
"limit": { |
|
"description": "The number of lines to read. Only provide if the file is too large to read at once.", |
|
"type": "number" |
|
}, |
|
"pages": { |
|
"description": "Page range for PDF files (e.g., \"1-5\", \"3\", \"10-20\"). Only applicable to PDF files. Maximum 20 pages per request.", |
|
"type": "string" |
|
} |
|
}, |
|
"required": [ |
|
"file_path" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "Edit", |
|
"description": "Performs exact string replacements in files.\n\nUsage:\n- You must use your `Read` tool at least once in the conversation before editing. This tool will error if you attempt an edit without reading the file. \n- When editing text from Read tool output, ensure you preserve the exact indentation (tabs/spaces) as it appears AFTER the line number prefix. The line number prefix format is: spaces + line number + tab. Everything after that tab is the actual file content to match. Never include any part of the line number prefix in the old_string or new_string.\n- ALWAYS prefer editing existing files in the codebase. NEVER write new files unless explicitly required.\n- Only use emojis if the user explicitly requests it. Avoid adding emojis to files unless asked.\n- The edit will FAIL if `old_string` is not unique in the file. Either provide a larger string with more surrounding context to make it unique or use `replace_all` to change every instance of `old_string`.\n- Use `replace_all` for replacing and renaming strings across the file. This parameter is useful if you want to rename a variable for instance.", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"file_path": { |
|
"description": "The absolute path to the file to modify", |
|
"type": "string" |
|
}, |
|
"old_string": { |
|
"description": "The text to replace", |
|
"type": "string" |
|
}, |
|
"new_string": { |
|
"description": "The text to replace it with (must be different from old_string)", |
|
"type": "string" |
|
}, |
|
"replace_all": { |
|
"description": "Replace all occurrences of old_string (default false)", |
|
"default": false, |
|
"type": "boolean" |
|
} |
|
}, |
|
"required": [ |
|
"file_path", |
|
"old_string", |
|
"new_string" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "Write", |
|
"description": "Writes a file to the local filesystem.\n\nUsage:\n- This tool will overwrite the existing file if there is one at the provided path.\n- If this is an existing file, you MUST use the Read tool first to read the file's contents. This tool will fail if you did not read the file first.\n- Prefer the Edit tool for modifying existing files — it only sends the diff. Only use this tool to create new files or for complete rewrites.\n- NEVER create documentation files (*.md) or README files unless explicitly requested by the User.\n- Only use emojis if the user explicitly requests it. Avoid writing emojis to files unless asked.", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"file_path": { |
|
"description": "The absolute path to the file to write (must be absolute, not relative)", |
|
"type": "string" |
|
}, |
|
"content": { |
|
"description": "The content to write to the file", |
|
"type": "string" |
|
} |
|
}, |
|
"required": [ |
|
"file_path", |
|
"content" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "NotebookEdit", |
|
"description": "Completely replaces the contents of a specific cell in a Jupyter notebook (.ipynb file) with new source. Jupyter notebooks are interactive documents that combine code, text, and visualizations, commonly used for data analysis and scientific computing. The notebook_path parameter must be an absolute path, not a relative path. The cell_number is 0-indexed. Use edit_mode=insert to add a new cell at the index specified by cell_number. Use edit_mode=delete to delete the cell at the index specified by cell_number.", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"notebook_path": { |
|
"description": "The absolute path to the Jupyter notebook file to edit (must be absolute, not relative)", |
|
"type": "string" |
|
}, |
|
"cell_id": { |
|
"description": "The ID of the cell to edit. When inserting a new cell, the new cell will be inserted after the cell with this ID, or at the beginning if not specified.", |
|
"type": "string" |
|
}, |
|
"new_source": { |
|
"description": "The new source for the cell", |
|
"type": "string" |
|
}, |
|
"cell_type": { |
|
"description": "The type of the cell (code or markdown). If not specified, it defaults to the current cell type. If using edit_mode=insert, this is required.", |
|
"type": "string", |
|
"enum": [ |
|
"code", |
|
"markdown" |
|
] |
|
}, |
|
"edit_mode": { |
|
"description": "The type of edit to make (replace, insert, delete). Defaults to replace.", |
|
"type": "string", |
|
"enum": [ |
|
"replace", |
|
"insert", |
|
"delete" |
|
] |
|
} |
|
}, |
|
"required": [ |
|
"notebook_path", |
|
"new_source" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "WebFetch", |
|
"description": "\n- Fetches content from a specified URL and processes it using an AI model\n- Takes a URL and a prompt as input\n- Fetches the URL content, converts HTML to markdown\n- Processes the content with the prompt using a small, fast model\n- Returns the model's response about the content\n- Use this tool when you need to retrieve and analyze web content\n\nUsage notes:\n - IMPORTANT: If an MCP-provided web fetch tool is available, prefer using that tool instead of this one, as it may have fewer restrictions.\n - The URL must be a fully-formed valid URL\n - HTTP URLs will be automatically upgraded to HTTPS\n - The prompt should describe what information you want to extract from the page\n - This tool is read-only and does not modify any files\n - Results may be summarized if the content is very large\n - Includes a self-cleaning 15-minute cache for faster responses when repeatedly accessing the same URL\n - When a URL redirects to a different host, the tool will inform you and provide the redirect URL in a special format. You should then make a new WebFetch request with the redirect URL to fetch the content.\n - For GitHub URLs, prefer using the gh CLI via Bash instead (e.g., gh pr view, gh issue view, gh api).\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"url": { |
|
"description": "The URL to fetch content from", |
|
"type": "string", |
|
"format": "uri" |
|
}, |
|
"prompt": { |
|
"description": "The prompt to run on the fetched content", |
|
"type": "string" |
|
} |
|
}, |
|
"required": [ |
|
"url", |
|
"prompt" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "WebSearch", |
|
"description": "\n- Allows Claude to search the web and use the results to inform responses\n- Provides up-to-date information for current events and recent data\n- Returns search result information formatted as search result blocks, including links as markdown hyperlinks\n- Use this tool for accessing information beyond Claude's knowledge cutoff\n- Searches are performed automatically within a single API call\n\nCRITICAL REQUIREMENT - You MUST follow this:\n - After answering the user's question, you MUST include a \"Sources:\" section at the end of your response\n - In the Sources section, list all relevant URLs from the search results as markdown hyperlinks: [Title](URL)\n - This is MANDATORY - never skip including sources in your response\n - Example format:\n\n [Your answer here]\n\n Sources:\n - [Source Title 1](https://example.com/1)\n - [Source Title 2](https://example.com/2)\n\nUsage notes:\n - Domain filtering is supported to include or block specific websites\n - Web search is only available in the US\n\nIMPORTANT - Use the correct year in search queries:\n - The current month is March 2026. You MUST use this year when searching for recent information, documentation, or current events.\n - Example: If the user asks for \"latest React docs\", search for \"React documentation\" with the current year, NOT last year\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"query": { |
|
"description": "The search query to use", |
|
"type": "string", |
|
"minLength": 2 |
|
}, |
|
"allowed_domains": { |
|
"description": "Only include search results from these domains", |
|
"type": "array", |
|
"items": { |
|
"type": "string" |
|
} |
|
}, |
|
"blocked_domains": { |
|
"description": "Never include search results from these domains", |
|
"type": "array", |
|
"items": { |
|
"type": "string" |
|
} |
|
} |
|
}, |
|
"required": [ |
|
"query" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "TaskStop", |
|
"description": "\n- Stops a running background task by its ID\n- Takes a task_id parameter identifying the task to stop\n- Returns a success or failure status\n- Use this tool when you need to terminate a long-running task\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"task_id": { |
|
"description": "The ID of the background task to stop", |
|
"type": "string" |
|
}, |
|
"shell_id": { |
|
"description": "Deprecated: use task_id instead", |
|
"type": "string" |
|
} |
|
}, |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "AskUserQuestion", |
|
"description": "Use this tool when you need to ask the user questions during execution. This allows you to:\n1. Gather user preferences or requirements\n2. Clarify ambiguous instructions\n3. Get decisions on implementation choices as you work\n4. Offer choices to the user about what direction to take.\n\nUsage notes:\n- Users will always be able to select \"Other\" to provide custom text input\n- Use multiSelect: true to allow multiple answers to be selected for a question\n- If you recommend a specific option, make that the first option in the list and add \"(Recommended)\" at the end of the label\n\nPlan mode note: In plan mode, use this tool to clarify requirements or choose between approaches BEFORE finalizing your plan. Do NOT use this tool to ask \"Is my plan ready?\" or \"Should I proceed?\" - use ExitPlanMode for plan approval. IMPORTANT: Do not reference \"the plan\" in your questions (e.g., \"Do you have feedback about the plan?\", \"Does the plan look good?\") because the user cannot see the plan in the UI until you call ExitPlanMode. If you need plan approval, use ExitPlanMode instead.\n\nPreview feature:\nUse the optional `preview` field on options when presenting concrete artifacts that users need to visually compare:\n- ASCII mockups of UI layouts or components\n- Code snippets showing different implementations\n- Diagram variations\n- Configuration examples\n\nPreview content is rendered as markdown in a monospace box. Multi-line text with newlines is supported. When any option has a preview, the UI switches to a side-by-side layout with a vertical option list on the left and preview on the right. Do not use previews for simple preference questions where labels and descriptions suffice. Note: previews are only supported for single-select questions (not multiSelect).\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"questions": { |
|
"description": "Questions to ask the user (1-4 questions)", |
|
"minItems": 1, |
|
"maxItems": 4, |
|
"type": "array", |
|
"items": { |
|
"type": "object", |
|
"properties": { |
|
"question": { |
|
"description": "The complete question to ask the user. Should be clear, specific, and end with a question mark. Example: \"Which library should we use for date formatting?\" If multiSelect is true, phrase it accordingly, e.g. \"Which features do you want to enable?\"", |
|
"type": "string" |
|
}, |
|
"header": { |
|
"description": "Very short label displayed as a chip/tag (max 12 chars). Examples: \"Auth method\", \"Library\", \"Approach\".", |
|
"type": "string" |
|
}, |
|
"options": { |
|
"description": "The available choices for this question. Must have 2-4 options. Each option should be a distinct, mutually exclusive choice (unless multiSelect is enabled). There should be no 'Other' option, that will be provided automatically.", |
|
"minItems": 2, |
|
"maxItems": 4, |
|
"type": "array", |
|
"items": { |
|
"type": "object", |
|
"properties": { |
|
"label": { |
|
"description": "The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.", |
|
"type": "string" |
|
}, |
|
"description": { |
|
"description": "Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.", |
|
"type": "string" |
|
}, |
|
"preview": { |
|
"description": "Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.", |
|
"type": "string" |
|
} |
|
}, |
|
"required": [ |
|
"label", |
|
"description" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
"multiSelect": { |
|
"description": "Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.", |
|
"default": false, |
|
"type": "boolean" |
|
} |
|
}, |
|
"required": [ |
|
"question", |
|
"header", |
|
"options", |
|
"multiSelect" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
"answers": { |
|
"description": "User answers collected by the permission component", |
|
"type": "object", |
|
"propertyNames": { |
|
"type": "string" |
|
}, |
|
"additionalProperties": { |
|
"type": "string" |
|
} |
|
}, |
|
"annotations": { |
|
"description": "Optional per-question annotations from the user (e.g., notes on preview selections). Keyed by question text.", |
|
"type": "object", |
|
"propertyNames": { |
|
"type": "string" |
|
}, |
|
"additionalProperties": { |
|
"type": "object", |
|
"properties": { |
|
"preview": { |
|
"description": "The preview content of the selected option, if the question used previews.", |
|
"type": "string" |
|
}, |
|
"notes": { |
|
"description": "Free-text notes the user added to their selection.", |
|
"type": "string" |
|
} |
|
}, |
|
"additionalProperties": false |
|
} |
|
}, |
|
"metadata": { |
|
"description": "Optional metadata for tracking and analytics purposes. Not displayed to user.", |
|
"type": "object", |
|
"properties": { |
|
"source": { |
|
"description": "Optional identifier for the source of this question (e.g., \"remember\" for /remember command). Used for analytics tracking.", |
|
"type": "string" |
|
} |
|
}, |
|
"additionalProperties": false |
|
} |
|
}, |
|
"required": [ |
|
"questions" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "Skill", |
|
"description": "Execute a skill within the main conversation\n\nWhen users ask you to perform tasks, check if any of the available skills match. Skills provide specialized capabilities and domain knowledge.\n\nWhen users reference a \"slash command\" or \"/<something>\" (e.g., \"/commit\", \"/review-pr\"), they are referring to a skill. Use this tool to invoke it.\n\nHow to invoke:\n- Use this tool with the skill name and optional arguments\n- Examples:\n - `skill: \"pdf\"` - invoke the pdf skill\n - `skill: \"commit\", args: \"-m 'Fix bug'\"` - invoke with arguments\n - `skill: \"review-pr\", args: \"123\"` - invoke with arguments\n - `skill: \"ms-office-suite:pdf\"` - invoke using fully qualified name\n\nImportant:\n- Available skills are listed in system-reminder messages in the conversation\n- When a skill matches the user's request, this is a BLOCKING REQUIREMENT: invoke the relevant Skill tool BEFORE generating any other response about the task\n- NEVER mention a skill without actually calling this tool\n- Do not invoke a skill that is already running\n- Do not use this tool for built-in CLI commands (like /help, /clear, etc.)\n- If you see a <command-name> tag in the current conversation turn, the skill has ALREADY been loaded - follow the instructions directly instead of calling this tool again\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"skill": { |
|
"description": "The skill name. E.g., \"commit\", \"review-pr\", or \"pdf\"", |
|
"type": "string" |
|
}, |
|
"args": { |
|
"description": "Optional arguments for the skill", |
|
"type": "string" |
|
} |
|
}, |
|
"required": [ |
|
"skill" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "EnterPlanMode", |
|
"description": "Use this tool proactively when you're about to start a non-trivial implementation task. Getting user sign-off on your approach before writing code prevents wasted effort and ensures alignment. This tool transitions you into plan mode where you can explore the codebase and design an implementation approach for user approval.\n\n## When to Use This Tool\n\n**Prefer using EnterPlanMode** for implementation tasks unless they're simple. Use it when ANY of these conditions apply:\n\n1. **New Feature Implementation**: Adding meaningful new functionality\n - Example: \"Add a logout button\" - where should it go? What should happen on click?\n - Example: \"Add form validation\" - what rules? What error messages?\n\n2. **Multiple Valid Approaches**: The task can be solved in several different ways\n - Example: \"Add caching to the API\" - could use Redis, in-memory, file-based, etc.\n - Example: \"Improve performance\" - many optimization strategies possible\n\n3. **Code Modifications**: Changes that affect existing behavior or structure\n - Example: \"Update the login flow\" - what exactly should change?\n - Example: \"Refactor this component\" - what's the target architecture?\n\n4. **Architectural Decisions**: The task requires choosing between patterns or technologies\n - Example: \"Add real-time updates\" - WebSockets vs SSE vs polling\n - Example: \"Implement state management\" - Redux vs Context vs custom solution\n\n5. **Multi-File Changes**: The task will likely touch more than 2-3 files\n - Example: \"Refactor the authentication system\"\n - Example: \"Add a new API endpoint with tests\"\n\n6. **Unclear Requirements**: You need to explore before understanding the full scope\n - Example: \"Make the app faster\" - need to profile and identify bottlenecks\n - Example: \"Fix the bug in checkout\" - need to investigate root cause\n\n7. **User Preferences Matter**: The implementation could reasonably go multiple ways\n - If you would use AskUserQuestion to clarify the approach, use EnterPlanMode instead\n - Plan mode lets you explore first, then present options with context\n\n## When NOT to Use This Tool\n\nOnly skip EnterPlanMode for simple tasks:\n- Single-line or few-line fixes (typos, obvious bugs, small tweaks)\n- Adding a single function with clear requirements\n- Tasks where the user has given very specific, detailed instructions\n- Pure research/exploration tasks (use the Agent tool with explore agent instead)\n\n## What Happens in Plan Mode\n\nIn plan mode, you'll:\n1. Thoroughly explore the codebase using Glob, Grep, and Read tools\n2. Understand existing patterns and architecture\n3. Design an implementation approach\n4. Present your plan to the user for approval\n5. Use AskUserQuestion if you need to clarify approaches\n6. Exit plan mode with ExitPlanMode when ready to implement\n\n## Examples\n\n### GOOD - Use EnterPlanMode:\nUser: \"Add user authentication to the app\"\n- Requires architectural decisions (session vs JWT, where to store tokens, middleware structure)\n\nUser: \"Optimize the database queries\"\n- Multiple approaches possible, need to profile first, significant impact\n\nUser: \"Implement dark mode\"\n- Architectural decision on theme system, affects many components\n\nUser: \"Add a delete button to the user profile\"\n- Seems simple but involves: where to place it, confirmation dialog, API call, error handling, state updates\n\nUser: \"Update the error handling in the API\"\n- Affects multiple files, user should approve the approach\n\n### BAD - Don't use EnterPlanMode:\nUser: \"Fix the typo in the README\"\n- Straightforward, no planning needed\n\nUser: \"Add a console.log to debug this function\"\n- Simple, obvious implementation\n\nUser: \"What files handle routing?\"\n- Research task, not implementation planning\n\n## Important Notes\n\n- This tool REQUIRES user approval - they must consent to entering plan mode\n- If unsure whether to use it, err on the side of planning - it's better to get alignment upfront than to redo work\n- Users appreciate being consulted before significant changes are made to their codebase\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": {}, |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "TaskCreate", |
|
"description": "Use this tool to create a structured task list for your current coding session. This helps you track progress, organize complex tasks, and demonstrate thoroughness to the user.\nIt also helps the user understand the progress of the task and overall progress of their requests.\n\n## When to Use This Tool\n\nUse this tool proactively in these scenarios:\n\n- Complex multi-step tasks - When a task requires 3 or more distinct steps or actions\n- Non-trivial and complex tasks - Tasks that require careful planning or multiple operations\n- Plan mode - When using plan mode, create a task list to track the work\n- User explicitly requests todo list - When the user directly asks you to use the todo list\n- User provides multiple tasks - When users provide a list of things to be done (numbered or comma-separated)\n- After receiving new instructions - Immediately capture user requirements as tasks\n- When you start working on a task - Mark it as in_progress BEFORE beginning work\n- After completing a task - Mark it as completed and add any new follow-up tasks discovered during implementation\n\n## When NOT to Use This Tool\n\nSkip using this tool when:\n- There is only a single, straightforward task\n- The task is trivial and tracking it provides no organizational benefit\n- The task can be completed in less than 3 trivial steps\n- The task is purely conversational or informational\n\nNOTE that you should not use this tool if there is only one trivial task to do. In this case you are better off just doing the task directly.\n\n## Task Fields\n\n- **subject**: A brief, actionable title in imperative form (e.g., \"Fix authentication bug in login flow\")\n- **description**: Detailed description of what needs to be done, including context and acceptance criteria\n- **activeForm** (optional): Present continuous form shown in the spinner when the task is in_progress (e.g., \"Fixing authentication bug\"). If omitted, the spinner shows the subject instead.\n\nAll tasks are created with status `pending`.\n\n## Tips\n\n- Create tasks with clear, specific subjects that describe the outcome\n- Include enough detail in the description for another agent to understand and complete the task\n- After creating tasks, use TaskUpdate to set up dependencies (blocks/blockedBy) if needed\n- Check TaskList first to avoid creating duplicate tasks\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"subject": { |
|
"description": "A brief title for the task", |
|
"type": "string" |
|
}, |
|
"description": { |
|
"description": "A detailed description of what needs to be done", |
|
"type": "string" |
|
}, |
|
"activeForm": { |
|
"description": "Present continuous form shown in spinner when in_progress (e.g., \"Running tests\")", |
|
"type": "string" |
|
}, |
|
"metadata": { |
|
"description": "Arbitrary metadata to attach to the task", |
|
"type": "object", |
|
"propertyNames": { |
|
"type": "string" |
|
}, |
|
"additionalProperties": {} |
|
} |
|
}, |
|
"required": [ |
|
"subject", |
|
"description" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "TaskGet", |
|
"description": "Use this tool to retrieve a task by its ID from the task list.\n\n## When to Use This Tool\n\n- When you need the full description and context before starting work on a task\n- To understand task dependencies (what it blocks, what blocks it)\n- After being assigned a task, to get complete requirements\n\n## Output\n\nReturns full task details:\n- **subject**: Task title\n- **description**: Detailed requirements and context\n- **status**: 'pending', 'in_progress', or 'completed'\n- **blocks**: Tasks waiting on this one to complete\n- **blockedBy**: Tasks that must complete before this one can start\n\n## Tips\n\n- After fetching a task, verify its blockedBy list is empty before beginning work.\n- Use TaskList to see all tasks in summary form.\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"taskId": { |
|
"description": "The ID of the task to retrieve", |
|
"type": "string" |
|
} |
|
}, |
|
"required": [ |
|
"taskId" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "TaskUpdate", |
|
"description": "Use this tool to update a task in the task list.\n\n## When to Use This Tool\n\n**Mark tasks as resolved:**\n- When you have completed the work described in a task\n- When a task is no longer needed or has been superseded\n- IMPORTANT: Always mark your assigned tasks as resolved when you finish them\n- After resolving, call TaskList to find your next task\n\n- ONLY mark a task as completed when you have FULLY accomplished it\n- If you encounter errors, blockers, or cannot finish, keep the task as in_progress\n- When blocked, create a new task describing what needs to be resolved\n- Never mark a task as completed if:\n - Tests are failing\n - Implementation is partial\n - You encountered unresolved errors\n - You couldn't find necessary files or dependencies\n\n**Delete tasks:**\n- When a task is no longer relevant or was created in error\n- Setting status to `deleted` permanently removes the task\n\n**Update task details:**\n- When requirements change or become clearer\n- When establishing dependencies between tasks\n\n## Fields You Can Update\n\n- **status**: The task status (see Status Workflow below)\n- **subject**: Change the task title (imperative form, e.g., \"Run tests\")\n- **description**: Change the task description\n- **activeForm**: Present continuous form shown in spinner when in_progress (e.g., \"Running tests\")\n- **owner**: Change the task owner (agent name)\n- **metadata**: Merge metadata keys into the task (set a key to null to delete it)\n- **addBlocks**: Mark tasks that cannot start until this one completes\n- **addBlockedBy**: Mark tasks that must complete before this one can start\n\n## Status Workflow\n\nStatus progresses: `pending` → `in_progress` → `completed`\n\nUse `deleted` to permanently remove a task.\n\n## Staleness\n\nMake sure to read a task's latest state using `TaskGet` before updating it.\n\n## Examples\n\nMark task as in progress when starting work:\n```json\n{\"taskId\": \"1\", \"status\": \"in_progress\"}\n```\n\nMark task as completed after finishing work:\n```json\n{\"taskId\": \"1\", \"status\": \"completed\"}\n```\n\nDelete a task:\n```json\n{\"taskId\": \"1\", \"status\": \"deleted\"}\n```\n\nClaim a task by setting owner:\n```json\n{\"taskId\": \"1\", \"owner\": \"my-name\"}\n```\n\nSet up task dependencies:\n```json\n{\"taskId\": \"2\", \"addBlockedBy\": [\"1\"]}\n```\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"taskId": { |
|
"description": "The ID of the task to update", |
|
"type": "string" |
|
}, |
|
"subject": { |
|
"description": "New subject for the task", |
|
"type": "string" |
|
}, |
|
"description": { |
|
"description": "New description for the task", |
|
"type": "string" |
|
}, |
|
"activeForm": { |
|
"description": "Present continuous form shown in spinner when in_progress (e.g., \"Running tests\")", |
|
"type": "string" |
|
}, |
|
"status": { |
|
"description": "New status for the task", |
|
"anyOf": [ |
|
{ |
|
"type": "string", |
|
"enum": [ |
|
"pending", |
|
"in_progress", |
|
"completed" |
|
] |
|
}, |
|
{ |
|
"type": "string", |
|
"const": "deleted" |
|
} |
|
] |
|
}, |
|
"addBlocks": { |
|
"description": "Task IDs that this task blocks", |
|
"type": "array", |
|
"items": { |
|
"type": "string" |
|
} |
|
}, |
|
"addBlockedBy": { |
|
"description": "Task IDs that block this task", |
|
"type": "array", |
|
"items": { |
|
"type": "string" |
|
} |
|
}, |
|
"owner": { |
|
"description": "New owner for the task", |
|
"type": "string" |
|
}, |
|
"metadata": { |
|
"description": "Metadata keys to merge into the task. Set a key to null to delete it.", |
|
"type": "object", |
|
"propertyNames": { |
|
"type": "string" |
|
}, |
|
"additionalProperties": {} |
|
} |
|
}, |
|
"required": [ |
|
"taskId" |
|
], |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "TaskList", |
|
"description": "Use this tool to list all tasks in the task list.\n\n## When to Use This Tool\n\n- To see what tasks are available to work on (status: 'pending', no owner, not blocked)\n- To check overall progress on the project\n- To find tasks that are blocked and need dependencies resolved\n- After completing a task, to check for newly unblocked work or claim the next available task\n- **Prefer working on tasks in ID order** (lowest ID first) when multiple tasks are available, as earlier tasks often set up context for later ones\n\n## Output\n\nReturns a summary of each task:\n- **id**: Task identifier (use with TaskGet, TaskUpdate)\n- **subject**: Brief description of the task\n- **status**: 'pending', 'in_progress', or 'completed'\n- **owner**: Agent ID if assigned, empty if available\n- **blockedBy**: List of open task IDs that must be resolved first (tasks with blockedBy cannot be claimed until dependencies resolve)\n\nUse TaskGet with a specific task ID to view full details including description and comments.\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": {}, |
|
"additionalProperties": false |
|
} |
|
}, |
|
{ |
|
"name": "EnterWorktree", |
|
"description": "Use this tool ONLY when the user explicitly asks to work in a worktree. This tool creates an isolated git worktree and switches the current session into it.\n\n## When to Use\n\n- The user explicitly says \"worktree\" (e.g., \"start a worktree\", \"work in a worktree\", \"create a worktree\", \"use a worktree\")\n\n## When NOT to Use\n\n- The user asks to create a branch, switch branches, or work on a different branch — use git commands instead\n- The user asks to fix a bug or work on a feature — use normal git workflow unless they specifically mention worktrees\n- Never use this tool unless the user explicitly mentions \"worktree\"\n\n## Requirements\n\n- Must be in a git repository, OR have WorktreeCreate/WorktreeRemove hooks configured in settings.json\n- Must not already be in a worktree\n\n## Behavior\n\n- In a git repository: creates a new git worktree inside `.claude/worktrees/` with a new branch based on HEAD\n- Outside a git repository: delegates to WorktreeCreate/WorktreeRemove hooks for VCS-agnostic isolation\n- Switches the session's working directory to the new worktree\n- On session exit, the user will be prompted to keep or remove the worktree\n\n## Parameters\n\n- `name` (optional): A name for the worktree. If not provided, a random name is generated.\n", |
|
"input_schema": { |
|
"$schema": "https://json-schema.org/draft/2020-12/schema", |
|
"type": "object", |
|
"properties": { |
|
"name": { |
|
"description": "Optional name for the worktree. A random name is generated if not provided.", |
|
"type": "string" |
|
} |
|
}, |
|
"additionalProperties": false |
|
} |
|
} |
|
] |
