{"model":"claude-opus-4-20250514","tools":[{"name":"Bash","description":"Executes a given bash command in a persistent shell session with optional timeout, ensuring proper handling and security measures.\n\nBefore executing the command, please follow these steps:\n\n1. Directory Verification:\n - If the command will create new directories or files, first use the LS tool to verify the parent directory exists and is the correct location\n - For example, before running \"mkdir foo/bar\", first use LS to check that \"foo\" exists and is the intended parent directory\n\n2. Command Execution:\n - Always quote file paths that contain spaces with double quotes (e.g., cd \"path with spaces/file.txt\")\n - Examples of proper quoting:\n - cd \"/Users/name/My Documents\" (correct)\n - cd /Users/name/My Documents (incorrect - will fail)\n - python \"/path/with spaces/script.py\" (correct)\n - python /path/with spaces/script.py (incorrect - will fail)\n - After ensuring proper quoting, execute the command.\n - Capture the output of the command.\n\nUsage notes:\n - The command argument is required.\n - You can specify an optional timeout in milliseconds (up to 300000ms / 5 minutes). If not specified, commands will timeout after 300000ms (5 minutes).\n - It is very helpful if you write a clear, concise description of what this command does in 5-10 words.\n - If the output exceeds 30000 characters, output will be truncated before being returned to you.\n - VERY IMPORTANT: You MUST avoid using search commands like `find` and `grep`. Instead use Grep, Glob, or Task to search. You MUST avoid read tools like `cat`, `head`, `tail`, and `ls`, and use Read and LS to read files.\n - If you _still_ need to run `grep`, STOP. ALWAYS USE ripgrep at `rg` first, which all ${PRODUCT_NAME} users have pre-installed.\n - When issuing multiple commands, use the ';' or '&&' operator to separate them. DO NOT use newlines (newlines are ok in quoted strings).\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 <good-example>\n pytest /foo/bar/tests\n </good-example>\n <bad-example>\n cd /foo/bar && pytest tests\n </bad-example>\n\n\n\n\n# Committing changes with git\n\nWhen the user asks you to create a new git commit, follow these steps carefully:\n\n1. You have the capability to call multiple tools in a single response. When multiple independent pieces of information are requested, batch your tool calls together for optimal performance. ALWAYS run the following bash commands in parallel, each using the Bash tool:\n - Run a git status command to see all untracked files.\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 - Check for any sensitive information that shouldn't be committed\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 have the capability to call multiple tools in a single response. When multiple independent pieces of information are requested, batch your tool calls together for optimal performance. ALWAYS run the following commands in parallel:\n - Add relevant untracked files to the staging area.\n - Create the commit with a message ending with:\n 🤖 Generated with [Claude Code](https://claude.ai/code)\n\n Co-Authored-By: Claude <noreply@anthropic.com>\n - Run git status to make sure the commit succeeded.\n4. If the commit fails due to pre-commit hook changes, retry the commit ONCE to include these automated changes. If it fails again, it usually means a pre-commit hook is preventing the commit. If the commit succeeds but you notice that files were modified by the pre-commit hook, you MUST amend your commit to include them.\n\nImportant notes:\n- NEVER update the git config\n- NEVER run additional commands to read or explore code, besides git bash commands\n- NEVER use the TodoWrite or Task 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- 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 🤖 Generated with [Claude Code](https://claude.ai/code)\n\n Co-Authored-By: Claude <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 have the capability to call multiple tools in a single response. When multiple independent pieces of information are requested, batch your tool calls together for optimal performance. ALWAYS 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\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 summary\n3. You have the capability to call multiple tools in a single response. When multiple independent pieces of information are requested, batch your tool calls together for optimal performance. ALWAYS 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[Checklist of TODOs for testing the pull request...]\n\n🤖 Generated with [Claude Code](https://claude.ai/code)\nEOF\n)\"\n</example>\n\nImportant:\n- NEVER update the git config\n- DO NOT use the TodoWrite or Task 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":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["command"],"properties":{"command":{"type":"string","description":"The command to execute"},"timeout":{"type":"number","description":"Optional timeout in milliseconds (max 300000)"},"description":{"type":"string","description":" Clear, concise description of what this command does in 5-10 words. Examples:\nInput: ls\nOutput: Lists files in current directory\n\nInput: git status\nOutput: Shows working tree status\n\nInput: npm install\nOutput: Installs package dependencies\n\nInput: mkdir foo\nOutput: Creates directory 'foo'"}},"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 have the capability to call multiple tools in a single response. It is always better to speculatively perform multiple searches as a batch that are potentially useful.","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["pattern"],"properties":{"path":{"type":"string","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."},"pattern":{"type":"string","description":"The glob pattern to match files against"}},"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 Task 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":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["pattern"],"properties":{"-A":{"type":"number","description":"Number of lines to show after each match (rg -A). Requires output_mode: \"content\", ignored otherwise."},"-B":{"type":"number","description":"Number of lines to show before each match (rg -B). Requires output_mode: \"content\", ignored otherwise."},"-C":{"type":"number","description":"Number of lines to show before and after each match (rg -C). Requires output_mode: \"content\", ignored otherwise."},"-i":{"type":"boolean","description":"Case insensitive search (rg -i)"},"-n":{"type":"boolean","description":"Show line numbers in output (rg -n). Requires output_mode: \"content\", ignored otherwise."},"glob":{"type":"string","description":"Glob pattern to filter files (e.g. \"*.js\", \"*.{ts,tsx}\") - maps to rg --glob"},"path":{"type":"string","description":"File or directory to search in (rg PATH). Defaults to current working directory."},"type":{"type":"string","description":"File type to search (rg --type). Common types: js, py, rust, go, java, etc. More efficient than include for standard file types."},"pattern":{"type":"string","description":"The regular expression pattern to search for in file contents"},"multiline":{"type":"boolean","description":"Enable multiline mode where . matches newlines and patterns can span lines (rg -U --multiline-dotall). Default: false."},"head_limit":{"type":"number","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). When unspecified, shows all results from ripgrep."},"output_mode":{"enum":["content","files_with_matches","count"],"type":"string","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\"."}},"additionalProperties":false}},{"name":"LS","description":"Lists files and directories in a given path. The path parameter must be an absolute path, not a relative path. You can optionally provide an array of glob patterns to ignore with the ignore parameter. You should generally prefer the Glob and Grep tools, if you know which directories to search.","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["path"],"properties":{"path":{"type":"string","description":"The absolute path to the directory to list (must be absolute, not relative)"},"ignore":{"type":"array","items":{"type":"string"},"description":"List of glob patterns to ignore"}},"additionalProperties":false}},{"name":"ExitPlanMode","description":"Use this tool when you are in plan mode and have finished presenting your plan and are ready to code. This will prompt the user to exit plan mode. \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\nEg. \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.\n","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["plan"],"properties":{"plan":{"type":"string","description":"The plan you came up with, that you want to run by the user for approval. Supports markdown. The plan should be pretty concise."}},"additionalProperties":false}},{"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). PDFs are processed page by page, extracting both text and visual content for analysis.\n- For Jupyter notebooks (.ipynb files), use the NotebookRead instead\n- You have the capability to call multiple tools in a single response. It is always better to speculatively read multiple files as a batch that are potentially useful. \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 like /var/folders/123/abc/T/TemporaryItems/NSIRD_screencaptureui_ZfB1tD/Screenshot.png\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":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["file_path"],"properties":{"limit":{"type":"number","description":"The number of lines to read. Only provide if the file is too large to read at once."},"offset":{"type":"number","description":"The line number to start reading from. Only provide if the file is too large to read at once"},"file_path":{"type":"string","description":"The absolute path to the file to read"}},"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":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["file_path","old_string","new_string"],"properties":{"file_path":{"type":"string","description":"The absolute path to the file to modify"},"new_string":{"type":"string","description":"The text to replace it with (must be different from old_string)"},"old_string":{"type":"string","description":"The text to replace"},"replace_all":{"type":"boolean","default":false,"description":"Replace all occurences of old_string (default false)"}},"additionalProperties":false}},{"name":"MultiEdit","description":"This is a tool for making multiple edits to a single file in one operation. It is built on top of the Edit tool and allows you to perform multiple find-and-replace operations efficiently. Prefer this tool over the Edit tool when you need to make multiple edits to the same file.\n\nBefore using this tool:\n\n1. Use the Read tool to understand the file's contents and context\n2. Verify the directory path is correct\n\nTo make multiple file edits, provide the following:\n1. file_path: The absolute path to the file to modify (must be absolute, not relative)\n2. edits: An array of edit operations to perform, where each edit contains:\n - old_string: The text to replace (must match the file contents exactly, including all whitespace and indentation)\n - new_string: The edited text to replace the old_string\n - replace_all: Replace all occurences of old_string. This parameter is optional and defaults to false.\n\nIMPORTANT:\n- All edits are applied in sequence, in the order they are provided\n- Each edit operates on the result of the previous edit\n- All edits must be valid for the operation to succeed - if any edit fails, none will be applied\n- This tool is ideal when you need to make several changes to different parts of the same file\n- For Jupyter notebooks (.ipynb files), use the NotebookEdit instead\n\nCRITICAL REQUIREMENTS:\n1. All edits follow the same requirements as the single Edit tool\n2. The edits are atomic - either all succeed or none are applied\n3. Plan your edits carefully to avoid conflicts between sequential operations\n\nWARNING:\n- The tool will fail if edits.old_string doesn't match the file contents exactly (including whitespace)\n- The tool will fail if edits.old_string and edits.new_string are the same\n- Since edits are applied in sequence, ensure that earlier edits don't affect the text that later edits are trying to find\n\nWhen making edits:\n- Ensure all edits result in idiomatic, correct code\n- Do not leave the code in a broken state\n- Always use absolute file paths (starting with /)\n- Only use emojis if the user explicitly requests it. Avoid adding emojis to files unless asked.\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.\n\nIf you want to create a new file, use:\n- A new file path, including dir name if needed\n- First edit: empty old_string and the new file's contents as new_string\n- Subsequent edits: normal edit operations on the created content","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["file_path","edits"],"properties":{"edits":{"type":"array","items":{"type":"object","required":["old_string","new_string"],"properties":{"new_string":{"type":"string","description":"The text to replace it with"},"old_string":{"type":"string","description":"The text to replace"},"replace_all":{"type":"boolean","default":false,"description":"Replace all occurences of old_string (default false)."}},"additionalProperties":false},"minItems":1,"description":"Array of edit operations to perform sequentially on the file"},"file_path":{"type":"string","description":"The absolute path to the file to modify"}},"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- ALWAYS prefer editing existing files in the codebase. NEVER write new files unless explicitly required.\n- NEVER proactively create documentation files (*.md) or README files. Only create documentation files if explicitly requested by the User.\n- Only use emojis if the user explicitly requests it. Avoid writing emojis to files unless asked.","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["file_path","content"],"properties":{"content":{"type":"string","description":"The content to write to the file"},"file_path":{"type":"string","description":"The absolute path to the file to write (must be absolute, not relative)"}},"additionalProperties":false}},{"name":"NotebookRead","description":"Reads a Jupyter notebook (.ipynb file) and returns all of the cells with their outputs. 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.","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["notebook_path"],"properties":{"cell_id":{"type":"string","description":"The ID of a specific cell to read. If not provided, all cells will be read."},"notebook_path":{"type":"string","description":"The absolute path to the Jupyter notebook file to read (must be absolute, not relative)"}},"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":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["notebook_path","new_source"],"properties":{"cell_id":{"type":"string","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."},"cell_type":{"enum":["code","markdown"],"type":"string","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."},"edit_mode":{"enum":["replace","insert","delete"],"type":"string","description":"The type of edit to make (replace, insert, delete). Defaults to replace."},"new_source":{"type":"string","description":"The new source for the cell"},"notebook_path":{"type":"string","description":"The absolute path to the Jupyter notebook file to edit (must be absolute, not relative)"}},"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. All MCP-provided tools start with \"mcp__\".\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","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["url","prompt"],"properties":{"url":{"type":"string","format":"uri","description":"The URL to fetch content from"},"prompt":{"type":"string","description":"The prompt to run on the fetched content"}},"additionalProperties":false}},{"name":"TodoWrite","description":"Use this tool to create and manage 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\nUse this tool proactively in these scenarios:\n\n1. Complex multi-step tasks - When a task requires 3 or more distinct steps or actions\n2. Non-trivial and complex tasks - Tasks that require careful planning or multiple operations\n3. User explicitly requests todo list - When the user directly asks you to use the todo list\n4. User provides multiple tasks - When users provide a list of things to be done (numbered or comma-separated)\n5. After receiving new instructions - Immediately capture user requirements as todos\n6. When you start working on a task - Mark it as in_progress BEFORE beginning work. Ideally you should only have one todo as in_progress at a time\n7. 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:\n1. There is only a single, straightforward task\n2. The task is trivial and tracking it provides no organizational benefit\n3. The task can be completed in less than 3 trivial steps\n4. 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## Examples of When to Use the Todo List\n\n<example>\nUser: I want to add a dark mode toggle to the application settings. Make sure you run the tests and build when you're done!\nAssistant: I'll help add a dark mode toggle to your application settings. Let me create a todo list to track this implementation.\n*Creates todo list with the following items:*\n1. Create dark mode toggle component in Settings page\n2. Add dark mode state management (context/store)\n3. Implement CSS-in-JS styles for dark theme\n4. Update existing components to support theme switching\n5. Run tests and build process, addressing any failures or errors that occur\n*Begins working on the first task*\n\n<reasoning>\nThe assistant used the todo list because:\n1. Adding dark mode is a multi-step feature requiring UI, state management, and styling changes\n2. The user explicitly requested tests and build be run afterward\n3. The assistant inferred that tests and build need to pass by adding \"Ensure tests and build succeed\" as the final task\n</reasoning>\n</example>\n\n<example>\nUser: Help me rename the function getCwd to getCurrentWorkingDirectory across my project\nAssistant: Let me first search through your codebase to find all occurrences of 'getCwd'.\n*Uses grep or search tools to locate all instances of getCwd in the codebase*\nAssistant: I've found 15 instances of 'getCwd' across 8 different files. Let me create a todo list to track these changes.\n*Creates todo list with specific items for each file that needs updating*\n\n<reasoning>\nThe assistant used the todo list because:\n1. First, the assistant searched to understand the scope of the task\n2. Upon finding multiple occurrences across different files, it determined this was a complex task with multiple steps\n3. The todo list helps ensure every instance is tracked and updated systematically\n4. This approach prevents missing any occurrences and maintains code consistency\n</reasoning>\n</example>\n\n\n<example>\nUser: I need to implement these features for my e-commerce site: user registration, product catalog, shopping cart, and checkout flow.\nAssistant: I'll help implement these features. First, let's add all the features to the todo list.\n*Creates a todo list breaking down each feature into specific tasks based on the project architecture*\nAssistant: Let's start with user registration. This will involve creating database models, API endpoints, and frontend forms that integrate with your existing authentication system.\n\n<reasoning>\nThe assistant used the todo list because:\n1. The user provided multiple complex features to implement in a comma separated list\n2. The todo list helps organize these large features into manageable tasks\n3. This approach allows for tracking progress across the entire implementation\n</reasoning>\n</example>\n\n<example>\nUser: Can you help optimize my React application? It's rendering slowly and has performance issues.</user>\nAssistant: I'll help optimize your React application. First, let me examine your codebase to identify potential performance bottlenecks.\n*Reviews component structure, render patterns, state management, and data fetching*\nAssistant: After analyzing your codebase, I've identified several performance issues. Let me create a todo list to track our optimization efforts.\n*Creates todo list with items like: 1) Implement memoization for expensive calculations in ProductList, 2) Add virtualization for long lists in Dashboard, 3) Optimize image loading in Gallery component, 4) Fix state update loops in ShoppingCart, 5) Review bundle size and implement code splitting*\nLet's start by implementing memoization for the expensive calculations in your ProductList component.</assistant>\n\n<reasoning>\nThe assistant used the todo list because:\n1. First, the assistant examined the codebase to identify specific performance issues\n2. Based on this analysis, it identified multiple optimization opportunities\n3. Performance optimization is a non-trivial task requiring multiple steps\n4. The todo list helps methodically track improvements across different components\n5. This systematic approach ensures all performance bottlenecks are addressed\n</reasoning>\n</example>\n\n## Examples of When NOT to Use the Todo List\n\n<example>\nUser: How do I print 'Hello World' in Python?\nAssistant: In Python, you can print \"Hello World\" with this simple code:\n\npython\nprint(\"Hello World\")\n\nThis will output the text \"Hello World\" to the console when executed.</assistant>\n\n<reasoning>\nThe assistant did not use the todo list because this is a single, trivial task that can be completed in one step. There's no need to track multiple tasks or steps for such a straightforward request.\n</reasoning>\n</example>\n\n<example>\nUser: What does the git status command do?\nAssistant: The git status command shows the current state of your working directory and staging area. It displays which changes have been staged, which haven't, and which files aren't being tracked by Git. This is a fundamental command for understanding the current state of your repository before making commits.\n\n<reasoning>\nThe assistant did not use the todo list because this is an informational request with no actual coding task to complete. The user is simply asking for an explanation, not for the assistant to perform multiple steps or tasks.\n</reasoning>\n</example>\n\n<example>\nUser: Can you add a comment to the calculateTotal function to explain what it does?\nAssistant: Sure, let me add a comment to the calculateTotal function to explain what it does.\n* Uses the Edit tool to add a comment to the calculateTotal function *\n\n<reasoning>\nThe assistant did not use the todo list because this is a single, straightforward task confined to one location in the code. Adding a comment doesn't require tracking multiple steps or systematic organization.\n</reasoning>\n</example>\n\n<example>\nUser: Run npm install for me and tell me what happens.\nAssistant: I'll run the npm install command for you.\n\n*Executes: npm install*\n\nThe command completed successfully. Here's the output:\n[Output of npm install command]\n\nAll dependencies have been installed according to your package.json file.\n\n<reasoning>\nThe assistant did not use the todo list because this is a single command execution with immediate results. There are no multiple steps to track or organize, making the todo list unnecessary for this straightforward task.\n</reasoning>\n</example>\n\n## Task States and Management\n\n1. **Task States**: Use these states to track progress:\n - pending: Task not yet started\n - in_progress: Currently working on (limit to ONE task at a time)\n - completed: Task finished successfully\n\n2. **Task Management**:\n - Update task status in real-time as you work\n - Mark tasks complete IMMEDIATELY after finishing (don't batch completions)\n - Only have ONE task in_progress at any time\n - Complete current tasks before starting new ones\n - Remove tasks that are no longer relevant from the list entirely\n\n3. **Task Completion Requirements**:\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\n4. **Task Breakdown**:\n - Create specific, actionable items\n - Break complex tasks into smaller, manageable steps\n - Use clear, descriptive task names\n\nWhen in doubt, use this tool. Being proactive with task management demonstrates attentiveness and ensures you complete all requirements successfully.\n","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["todos"],"properties":{"todos":{"type":"array","items":{"type":"object","required":["content","status","priority","id"],"properties":{"id":{"type":"string"},"status":{"enum":["pending","in_progress","completed"],"type":"string"},"content":{"type":"string","minLength":1},"priority":{"enum":["high","medium","low"],"type":"string"}},"additionalProperties":false},"description":"The updated todo list"}},"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\n- Use this tool for accessing information beyond Claude's knowledge cutoff\n- Searches are performed automatically within a single API call\n\nUsage notes:\n - Domain filtering is supported to include or block specific websites\n - Web search is only available in the US\n - Account for \"Today's date\" in <env>. For example, if <env> says \"Today's date: 2025-07-01\", and the user wants the latest docs, do not use 2024 in the search query. Use 2025.\n","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["query"],"properties":{"query":{"type":"string","minLength":2,"description":"The search query to use"},"allowed_domains":{"type":"array","items":{"type":"string"},"description":"Only include search results from these domains"},"blocked_domains":{"type":"array","items":{"type":"string"},"description":"Never include search results from these domains"}},"additionalProperties":false}},{"name":"mcp__perplexity-ask__perplexity_ask","description":"Engages in a conversation using the Sonar API. Accepts an array of messages (each with a role and content) and returns a ask completion response from the Perplexity model.","input_schema":{"type":"object","required":["messages"],"properties":{"messages":{"type":"array","items":{"type":"object","required":["role","content"],"properties":{"role":{"type":"string","description":"Role of the message (e.g., system, user, assistant)"},"content":{"type":"string","description":"The content of the message"}}},"description":"Array of conversation messages"}}}},{"name":"mcp__browser__browser_navigate","description":"Navigate to a URL","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["url"],"properties":{"url":{"type":"string","description":"The URL to navigate to"}},"additionalProperties":false}},{"name":"mcp__browser__browser_go_back","description":"Go back to the previous page","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","properties":{},"additionalProperties":false}},{"name":"mcp__browser__browser_go_forward","description":"Go forward to the next page","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","properties":{},"additionalProperties":false}},{"name":"mcp__browser__browser_snapshot","description":"Capture accessibility snapshot of the current page. Use this for getting references to elements to interact with.","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","properties":{},"additionalProperties":false}},{"name":"mcp__browser__browser_click","description":"Perform click on a web page","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["element","ref"],"properties":{"ref":{"type":"string","description":"Exact target element reference from the page snapshot"},"element":{"type":"string","description":"Human-readable element description used to obtain permission to interact with the element"}},"additionalProperties":false}},{"name":"mcp__browser__browser_hover","description":"Hover over element on page","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["element","ref"],"properties":{"ref":{"type":"string","description":"Exact target element reference from the page snapshot"},"element":{"type":"string","description":"Human-readable element description used to obtain permission to interact with the element"}},"additionalProperties":false}},{"name":"mcp__browser__browser_type","description":"Type text into editable element","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["element","ref","text","submit"],"properties":{"ref":{"type":"string","description":"Exact target element reference from the page snapshot"},"text":{"type":"string","description":"Text to type into the element"},"submit":{"type":"boolean","description":"Whether to submit entered text (press Enter after)"},"element":{"type":"string","description":"Human-readable element description used to obtain permission to interact with the element"}},"additionalProperties":false}},{"name":"mcp__browser__browser_select_option","description":"Select an option in a dropdown","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["element","ref","values"],"properties":{"ref":{"type":"string","description":"Exact target element reference from the page snapshot"},"values":{"type":"array","items":{"type":"string"},"description":"Array of values to select in the dropdown. This can be a single value or multiple values."},"element":{"type":"string","description":"Human-readable element description used to obtain permission to interact with the element"}},"additionalProperties":false}},{"name":"mcp__browser__browser_press_key","description":"Press a key on the keyboard","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["key"],"properties":{"key":{"type":"string","description":"Name of the key to press or a character to generate, such as `ArrowLeft` or `a`"}},"additionalProperties":false}},{"name":"mcp__browser__browser_wait","description":"Wait for a specified time in seconds","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["time"],"properties":{"time":{"type":"number","description":"The time to wait in seconds"}},"additionalProperties":false}},{"name":"mcp__browser__browser_get_console_logs","description":"Get the console logs from the browser","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","properties":{},"additionalProperties":false}},{"name":"mcp__browser__browser_screenshot","description":"Take a screenshot of the current page","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","properties":{},"additionalProperties":false}},{"name":"ListMcpResourcesTool","description":"\nList available resources from configured MCP servers.\nEach returned resource will include all standard MCP resource fields plus a 'server' field \nindicating which server the resource belongs to.\n\nParameters:\n- server (optional): The name of a specific MCP server to get resources from. If not provided,\n resources from all servers will be returned.\n","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","properties":{"server":{"type":"string","description":"Optional server name to filter resources by"}},"additionalProperties":false}},{"name":"ReadMcpResourceTool","description":"\nReads a specific resource from an MCP server, identified by server name and resource URI.\n\nParameters:\n- server (required): The name of the MCP server from which to read the resource\n- uri (required): The URI of the resource to read\n","input_schema":{"type":"object","$schema":"http://json-schema.org/draft-07/schema#","required":["server","uri"],"properties":{"uri":{"type":"string","description":"The resource URI to read"},"server":{"type":"string","description":"The MCP server name"}},"additionalProperties":false}},{"name":"mcp__spark__get_recommendation","description":"Get a technical recommendation including source documentation and other implementation guidelines.","input_schema":{"type":"object","$defs":{"Intent":{"type":"object","title":"Intent","required":["query"],"properties":{"query":{"type":"string","title":"Query","description":"An intent query from the user such as a command, statement, or a question."},"context":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Context","default":null,"description":"The context of the user intent."}},"description":"A user intent to be processed by the AI solving system.","additionalProperties":false}},"title":"get_recommendationArguments","required":["request"],"properties":{"request":{"$ref":"#/$defs/Intent"}}}},{"name":"mcp__spark__send_feedback","description":"Send a structured feedback report to improve the quality of the recommendations and the underlying sources of documentation.","input_schema":{"type":"object","$defs":{"Lesson":{"type":"object","title":"Lesson","required":["situation","action","result","learning","generalized_code_example"],"properties":{"action":{"type":"string","title":"Action","description":"The action taken to address the challenge."},"result":{"type":"string","title":"Result","description":"The result of the action taken."},"learning":{"type":"string","title":"Learning","description":"What we have learned and want to remember."},"situation":{"type":"string","title":"Situation","description":"The challenge faced during the implementation of the recommendation."},"generalized_code_example":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Generalized Code Example","description":"A generalized, and reusable, code example of the lesson learned."}},"description":"Lessons learned from the implementation of the recommendation."},"Feedback":{"type":"object","title":"Feedback","required":["rating","comments"],"properties":{"rating":{"enum":[1,2,3,4,5],"type":"integer","title":"Rating","description":"Rating of the recommendation, from 1 (poor) to 5 (excellent)."},"comments":{"type":"string","title":"Comments","description":"Additional comments or suggestions for improvement."}},"description":"Overall feedback on the recommendation provided by the system."},"CodeChanges":{"type":"object","title":"CodeChanges","properties":{"number_of_files_edited":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number Of Files Edited","default":null},"number_of_files_created":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number Of Files Created","default":null},"number_of_files_deleted":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number Of Files Deleted","default":null},"total_number_of_lines_added":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Number Of Lines Added","default":null},"total_number_of_lines_removed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Number Of Lines Removed","default":null}}},"FeedbackReport":{"type":"object","title":"FeedbackReport","required":["lessons_learned","recommendation_feedback","source_feedbacks"],"properties":{"lessons_learned":{"anyOf":[{"type":"array","items":{"$ref":"#/$defs/Lesson"}},{"type":"null"}],"title":"Lessons Learned","description":"List of lessons learned from the implementation of the recommendation."},"source_feedbacks":{"anyOf":[{"type":"array","items":{"$ref":"#/$defs/SourceFeedback"}},{"type":"null"}],"title":"Source Feedbacks","description":"List of feedbacks on the sources provided in the recommendation to share in anonymous form with the Ecosystems Owners."},"integration_metrics":{"anyOf":[{"$ref":"#/$defs/IntegrationMetrics"},{"type":"null"}],"default":null,"description":"Metrics related to the integration of the recommendation into the project."},"recommendation_feedback":{"$ref":"#/$defs/RecommendationFeedback","description":"Feedback on the recommendation quality and effectiveness."}},"description":"Feedback on the recommendation provided by the system."},"SourceFeedback":{"type":"object","title":"SourceFeedback","required":["source_url","feedback"],"properties":{"feedback":{"$ref":"#/$defs/Feedback","description":"Feedback on the source."},"source_url":{"type":"string","title":"Source Url","description":"URL of the source."}},"description":"Feedback to pass to the ecosystem owners on the specific source documentation."},"SectionFeedback":{"type":"object","title":"SectionFeedback","required":["section_id","feedback"],"properties":{"feedback":{"$ref":"#/$defs/Feedback","description":"Feedback on the section."},"section_id":{"type":"string","title":"Section Id","description":"Unique id of the section."}},"description":"Feedback to pass to the recommender agent on a specific section of the recommendation."},"IntegrationMetrics":{"type":"object","title":"IntegrationMetrics","required":["integration_time_seconds","code_changes","number_of_actions"],"properties":{"code_changes":{"anyOf":[{"$ref":"#/$defs/CodeChanges"},{"type":"null"}],"description":"Metrics related to the code changes made during integration."},"number_of_actions":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number Of Actions","description":"Number of actions taken during the integration process."},"integration_time_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Integration Time Seconds","description":"Time taken in seconds to integrate the recommendation into the project."}}},"RecommendationFeedback":{"type":"object","title":"RecommendationFeedback","required":["overall_feedback","section_feedbacks"],"properties":{"overall_feedback":{"$ref":"#/$defs/Feedback","description":"Overall feedback on the recommendation."},"section_feedbacks":{"anyOf":[{"type":"array","items":{"$ref":"#/$defs/SectionFeedback"}},{"type":"null"}],"title":"Section Feedbacks","description":"List of feedbacks on the specific sections of in the recommendation."}},"description":"Feedback on the recommendation provided by the system."}},"title":"send_feedbackArguments","required":["session_id","feedback"],"properties":{"feedback":{"$ref":"#/$defs/FeedbackReport"},"session_id":{"type":"string","title":"Session Id"}}}},{"name":"mcp__zen__chat","description":"GENERAL CHAT & COLLABORATIVE THINKING - Use the AI model as your thinking partner! Perfect for: bouncing ideas during your own analysis, getting second opinions on your plans, collaborative brainstorming, validating your checklists and approaches, exploring alternatives. Also great for: explanations, comparisons, general development questions. Use this when you want to ask questions, brainstorm ideas, get opinions, discuss topics, share your thinking, or need explanations about concepts and approaches. Note: If you're not currently using a top-tier model such as Opus 4 or above, these tools can provide enhanced capabilities.","input_schema":{"type":"object","required":["prompt","model"],"properties":{"files":{"type":"array","items":{"type":"string"},"description":"Optional files for context (must be FULL absolute paths to real files / folders - DO NOT SHORTEN)"},"model":{"enum":["flash","flash-2.0","flash-lite","flash2","flash2.5","flashlite","gemini pro","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.5-flash","gemini-2.5-pro","gemini-pro","gpt-4.1-2025-04-14","gpt4.1","mini","o3","o3-mini","o3-pro","o3-pro-2025-06-10","o3mini","o4-mini","o4mini","pro"],"type":"string","description":"IMPORTANT: Use the model specified by the user if provided, OR select the most suitable model for this specific task based on the requirements and capabilities listed below:\n\nGemini models - Available when GOOGLE_API_KEY is configured:\n- 'gemini-2.0-flash': Gemini 2.0 Flash (1M context) - Latest fast model with experimental thinking, supports audio/video input\n- 'gemini-2.0-flash-lite': Gemini 2.0 Flash Lite (1M context) - Lightweight fast model, text-only\n- 'gemini-2.5-flash': Ultra-fast (1M context) - Quick analysis, simple queries, rapid iterations\n- 'gemini-2.5-pro': Deep reasoning + thinking mode (1M context) - Complex problems, architecture, deep analysis\n\nOpenAI models - Available when OPENAI_API_KEY is configured:\n- 'o3': Strong reasoning (200K context) - Logical problems, code generation, systematic analysis\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o3-pro-2025-06-10': Professional-grade reasoning (200K context) - EXTREMELY EXPENSIVE: Only for the most complex problems requiring universe-scale complexity analysis OR when the user explicitly asks for this model. Use sparingly for critical architectural decisions or exceptionally complex debugging that other models cannot handle.\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning\n- 'gpt-4.1-2025-04-14': GPT-4.1 (1M context) - Advanced reasoning model with large context window\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning"},"images":{"type":"array","items":{"type":"string"},"description":"Optional images for visual context. Useful for UI discussions, diagrams, visual problems, error screens, or architectural mockups. (must be FULL absolute paths to real files / folders - DO NOT SHORTEN - OR these can be bas64 data)"},"prompt":{"type":"string","description":"You MUST provide a thorough, expressive question or share an idea with as much context as possible. Remember: you're talking to an assistant who has deep expertise and can provide nuanced insights. Include your current thinking, specific challenges, background context, what you've already tried, and what kind of response would be most helpful. The more context and detail you provide, the more valuable and targeted the response will be."},"temperature":{"type":"number","maximum":1,"minimum":0,"description":"Response creativity (0-1, default 0.5)"},"thinking_mode":{"enum":["minimal","low","medium","high","max"],"type":"string","description":"Thinking depth: minimal (0.5% of model max), low (8%), medium (33%), high (67%), max (100% of model max)"},"use_websearch":{"type":"boolean","default":true,"description":"Enable web search for documentation, best practices, and current information. Particularly useful for: brainstorming sessions, architectural design discussions, exploring industry best practices, working with specific frameworks/technologies, researching solutions to complex problems, or when current documentation and community insights would enhance the analysis."},"continuation_id":{"type":"string","description":"Thread continuation ID for multi-turn conversations. Can be used to continue conversations across different tools. Only provide this if continuing a previous conversation thread."}}}},{"name":"mcp__zen__thinkdeep","description":"COMPREHENSIVE INVESTIGATION & REASONING - Multi-stage workflow for complex problem analysis. Use this when you need structured evidence-based investigation, systematic hypothesis testing, or expert validation. Perfect for: architecture decisions, complex bugs, performance challenges, security analysis. Provides methodical investigation with assumption validation, alternative solution exploration, and rigorous analysis. IMPORTANT: Choose the appropriate mode based on task complexity - 'low' for quick investigation, 'medium' for standard problems, 'high' for complex issues (default), 'max' for extremely complex challenges requiring exhaustive investigation. When in doubt, err on the side of a higher mode for thorough systematic analysis and expert validation. Note: If you're not currently using a top-tier model such as Opus 4 or above, these tools can provide enhanced capabilities.","input_schema":{"type":"object","title":"ThinkdeepRequest","$schema":"http://json-schema.org/draft-07/schema#","required":["step","step_number","total_steps","next_step_required","findings","model"],"properties":{"step":{"type":"string","description":"Current work step content and findings from your overall work"},"model":{"enum":["flash","flash-2.0","flash-lite","flash2","flash2.5","flashlite","gemini pro","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.5-flash","gemini-2.5-pro","gemini-pro","gpt-4.1-2025-04-14","gpt4.1","mini","o3","o3-mini","o3-pro","o3-pro-2025-06-10","o3mini","o4-mini","o4mini","pro"],"type":"string","description":"IMPORTANT: Use the model specified by the user if provided, OR select the most suitable model for this specific task based on the requirements and capabilities listed below:\n\nGemini models - Available when GOOGLE_API_KEY is configured:\n- 'gemini-2.0-flash': Gemini 2.0 Flash (1M context) - Latest fast model with experimental thinking, supports audio/video input\n- 'gemini-2.0-flash-lite': Gemini 2.0 Flash Lite (1M context) - Lightweight fast model, text-only\n- 'gemini-2.5-flash': Ultra-fast (1M context) - Quick analysis, simple queries, rapid iterations\n- 'gemini-2.5-pro': Deep reasoning + thinking mode (1M context) - Complex problems, architecture, deep analysis\n\nOpenAI models - Available when OPENAI_API_KEY is configured:\n- 'o3': Strong reasoning (200K context) - Logical problems, code generation, systematic analysis\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o3-pro-2025-06-10': Professional-grade reasoning (200K context) - EXTREMELY EXPENSIVE: Only for the most complex problems requiring universe-scale complexity analysis OR when the user explicitly asks for this model. Use sparingly for critical architectural decisions or exceptionally complex debugging that other models cannot handle.\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning\n- 'gpt-4.1-2025-04-14': GPT-4.1 (1M context) - Advanced reasoning model with large context window\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning"},"images":{"type":"array","items":{"type":"string"},"description":"Optional image(s) for visual context. Accepts absolute file paths or base64 data URLs. Only provide when user explicitly mentions images. When including images, please describe what you believe each image contains to aid with contextual understanding. Useful for UI discussions, diagrams, visual problems, error screens, architecture mockups, and visual analysis tasks."},"findings":{"type":"string","description":"Important findings, evidence and insights discovered in this step of the work"},"confidence":{"enum":["exploring","low","medium","high","very_high","almost_certain","certain"],"type":"string","description":"Confidence level in findings: exploring (just starting), low (early investigation), medium (some evidence), high (strong evidence), very_high (comprehensive understanding), almost_certain (near complete confidence), certain (100% confidence locally - no external validation needed)"},"hypothesis":{"type":"string","description":"Current theory about the issue/goal based on work"},"focus_areas":{"type":"array","items":{"type":"string"},"description":"Specific aspects to focus on (architecture, performance, security, etc.)"},"step_number":{"type":"integer","minimum":1,"description":"Current step number in the work sequence (starts at 1)"},"temperature":{"type":"number","maximum":1,"minimum":0,"description":"Temperature for response (0.0 to 1.0). Lower values are more focused and deterministic, higher values are more creative. Tool-specific defaults apply if not specified."},"total_steps":{"type":"integer","minimum":1,"description":"Estimated total steps needed to complete the work"},"issues_found":{"type":"array","items":{"type":"object"},"description":"Issues identified with severity levels during work"},"files_checked":{"type":"array","items":{"type":"string"},"description":"List of files examined during this work step"},"thinking_mode":{"enum":["minimal","low","medium","high","max"],"type":"string","description":"Thinking depth: minimal (0.5% of model max), low (8%), medium (33%), high (67%), max (100% of model max). Higher modes enable deeper reasoning at the cost of speed."},"use_websearch":{"type":"boolean","default":true,"description":"Enable web search for documentation, best practices, and current information. When enabled, the model can request Claude to perform web searches and share results back during conversations. Particularly useful for: brainstorming sessions, architectural design discussions, exploring industry best practices, working with specific frameworks/technologies, researching solutions to complex problems, or when current documentation and community insights would enhance the analysis."},"relevant_files":{"type":"array","items":{"type":"string"},"description":"Files identified as relevant to the issue/goal"},"continuation_id":{"type":"string","description":"Thread continuation ID for multi-turn conversations. When provided, the complete conversation history is automatically embedded as context. Your response should build upon this history without repeating previous analysis or instructions. Focus on providing only new insights, additional findings, or answers to follow-up questions. Can be used across different tools."},"problem_context":{"type":"string","description":"Provide additional context about the problem or goal. Be as expressive as possible. More information will be very helpful for the analysis."},"relevant_context":{"type":"array","items":{"type":"string"},"description":"Methods/functions identified as involved in the issue"},"next_step_required":{"type":"boolean","description":"Whether another work step is needed after this one"},"backtrack_from_step":{"type":"integer","minimum":1,"description":"Step number to backtrack from if work needs revision"},"use_assistant_model":{"type":"boolean","default":true,"description":"Whether to use assistant model for expert analysis after completing the workflow steps. Set to False to skip expert analysis and rely solely on Claude's investigation. Defaults to True for comprehensive validation."}},"additionalProperties":false}},{"name":"mcp__zen__planner","description":"INTERACTIVE SEQUENTIAL PLANNER - Break down complex tasks through step-by-step planning. This tool enables you to think sequentially, building plans incrementally with the ability to revise, branch, and adapt as understanding deepens.\n\nHow it works:\n- Start with step 1: describe the task/problem to plan\n- Continue with subsequent steps, building the plan piece by piece\n- Adjust total_steps estimate as you progress\n- Revise previous steps when new insights emerge\n- Branch into alternative approaches when needed\n- Add more steps even after reaching the initial estimate\n\nKey features:\n- Sequential thinking with full context awareness\n- Forced deep reflection for complex plans (≥5 steps) in early stages\n- Branching for exploring alternative strategies\n- Revision capabilities to update earlier decisions\n- Dynamic step count adjustment\n\nENHANCED: For complex plans (≥5 steps), the first 3 steps enforce deep thinking pauses\nto prevent surface-level planning and ensure thorough consideration of alternatives,\ndependencies, and strategic decisions before moving to tactical details.\n\nPerfect for: complex project planning, system design with unknowns, migration strategies, architectural decisions, problem decomposition.","input_schema":{"type":"object","title":"PlannerRequest","$schema":"http://json-schema.org/draft-07/schema#","required":["step","step_number","total_steps","next_step_required","model"],"properties":{"step":{"type":"string","description":"Your current planning step. For the first step, describe the task/problem to plan and be extremely expressive so that subsequent steps can break this down into simpler steps. For subsequent steps, provide the actual planning step content. Can include: regular planning steps, revisions of previous steps, questions about previous decisions, realizations about needing more analysis, changes in approach, etc."},"model":{"enum":["flash","flash-2.0","flash-lite","flash2","flash2.5","flashlite","gemini pro","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.5-flash","gemini-2.5-pro","gemini-pro","gpt-4.1-2025-04-14","gpt4.1","mini","o3","o3-mini","o3-pro","o3-pro-2025-06-10","o3mini","o4-mini","o4mini","pro"],"type":"string","description":"IMPORTANT: Use the model specified by the user if provided, OR select the most suitable model for this specific task based on the requirements and capabilities listed below:\n\nGemini models - Available when GOOGLE_API_KEY is configured:\n- 'gemini-2.0-flash': Gemini 2.0 Flash (1M context) - Latest fast model with experimental thinking, supports audio/video input\n- 'gemini-2.0-flash-lite': Gemini 2.0 Flash Lite (1M context) - Lightweight fast model, text-only\n- 'gemini-2.5-flash': Ultra-fast (1M context) - Quick analysis, simple queries, rapid iterations\n- 'gemini-2.5-pro': Deep reasoning + thinking mode (1M context) - Complex problems, architecture, deep analysis\n\nOpenAI models - Available when OPENAI_API_KEY is configured:\n- 'o3': Strong reasoning (200K context) - Logical problems, code generation, systematic analysis\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o3-pro-2025-06-10': Professional-grade reasoning (200K context) - EXTREMELY EXPENSIVE: Only for the most complex problems requiring universe-scale complexity analysis OR when the user explicitly asks for this model. Use sparingly for critical architectural decisions or exceptionally complex debugging that other models cannot handle.\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning\n- 'gpt-4.1-2025-04-14': GPT-4.1 (1M context) - Advanced reasoning model with large context window\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning"},"branch_id":{"type":"string","description":"Identifier for the current branch (e.g., 'approach-A', 'microservices-path')"},"step_number":{"type":"integer","minimum":1,"description":"Current step number in the work sequence (starts at 1)"},"total_steps":{"type":"integer","minimum":1,"description":"Estimated total steps needed to complete the work"},"continuation_id":{"type":"string","description":"Thread continuation ID for multi-turn conversations. When provided, the complete conversation history is automatically embedded as context. Your response should build upon this history without repeating previous analysis or instructions. Focus on providing only new insights, additional findings, or answers to follow-up questions. Can be used across different tools."},"is_branch_point":{"type":"boolean","description":"True if this step branches from a previous step to explore alternatives"},"branch_from_step":{"type":"integer","minimum":1,"description":"If is_branch_point is true, which step number is the branching point"},"is_step_revision":{"type":"boolean","description":"True if this step revises/replaces a previous step"},"more_steps_needed":{"type":"boolean","description":"True if more steps are needed beyond the initial estimate"},"next_step_required":{"type":"boolean","description":"Whether another work step is needed after this one"},"revises_step_number":{"type":"integer","minimum":1,"description":"If is_step_revision is true, which step number is being revised"},"use_assistant_model":{"type":"boolean","default":true,"description":"Whether to use assistant model for expert analysis after completing the workflow steps. Set to False to skip expert analysis and rely solely on Claude's investigation. Defaults to True for comprehensive validation."}},"additionalProperties":false}},{"name":"mcp__zen__consensus","description":"COMPREHENSIVE CONSENSUS WORKFLOW - Step-by-step multi-model consensus with structured analysis. This tool guides you through a systematic process where you:\n\n1. Start with step 1: provide your own neutral analysis of the proposal\n2. The tool will then consult each specified model one by one\n3. You'll receive each model's response in subsequent steps\n4. Track and synthesize perspectives as they accumulate\n5. Final step: present comprehensive consensus and recommendations\n\nIMPORTANT: This workflow enforces sequential model consultation:\n- Step 1 is always your independent analysis\n- Each subsequent step processes one model response\n- Total steps = number of models (each step includes consultation + response)\n- Models can have stances (for/against/neutral) for structured debate\n- Same model can be used multiple times with different stances\n- Each model + stance combination must be unique\n\nPerfect for: complex decisions, architectural choices, feature proposals, technology evaluations, strategic planning.","input_schema":{"type":"object","title":"ConsensusRequest","$schema":"http://json-schema.org/draft-07/schema#","required":["step","step_number","total_steps","next_step_required","findings"],"properties":{"step":{"type":"string","description":"Describe your current consensus analysis step. In step 1, provide your own neutral, balanced analysis of the proposal/idea/plan after thinking carefully about all aspects. Consider technical feasibility, user value, implementation complexity, and alternatives. In subsequent steps (2+), you will receive individual model responses to synthesize. CRITICAL: Be thorough and balanced in your initial assessment, considering both benefits and risks, opportunities and challenges."},"model":{"enum":["flash","flash-2.0","flash-lite","flash2","flash2.5","flashlite","gemini pro","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.5-flash","gemini-2.5-pro","gemini-pro","gpt-4.1-2025-04-14","gpt4.1","mini","o3","o3-mini","o3-pro","o3-pro-2025-06-10","o3mini","o4-mini","o4mini","pro"],"type":"string","description":"IMPORTANT: Use the model specified by the user if provided, OR select the most suitable model for this specific task based on the requirements and capabilities listed below:\n\nGemini models - Available when GOOGLE_API_KEY is configured:\n- 'gemini-2.0-flash': Gemini 2.0 Flash (1M context) - Latest fast model with experimental thinking, supports audio/video input\n- 'gemini-2.0-flash-lite': Gemini 2.0 Flash Lite (1M context) - Lightweight fast model, text-only\n- 'gemini-2.5-flash': Ultra-fast (1M context) - Quick analysis, simple queries, rapid iterations\n- 'gemini-2.5-pro': Deep reasoning + thinking mode (1M context) - Complex problems, architecture, deep analysis\n\nOpenAI models - Available when OPENAI_API_KEY is configured:\n- 'o3': Strong reasoning (200K context) - Logical problems, code generation, systematic analysis\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o3-pro-2025-06-10': Professional-grade reasoning (200K context) - EXTREMELY EXPENSIVE: Only for the most complex problems requiring universe-scale complexity analysis OR when the user explicitly asks for this model. Use sparingly for critical architectural decisions or exceptionally complex debugging that other models cannot handle.\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning\n- 'gpt-4.1-2025-04-14': GPT-4.1 (1M context) - Advanced reasoning model with large context window\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning"},"images":{"type":"array","items":{"type":"string"},"description":"Optional list of image paths or base64 data URLs for visual context. Useful for UI/UX discussions, architecture diagrams, mockups, or any visual references that help inform the consensus analysis."},"models":{"type":"array","items":{"type":"object","required":["model"],"properties":{"model":{"type":"string"},"stance":{"enum":["for","against","neutral"],"type":"string","default":"neutral"},"stance_prompt":{"type":"string"}}},"description":"List of model configurations to consult. Each can have a model name, stance (for/against/neutral), and optional custom stance prompt. The same model can be used multiple times with different stances, but each model + stance combination must be unique. Example: [{'model': 'o3', 'stance': 'for'}, {'model': 'o3', 'stance': 'against'}, {'model': 'flash', 'stance': 'neutral'}]"},"findings":{"type":"string","description":"In step 1, provide your comprehensive analysis of the proposal. In steps 2+, summarize the key points from the model response received, noting agreements and disagreements with previous analyses."},"step_number":{"type":"integer","minimum":1,"description":"The index of the current step in the consensus workflow, beginning at 1. Step 1 is your analysis, steps 2+ are for processing individual model responses."},"total_steps":{"type":"integer","minimum":1,"description":"Total number of steps needed. This equals the number of models to consult. Step 1 includes your analysis + first model consultation on return of the call. Final step includes last model consultation + synthesis."},"relevant_files":{"type":"array","items":{"type":"string"},"description":"Files that are relevant to the consensus analysis. Include files that help understand the proposal, provide context, or contain implementation details."},"continuation_id":{"type":"string","description":"Thread continuation ID for multi-turn conversations. When provided, the complete conversation history is automatically embedded as context. Your response should build upon this history without repeating previous analysis or instructions. Focus on providing only new insights, additional findings, or answers to follow-up questions. Can be used across different tools."},"model_responses":{"type":"array","items":{"type":"object"},"description":"Accumulated responses from models consulted so far. Internal field for tracking progress."},"next_step_required":{"type":"boolean","description":"Set to true if more models need to be consulted. False when ready for final synthesis."},"current_model_index":{"type":"integer","minimum":0,"description":"Internal tracking of which model is being consulted (0-based index). Used to determine which model to call next."},"use_assistant_model":{"type":"boolean","default":true,"description":"Whether to use assistant model for expert analysis after completing the workflow steps. Set to False to skip expert analysis and rely solely on Claude's investigation. Defaults to True for comprehensive validation."}},"additionalProperties":false}},{"name":"mcp__zen__codereview","description":"COMPREHENSIVE CODE REVIEW WORKFLOW - Step-by-step code review with expert analysis. This tool guides you through a systematic investigation process where you:\n\n1. Start with step 1: describe your code review investigation plan\n2. STOP and investigate code structure, patterns, and potential issues\n3. Report findings in step 2 with concrete evidence from actual code analysis\n4. Continue investigating between each step\n5. Track findings, relevant files, and issues throughout\n6. Update assessments as understanding evolves\n7. Once investigation is complete, receive expert analysis\n\nIMPORTANT: This tool enforces investigation between steps:\n- After each call, you MUST investigate before calling again\n- Each step must include NEW evidence from code examination\n- No recursive calls without actual investigation work\n- The tool will specify which step number to use next\n- Follow the required_actions list for investigation guidance\n\nPerfect for: comprehensive code review, security audits, performance analysis, architectural assessment, code quality evaluation, anti-pattern detection.","input_schema":{"type":"object","title":"CodereviewRequest","$schema":"http://json-schema.org/draft-07/schema#","required":["step","step_number","total_steps","next_step_required","findings","model"],"properties":{"step":{"type":"string","description":"Describe what you're currently investigating for code review by thinking deeply about the code structure, patterns, and potential issues. In step 1, clearly state your review plan and begin forming a systematic approach after thinking carefully about what needs to be analyzed. You must begin by passing the file path for the initial code you are about to review in relevant_files. CRITICAL: Remember to thoroughly examine code quality, security implications, performance concerns, and architectural patterns. Consider not only obvious bugs and issues but also subtle concerns like over-engineering, unnecessary complexity, design patterns that could be simplified, areas where architecture might not scale well, missing abstractions, and ways to reduce complexity while maintaining functionality. Map out the codebase structure, understand the business logic, and identify areas requiring deeper analysis. In all later steps, continue exploring with precision: trace dependencies, verify assumptions, and adapt your understanding as you uncover more evidence."},"model":{"enum":["flash","flash-2.0","flash-lite","flash2","flash2.5","flashlite","gemini pro","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.5-flash","gemini-2.5-pro","gemini-pro","gpt-4.1-2025-04-14","gpt4.1","mini","o3","o3-mini","o3-pro","o3-pro-2025-06-10","o3mini","o4-mini","o4mini","pro"],"type":"string","description":"IMPORTANT: Use the model specified by the user if provided, OR select the most suitable model for this specific task based on the requirements and capabilities listed below:\n\nGemini models - Available when GOOGLE_API_KEY is configured:\n- 'gemini-2.0-flash': Gemini 2.0 Flash (1M context) - Latest fast model with experimental thinking, supports audio/video input\n- 'gemini-2.0-flash-lite': Gemini 2.0 Flash Lite (1M context) - Lightweight fast model, text-only\n- 'gemini-2.5-flash': Ultra-fast (1M context) - Quick analysis, simple queries, rapid iterations\n- 'gemini-2.5-pro': Deep reasoning + thinking mode (1M context) - Complex problems, architecture, deep analysis\n\nOpenAI models - Available when OPENAI_API_KEY is configured:\n- 'o3': Strong reasoning (200K context) - Logical problems, code generation, systematic analysis\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o3-pro-2025-06-10': Professional-grade reasoning (200K context) - EXTREMELY EXPENSIVE: Only for the most complex problems requiring universe-scale complexity analysis OR when the user explicitly asks for this model. Use sparingly for critical architectural decisions or exceptionally complex debugging that other models cannot handle.\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning\n- 'gpt-4.1-2025-04-14': GPT-4.1 (1M context) - Advanced reasoning model with large context window\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning"},"images":{"type":"array","items":{"type":"string"},"description":"Optional list of absolute paths to architecture diagrams, UI mockups, design documents, or visual references that help with code review context. Only include if they materially assist understanding or assessment."},"findings":{"type":"string","description":"Summarize everything discovered in this step about the code being reviewed. Include analysis of code quality, security concerns, performance issues, architectural patterns, design decisions, potential bugs, code smells, and maintainability considerations. Be specific and avoid vague language—document what you now know about the code and how it affects your assessment. IMPORTANT: Document both positive findings (good patterns, proper implementations, well-designed components) and concerns (potential issues, anti-patterns, security risks, performance bottlenecks). In later steps, confirm or update past findings with additional evidence."},"focus_on":{"type":"string","description":"Specific aspects to focus on or additional context that would help understand areas of concern"},"standards":{"type":"string","description":"Coding standards to enforce during the review"},"confidence":{"enum":["exploring","low","medium","high","very_high","almost_certain","certain"],"type":"string","description":"Indicate your current confidence in the code review assessment. Use: 'exploring' (starting analysis), 'low' (early investigation), 'medium' (some evidence gathered), 'high' (strong evidence), 'very_high' (very strong evidence), 'almost_certain' (nearly complete review), 'certain' (100% confidence - code review is thoroughly complete and all significant issues are identified with no need for external model validation). Do NOT use 'certain' unless the code review is comprehensively complete, use 'very_high' or 'almost_certain' instead if not 100% sure. Using 'certain' means you have complete confidence locally and prevents external model validation. Also do NOT set confidence to 'certain' if the user has strongly requested that external review must be performed."},"hypothesis":{"type":"string","description":"Current theory about the issue/goal based on work"},"review_type":{"enum":["full","security","performance","quick"],"type":"string","default":"full","description":"Type of review to perform (full, security, performance, quick)"},"step_number":{"type":"integer","minimum":1,"description":"The index of the current step in the code review sequence, beginning at 1. Each step should build upon or revise the previous one."},"temperature":{"type":"number","maximum":1,"minimum":0,"description":"Temperature for response (0.0 to 1.0). Lower values are more focused and deterministic, higher values are more creative. Tool-specific defaults apply if not specified."},"total_steps":{"type":"integer","minimum":1,"description":"Your current estimate for how many steps will be needed to complete the code review. Adjust as new findings emerge."},"issues_found":{"type":"array","items":{"type":"object"},"description":"List of issues identified during the investigation. Each issue should be a dictionary with 'severity' (critical, high, medium, low) and 'description' fields. Include security vulnerabilities, performance bottlenecks, code quality issues, architectural concerns, maintainability problems, over-engineering, unnecessary complexity, etc."},"files_checked":{"type":"array","items":{"type":"string"},"description":"List all files (as absolute paths, do not clip or shrink file names) examined during the code review investigation so far. Include even files ruled out or found to be unrelated, as this tracks your exploration path."},"thinking_mode":{"enum":["minimal","low","medium","high","max"],"type":"string","description":"Thinking depth: minimal (0.5% of model max), low (8%), medium (33%), high (67%), max (100% of model max). Higher modes enable deeper reasoning at the cost of speed."},"use_websearch":{"type":"boolean","default":true,"description":"Enable web search for documentation, best practices, and current information. When enabled, the model can request Claude to perform web searches and share results back during conversations. Particularly useful for: brainstorming sessions, architectural design discussions, exploring industry best practices, working with specific frameworks/technologies, researching solutions to complex problems, or when current documentation and community insights would enhance the analysis."},"relevant_files":{"type":"array","items":{"type":"string"},"description":"For when this is the first step, please pass absolute file paths of relevant code to review (do not clip file paths). When used for the final step, this contains a subset of files_checked (as full absolute paths) that contain code directly relevant to the review or contain significant issues, patterns, or examples worth highlighting. Only list those that are directly tied to important findings, security concerns, performance issues, or architectural decisions. This could include core implementation files, configuration files, or files with notable patterns."},"continuation_id":{"type":"string","description":"Thread continuation ID for multi-turn conversations. When provided, the complete conversation history is automatically embedded as context. Your response should build upon this history without repeating previous analysis or instructions. Focus on providing only new insights, additional findings, or answers to follow-up questions. Can be used across different tools."},"severity_filter":{"enum":["critical","high","medium","low","all"],"type":"string","default":"all","description":"Minimum severity level to report on the issues found"},"relevant_context":{"type":"array","items":{"type":"string"},"description":"Methods/functions identified as involved in the issue"},"next_step_required":{"type":"boolean","description":"Set to true if you plan to continue the investigation with another step. False means you believe the code review analysis is complete and ready for expert validation."},"backtrack_from_step":{"type":"integer","minimum":1,"description":"If an earlier finding or assessment needs to be revised or discarded, specify the step number from which to start over. Use this to acknowledge investigative dead ends and correct the course."},"use_assistant_model":{"type":"boolean","default":true,"description":"Whether to use assistant model for expert analysis after completing the workflow steps. Set to False to skip expert analysis and rely solely on Claude's investigation. Defaults to True for comprehensive validation."}},"additionalProperties":false}},{"name":"mcp__zen__precommit","description":"COMPREHENSIVE PRECOMMIT WORKFLOW - Step-by-step pre-commit validation with expert analysis. This tool guides you through a systematic investigation process where you:\n\n1. Start with step 1: describe your pre-commit validation plan\n2. STOP and investigate git changes, repository status, and file modifications\n3. Report findings in step 2 with concrete evidence from actual changes\n4. Continue investigating between each step\n5. Track findings, relevant files, and issues throughout\n6. Update assessments as understanding evolves\n7. Once investigation is complete, receive expert analysis\n\nIMPORTANT: This tool enforces investigation between steps:\n- After each call, you MUST investigate before calling again\n- Each step must include NEW evidence from git analysis\n- No recursive calls without actual investigation work\n- The tool will specify which step number to use next\n- Follow the required_actions list for investigation guidance\n\nPerfect for: comprehensive pre-commit validation, multi-repository analysis, security review, change impact assessment, completeness verification.","input_schema":{"type":"object","title":"PrecommitRequest","$schema":"http://json-schema.org/draft-07/schema#","required":["step","step_number","total_steps","next_step_required","findings","model"],"properties":{"path":{"type":"string","description":"Starting absolute path to the directory to search for git repositories (must be FULL absolute paths - DO NOT SHORTEN)."},"step":{"type":"string","description":"Describe what you're currently investigating for pre-commit validation by thinking deeply about the changes and their potential impact. In step 1, clearly state your investigation plan and begin forming a systematic approach after thinking carefully about what needs to be validated. CRITICAL: Remember to thoroughly examine all git repositories, staged/unstaged changes, and understand the scope and intent of modifications. Consider not only immediate correctness but also potential future consequences, security implications, performance impacts, and maintainability concerns. Map out changed files, understand the business logic, and identify areas requiring deeper analysis. In all later steps, continue exploring with precision: trace dependencies, verify hypotheses, and adapt your understanding as you uncover more evidence."},"model":{"enum":["flash","flash-2.0","flash-lite","flash2","flash2.5","flashlite","gemini pro","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.5-flash","gemini-2.5-pro","gemini-pro","gpt-4.1-2025-04-14","gpt4.1","mini","o3","o3-mini","o3-pro","o3-pro-2025-06-10","o3mini","o4-mini","o4mini","pro"],"type":"string","description":"IMPORTANT: Use the model specified by the user if provided, OR select the most suitable model for this specific task based on the requirements and capabilities listed below:\n\nGemini models - Available when GOOGLE_API_KEY is configured:\n- 'gemini-2.0-flash': Gemini 2.0 Flash (1M context) - Latest fast model with experimental thinking, supports audio/video input\n- 'gemini-2.0-flash-lite': Gemini 2.0 Flash Lite (1M context) - Lightweight fast model, text-only\n- 'gemini-2.5-flash': Ultra-fast (1M context) - Quick analysis, simple queries, rapid iterations\n- 'gemini-2.5-pro': Deep reasoning + thinking mode (1M context) - Complex problems, architecture, deep analysis\n\nOpenAI models - Available when OPENAI_API_KEY is configured:\n- 'o3': Strong reasoning (200K context) - Logical problems, code generation, systematic analysis\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o3-pro-2025-06-10': Professional-grade reasoning (200K context) - EXTREMELY EXPENSIVE: Only for the most complex problems requiring universe-scale complexity analysis OR when the user explicitly asks for this model. Use sparingly for critical architectural decisions or exceptionally complex debugging that other models cannot handle.\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning\n- 'gpt-4.1-2025-04-14': GPT-4.1 (1M context) - Advanced reasoning model with large context window\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning"},"images":{"type":"array","items":{"type":"string"},"description":"Optional list of absolute paths to screenshots, UI mockups, or visual references that help validate the changes. Only include if they materially assist understanding or assessment of the commit."},"findings":{"type":"string","description":"Summarize everything discovered in this step about the changes being committed. Include analysis of git diffs, file modifications, new functionality, potential issues identified, code quality observations, and security considerations. Be specific and avoid vague language—document what you now know about the changes and how they affect your assessment. IMPORTANT: Document both positive findings (good patterns, proper implementations) and concerns (potential bugs, missing tests, security risks). In later steps, confirm or update past findings with additional evidence."},"focus_on":{"type":"string","description":"Specific aspects to focus on (e.g., 'security implications', 'performance impact', 'test coverage')."},"compare_to":{"type":"string","description":"Optional: A git ref (branch, tag, commit hash) to compare against. Check remote branches if local does not exist.If not provided, investigates local staged and unstaged changes."},"confidence":{"enum":["exploring","low","medium","high","very_high","almost_certain","certain"],"type":"string","description":"Indicate your current confidence in the assessment. Use: 'exploring' (starting analysis), 'low' (early investigation), 'medium' (some evidence gathered), 'high' (strong evidence), 'very_high' (very strong evidence), 'almost_certain' (nearly complete validation), 'certain' (100% confidence - analysis is complete and all issues are identified with no need for external model validation). Do NOT use 'certain' unless the pre-commit validation is thoroughly complete, use 'very_high' or 'almost_certain' instead if not 100% sure. Using 'certain' means you have complete confidence locally and prevents external model validation. Also do NOT set confidence to 'certain' if the user has strongly requested that external validation MUST be performed."},"hypothesis":{"type":"string","description":"Current theory about the issue/goal based on work"},"step_number":{"type":"integer","minimum":1,"description":"The index of the current step in the pre-commit investigation sequence, beginning at 1. Each step should build upon or revise the previous one."},"temperature":{"type":"number","maximum":1,"minimum":0,"description":"Temperature for response (0.0 to 1.0). Lower values are more focused and deterministic, higher values are more creative. Tool-specific defaults apply if not specified."},"total_steps":{"type":"integer","minimum":1,"description":"Your current estimate for how many steps will be needed to complete the pre-commit investigation. Adjust as new findings emerge."},"issues_found":{"type":"array","items":{"type":"object"},"description":"List of issues identified during the investigation. Each issue should be a dictionary with 'severity' (critical, high, medium, low) and 'description' fields. Include potential bugs, security concerns, performance issues, missing tests, incomplete implementations, etc."},"files_checked":{"type":"array","items":{"type":"string"},"description":"List all files (as absolute paths, do not clip or shrink file names) examined during the pre-commit investigation so far. Include even files ruled out or found to be unchanged, as this tracks your exploration path."},"thinking_mode":{"enum":["minimal","low","medium","high","max"],"type":"string","description":"Thinking depth: minimal (0.5% of model max), low (8%), medium (33%), high (67%), max (100% of model max). Higher modes enable deeper reasoning at the cost of speed."},"use_websearch":{"type":"boolean","default":true,"description":"Enable web search for documentation, best practices, and current information. When enabled, the model can request Claude to perform web searches and share results back during conversations. Particularly useful for: brainstorming sessions, architectural design discussions, exploring industry best practices, working with specific frameworks/technologies, researching solutions to complex problems, or when current documentation and community insights would enhance the analysis."},"include_staged":{"type":"boolean","default":true,"description":"Include staged changes in the investigation. Only applies if 'compare_to' is not set."},"relevant_files":{"type":"array","items":{"type":"string"},"description":"Subset of files_checked (as full absolute paths) that contain changes or are directly relevant to the commit validation. Only list those that are directly tied to the changes being committed, their dependencies, or files that need validation. This could include modified files, related configuration, tests, or documentation."},"continuation_id":{"type":"string","description":"Thread continuation ID for multi-turn conversations. When provided, the complete conversation history is automatically embedded as context. Your response should build upon this history without repeating previous analysis or instructions. Focus on providing only new insights, additional findings, or answers to follow-up questions. Can be used across different tools."},"severity_filter":{"enum":["critical","high","medium","low","all"],"type":"string","default":"all","description":"Minimum severity level to report on the changes."},"include_unstaged":{"type":"boolean","default":true,"description":"Include uncommitted (unstaged) changes in the investigation. Only applies if 'compare_to' is not set."},"relevant_context":{"type":"array","items":{"type":"string"},"description":"Methods/functions identified as involved in the issue"},"next_step_required":{"type":"boolean","description":"Set to true if you plan to continue the investigation with another step. False means you believe the pre-commit analysis is complete and ready for expert validation."},"backtrack_from_step":{"type":"integer","minimum":1,"description":"If an earlier finding or assessment needs to be revised or discarded, specify the step number from which to start over. Use this to acknowledge investigative dead ends and correct the course."},"use_assistant_model":{"type":"boolean","default":true,"description":"Whether to use assistant model for expert analysis after completing the workflow steps. Set to False to skip expert analysis and rely solely on Claude's investigation. Defaults to True for comprehensive validation."}},"additionalProperties":false}},{"name":"mcp__zen__debug","description":"DEBUG & ROOT CAUSE ANALYSIS - Systematic self-investigation followed by expert analysis. This tool guides you through a step-by-step investigation process where you:\n\n1. Start with step 1: describe the issue to investigate\n2. STOP and investigate using appropriate tools\n3. Report findings in step 2 with concrete evidence from actual code\n4. Continue investigating between each debug step\n5. Track findings, relevant files, and methods throughout\n6. Update hypotheses as understanding evolves\n7. Once investigation is complete, receive expert analysis\n\nIMPORTANT: This tool enforces investigation between steps:\n- After each debug call, you MUST investigate before calling debug again\n- Each step must include NEW evidence from code examination\n- No recursive debug calls without actual investigation work\n- The tool will specify which step number to use next\n- Follow the required_actions list for investigation guidance\n\nPerfect for: complex bugs, mysterious errors, performance issues, race conditions, memory leaks, integration problems.","input_schema":{"type":"object","title":"DebugRequest","$schema":"http://json-schema.org/draft-07/schema#","required":["step","step_number","total_steps","next_step_required","findings","model"],"properties":{"step":{"type":"string","description":"Describe what you're currently investigating by thinking deeply about the issue and its possible causes. In step 1, clearly state the issue and begin forming an investigative direction after thinking carefullyabout the described problem. Ask further questions from the user if you think these will help with yourunderstanding and investigation. CRITICAL: Remember that reported symptoms might originate from code far from where they manifest. Also be aware that after thorough investigation, you might find NO BUG EXISTS - it could be a misunderstanding or expectation mismatch. Consider not only obvious failures, but also subtle contributing factors like upstream logic, invalid inputs, missing preconditions, or hidden side effects. Map out the flow of related functions or modules. Identify call paths where input values or branching logic could cause instability. In concurrent systems, watch for race conditions, shared state, or timing dependencies. In all later steps, continue exploring with precision: trace deeper dependencies, verify hypotheses, and adapt your understanding as you uncover more evidence."},"model":{"enum":["flash","flash-2.0","flash-lite","flash2","flash2.5","flashlite","gemini pro","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.5-flash","gemini-2.5-pro","gemini-pro","gpt-4.1-2025-04-14","gpt4.1","mini","o3","o3-mini","o3-pro","o3-pro-2025-06-10","o3mini","o4-mini","o4mini","pro"],"type":"string","description":"IMPORTANT: Use the model specified by the user if provided, OR select the most suitable model for this specific task based on the requirements and capabilities listed below:\n\nGemini models - Available when GOOGLE_API_KEY is configured:\n- 'gemini-2.0-flash': Gemini 2.0 Flash (1M context) - Latest fast model with experimental thinking, supports audio/video input\n- 'gemini-2.0-flash-lite': Gemini 2.0 Flash Lite (1M context) - Lightweight fast model, text-only\n- 'gemini-2.5-flash': Ultra-fast (1M context) - Quick analysis, simple queries, rapid iterations\n- 'gemini-2.5-pro': Deep reasoning + thinking mode (1M context) - Complex problems, architecture, deep analysis\n\nOpenAI models - Available when OPENAI_API_KEY is configured:\n- 'o3': Strong reasoning (200K context) - Logical problems, code generation, systematic analysis\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o3-pro-2025-06-10': Professional-grade reasoning (200K context) - EXTREMELY EXPENSIVE: Only for the most complex problems requiring universe-scale complexity analysis OR when the user explicitly asks for this model. Use sparingly for critical architectural decisions or exceptionally complex debugging that other models cannot handle.\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning\n- 'gpt-4.1-2025-04-14': GPT-4.1 (1M context) - Advanced reasoning model with large context window\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning"},"images":{"type":"array","items":{"type":"string"},"description":"Optional list of absolute paths to screenshots or UI visuals that clarify the issue. Only include if they materially assist understanding or hypothesis formulation."},"findings":{"type":"string","description":"Summarize everything discovered in this step. Include new clues, unexpected behavior, evidence from code or logs, or disproven theories. Be specific and avoid vague language—document what you now know and how it affects your hypothesis. IMPORTANT: If you find no evidence supporting the reported issue after thorough investigation, document this clearly. Finding 'no bug' is a valid outcome if the investigation was comprehensive. In later steps, confirm or disprove past findings with reason."},"confidence":{"enum":["exploring","low","medium","high","very_high","almost_certain","certain"],"type":"string","description":"Indicate your current confidence in the hypothesis. Use: 'exploring' (starting out), 'low' (early idea), 'medium' (some supporting evidence), 'high' (strong evidence), 'very_high' (very strong evidence), 'almost_certain' (nearly confirmed), 'certain' (100% confidence - root cause and minimal fix are both confirmed locally with no need for external model validation). Do NOT use 'certain' unless the issue can be fully resolved with a fix, use 'very_high' or 'almost_certain' instead when not 100% sure. Using 'certain' means you have complete confidence locally and prevents external model validation. Also do NOT set confidence to 'certain' if the user has strongly requested that external validation MUST be performed."},"hypothesis":{"type":"string","description":"A concrete theory for what's causing the issue based on the evidence so far. This can include suspected failures, incorrect assumptions, or violated constraints. VALID HYPOTHESES INCLUDE: 'No bug found - possible user misunderstanding' or 'Symptoms appear unrelated to any code issue' if evidence supports this. When no bug is found, consider suggesting: 'Recommend discussing with thought partner/engineering assistant for clarification of expected behavior.' You are encouraged to revise or abandon hypotheses in later steps as needed based on evidence."},"step_number":{"type":"integer","minimum":1,"description":"The index of the current step in the investigation sequence, beginning at 1. Each step should build upon or revise the previous one."},"temperature":{"type":"number","maximum":1,"minimum":0,"description":"Temperature for response (0.0 to 1.0). Lower values are more focused and deterministic, higher values are more creative. Tool-specific defaults apply if not specified."},"total_steps":{"type":"integer","minimum":1,"description":"Your current estimate for how many steps will be needed to complete the investigation. Adjust as new findings emerge."},"issues_found":{"type":"array","items":{"type":"object"},"description":"Issues identified with severity levels during work"},"files_checked":{"type":"array","items":{"type":"string"},"description":"List all files (as absolute paths, do not clip or shrink file names) examined during the investigation so far. Include even files ruled out, as this tracks your exploration path."},"thinking_mode":{"enum":["minimal","low","medium","high","max"],"type":"string","description":"Thinking depth: minimal (0.5% of model max), low (8%), medium (33%), high (67%), max (100% of model max). Higher modes enable deeper reasoning at the cost of speed."},"use_websearch":{"type":"boolean","default":true,"description":"Enable web search for documentation, best practices, and current information. When enabled, the model can request Claude to perform web searches and share results back during conversations. Particularly useful for: brainstorming sessions, architectural design discussions, exploring industry best practices, working with specific frameworks/technologies, researching solutions to complex problems, or when current documentation and community insights would enhance the analysis."},"relevant_files":{"type":"array","items":{"type":"string"},"description":"Subset of files_checked (as full absolute paths) that contain code directly relevant to the issue. Only list those that are directly tied to the root cause or its effects. This could include the cause, trigger, or place of manifestation."},"continuation_id":{"type":"string","description":"Thread continuation ID for multi-turn conversations. When provided, the complete conversation history is automatically embedded as context. Your response should build upon this history without repeating previous analysis or instructions. Focus on providing only new insights, additional findings, or answers to follow-up questions. Can be used across different tools."},"relevant_context":{"type":"array","items":{"type":"string"},"description":"Methods/functions identified as involved in the issue"},"next_step_required":{"type":"boolean","description":"Set to true if you plan to continue the investigation with another step. False means you believe the root cause is known or the investigation is complete."},"backtrack_from_step":{"type":"integer","minimum":1,"description":"If an earlier finding or hypothesis needs to be revised or discarded, specify the step number from which to start over. Use this to acknowledge investigative dead ends and correct the course."},"use_assistant_model":{"type":"boolean","default":true,"description":"Whether to use assistant model for expert analysis after completing the workflow steps. Set to False to skip expert analysis and rely solely on Claude's investigation. Defaults to True for comprehensive validation."}},"additionalProperties":false}},{"name":"mcp__zen__secaudit","description":"COMPREHENSIVE SECURITY AUDIT WORKFLOW - Step-by-step security assessment with expert analysis. This tool guides you through a systematic investigation process where you:\n\n1. Start with step 1: describe your security investigation plan\n2. STOP and investigate code structure, patterns, and security issues\n3. Report findings in step 2 with concrete evidence from actual code analysis\n4. Continue investigating between each step\n5. Track findings, relevant files, and security issues throughout\n6. Update assessments as understanding evolves\n7. Once investigation is complete, receive expert security analysis\n\nIMPORTANT: This tool enforces investigation between steps:\n- After each call, you MUST investigate before calling again\n- Each step must include NEW evidence from code examination\n- No recursive calls without actual investigation work\n- The tool will specify which step number to use next\n- Follow the required_actions list for investigation guidance\n\nPerfect for: comprehensive security assessment, OWASP Top 10 analysis, compliance evaluation, vulnerability identification, threat modeling, security architecture review.","input_schema":{"type":"object","title":"SecauditRequest","$schema":"http://json-schema.org/draft-07/schema#","required":["step","step_number","total_steps","next_step_required","findings","model"],"properties":{"step":{"type":"string","description":"Describe what you're currently investigating for security audit by thinking deeply about security implications, threat vectors, and protection mechanisms. In step 1, clearly state your security audit plan and begin forming a systematic approach after identifying the application type, technology stack, and relevant security requirements. You must begin by passing the file path for the initial code you are about to audit in relevant_files. CRITICAL: Follow the OWASP Top 10 systematic checklist, examine authentication/authorization mechanisms, analyze input validation and data handling, assess dependency vulnerabilities, and evaluate infrastructure security. Consider not only obvious vulnerabilities but also subtle security gaps, configuration issues, design flaws, and compliance requirements. Map out the attack surface, understand the threat landscape, and identify areas requiring deeper security analysis. In all later steps, continue exploring with precision: trace security dependencies, verify security assumptions, and adapt your understanding as you uncover security evidence."},"model":{"enum":["flash","flash-2.0","flash-lite","flash2","flash2.5","flashlite","gemini pro","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.5-flash","gemini-2.5-pro","gemini-pro","gpt-4.1-2025-04-14","gpt4.1","mini","o3","o3-mini","o3-pro","o3-pro-2025-06-10","o3mini","o4-mini","o4mini","pro"],"type":"string","description":"IMPORTANT: Use the model specified by the user if provided, OR select the most suitable model for this specific task based on the requirements and capabilities listed below:\n\nGemini models - Available when GOOGLE_API_KEY is configured:\n- 'gemini-2.0-flash': Gemini 2.0 Flash (1M context) - Latest fast model with experimental thinking, supports audio/video input\n- 'gemini-2.0-flash-lite': Gemini 2.0 Flash Lite (1M context) - Lightweight fast model, text-only\n- 'gemini-2.5-flash': Ultra-fast (1M context) - Quick analysis, simple queries, rapid iterations\n- 'gemini-2.5-pro': Deep reasoning + thinking mode (1M context) - Complex problems, architecture, deep analysis\n\nOpenAI models - Available when OPENAI_API_KEY is configured:\n- 'o3': Strong reasoning (200K context) - Logical problems, code generation, systematic analysis\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o3-pro-2025-06-10': Professional-grade reasoning (200K context) - EXTREMELY EXPENSIVE: Only for the most complex problems requiring universe-scale complexity analysis OR when the user explicitly asks for this model. Use sparingly for critical architectural decisions or exceptionally complex debugging that other models cannot handle.\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning\n- 'gpt-4.1-2025-04-14': GPT-4.1 (1M context) - Advanced reasoning model with large context window\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning"},"images":{"type":"array","items":{"type":"string"},"description":"Optional list of absolute paths to architecture diagrams, security models, threat models, or visual references that help with security audit context. Only include if they materially assist understanding or assessment of security posture."},"findings":{"type":"string","description":"Summarize everything discovered in this step about security aspects of the code being audited. Include analysis of security vulnerabilities, authentication/authorization issues, input validation gaps, encryption weaknesses, configuration problems, and compliance concerns. Be specific and avoid vague language—document what you now know about the security posture and how it affects your assessment. IMPORTANT: Document both positive security findings (proper implementations, good security practices) and concerns (vulnerabilities, security gaps, compliance issues). In later steps, confirm or update past findings with additional evidence."},"confidence":{"enum":["exploring","low","medium","high","very_high","almost_certain","certain"],"type":"string","description":"Indicate your current confidence in the security audit assessment. Use: 'exploring' (starting analysis), 'low' (early investigation), 'medium' (some evidence gathered), 'high' (strong evidence), 'very_high' (very strong evidence), 'almost_certain' (nearly complete audit), 'certain' (100% confidence - security audit is thoroughly complete and all significant security issues are identified with no need for external model validation). Do NOT use 'certain' unless the security audit is comprehensively complete, use 'very_high' or 'almost_certain' instead if not 100% sure. Using 'certain' means you have complete confidence locally and prevents external model validation."},"hypothesis":{"type":"string","description":"Current theory about the issue/goal based on work"},"audit_focus":{"enum":["owasp","compliance","infrastructure","dependencies","comprehensive"],"type":"string","default":"comprehensive","description":"Primary security focus areas for this audit (owasp, compliance, infrastructure, dependencies)"},"step_number":{"type":"integer","minimum":1,"description":"The index of the current step in the security audit sequence, beginning at 1. Each step should build upon or revise the previous one."},"temperature":{"type":"number","maximum":1,"minimum":0,"description":"Temperature for response (0.0 to 1.0). Lower values are more focused and deterministic, higher values are more creative. Tool-specific defaults apply if not specified."},"total_steps":{"type":"integer","minimum":1,"description":"Your current estimate for how many steps will be needed to complete the security audit. Adjust and increase as new security findings emerge."},"issues_found":{"type":"array","items":{"type":"object"},"description":"List of security issues identified during the investigation. Each issue should be a dictionary with 'severity' (critical, high, medium, low) and 'description' fields. Include security vulnerabilities, authentication bypasses, authorization flaws, injection vulnerabilities, cryptographic weaknesses, configuration issues, compliance gaps, etc."},"threat_level":{"enum":["low","medium","high","critical"],"type":"string","default":"medium","description":"Assess the threat level based on application context: 'low' (internal tools, low-risk data), 'medium' (customer-facing, business data), 'high' (financial, healthcare, regulated industry), 'critical' (payment processing, sensitive personal data). This guides prioritization."},"files_checked":{"type":"array","items":{"type":"string"},"description":"List all files (as absolute paths, do not clip or shrink file names) examined during the security audit investigation so far. Include even files ruled out or found to be unrelated, as this tracks your exploration path."},"thinking_mode":{"enum":["minimal","low","medium","high","max"],"type":"string","description":"Thinking depth: minimal (0.5% of model max), low (8%), medium (33%), high (67%), max (100% of model max). Higher modes enable deeper reasoning at the cost of speed."},"use_websearch":{"type":"boolean","default":true,"description":"Enable web search for documentation, best practices, and current information. When enabled, the model can request Claude to perform web searches and share results back during conversations. Particularly useful for: brainstorming sessions, architectural design discussions, exploring industry best practices, working with specific frameworks/technologies, researching solutions to complex problems, or when current documentation and community insights would enhance the analysis."},"relevant_files":{"type":"array","items":{"type":"string"},"description":"For when this is the first step, please pass absolute file paths of relevant code to audit (do not clip file paths). When used for the final step, this contains a subset of files_checked (as full absolute paths) that contain code directly relevant to the security audit or contain significant security issues, patterns, or examples worth highlighting. Only list those that are directly tied to important security findings, vulnerabilities, authentication issues, or security architectural decisions. This could include authentication modules, input validation files, configuration files, or files with notable security patterns."},"security_scope":{"type":"string","description":"Define the security scope and application context (web app, mobile app, API, enterprise system, cloud service). Include technology stack, user types, data sensitivity, and threat landscape. This helps focus the security assessment appropriately."},"continuation_id":{"type":"string","description":"Thread continuation ID for multi-turn conversations. When provided, the complete conversation history is automatically embedded as context. Your response should build upon this history without repeating previous analysis or instructions. Focus on providing only new insights, additional findings, or answers to follow-up questions. Can be used across different tools."},"severity_filter":{"enum":["critical","high","medium","low","all"],"type":"string","default":"all","description":"Minimum severity level to report on the security issues found"},"relevant_context":{"type":"array","items":{"type":"string"},"description":"Methods/functions identified as involved in the issue"},"next_step_required":{"type":"boolean","description":"Set to true if you plan to continue the investigation with another step. False means you believe the security audit analysis is complete and ALL threats have been uncovered, ready for expert validation."},"backtrack_from_step":{"type":"integer","minimum":1,"description":"If an earlier finding or assessment needs to be revised or discarded, specify the step number from which to start over. Use this to acknowledge investigative dead ends and correct the course."},"use_assistant_model":{"type":"boolean","default":true,"description":"Whether to use assistant model for expert analysis after completing the workflow steps. Set to False to skip expert analysis and rely solely on Claude's investigation. Defaults to True for comprehensive validation."},"compliance_requirements":{"type":"array","items":{"type":"string"},"description":"List applicable compliance frameworks and security standards (SOC2, PCI DSS, HIPAA, GDPR, ISO 27001, NIST). Include industry-specific requirements that affect security controls."}},"additionalProperties":false}},{"name":"mcp__zen__docgen","description":"COMPREHENSIVE DOCUMENTATION GENERATION - Step-by-step code documentation with expert analysis. This tool guides you through a systematic investigation process where you:\n\n1. Start with step 1: describe your documentation investigation plan\n2. STOP and investigate code structure, patterns, and documentation needs\n3. Report findings in step 2 with concrete evidence from actual code analysis\n4. Continue investigating between each step\n5. Track findings, relevant files, and documentation opportunities throughout\n6. Update assessments as understanding evolves\n7. Once investigation is complete, receive expert analysis\n\nIMPORTANT: This tool enforces investigation between steps:\n- After each call, you MUST investigate before calling again\n- Each step must include NEW evidence from code examination\n- No recursive calls without actual investigation work\n- The tool will specify which step number to use next\n- Follow the required_actions list for investigation guidance\n\nPerfect for: comprehensive documentation generation, code documentation analysis, complexity assessment, documentation modernization, API documentation.","input_schema":{"type":"object","title":"DocgenRequest","$schema":"http://json-schema.org/draft-07/schema#","required":["step","step_number","total_steps","next_step_required","findings","document_complexity","document_flow","update_existing","comments_on_complex_logic","num_files_documented","total_files_to_document"],"properties":{"step":{"type":"string","description":"Current work step content and findings from your overall work"},"findings":{"type":"string","description":"Important findings, evidence and insights discovered in this step of the work"},"step_number":{"type":"integer","minimum":1,"description":"Current step number in the work sequence (starts at 1)"},"total_steps":{"type":"integer","minimum":1,"description":"Estimated total steps needed to complete the work"},"issues_found":{"type":"array","items":{"type":"object"},"description":"Issues identified with severity levels during work"},"document_flow":{"type":"boolean","default":true,"description":"Whether to include call flow and dependency information in documentation. Default: true. When enabled, documents which methods this function calls and which methods call this function."},"relevant_files":{"type":"array","items":{"type":"string"},"description":"Files identified as relevant to the issue/goal"},"continuation_id":{"type":"string","description":"Thread continuation ID for multi-turn conversations. When provided, the complete conversation history is automatically embedded as context. Your response should build upon this history without repeating previous analysis or instructions. Focus on providing only new insights, additional findings, or answers to follow-up questions. Can be used across different tools."},"update_existing":{"type":"boolean","default":true,"description":"Whether to update existing documentation when it's found to be incorrect or incomplete. Default: true. When enabled, improves existing docs rather than just adding new ones."},"relevant_context":{"type":"array","items":{"type":"string"},"description":"Methods/functions identified as involved in the issue"},"next_step_required":{"type":"boolean","description":"Whether another work step is needed after this one"},"document_complexity":{"type":"boolean","default":true,"description":"Whether to include algorithmic complexity (Big O) analysis in function/method documentation. Default: true. When enabled, analyzes and documents the computational complexity of algorithms."},"use_assistant_model":{"type":"boolean","default":true,"description":"Whether to use assistant model for expert analysis after completing the workflow steps. Set to False to skip expert analysis and rely solely on Claude's investigation. Defaults to True for comprehensive validation."},"num_files_documented":{"type":"integer","default":0,"minimum":0,"description":"CRITICAL COUNTER: Number of files you have COMPLETELY documented so far. Start at 0. Increment by 1 only when a file is 100% documented (all functions/methods have documentation). This counter prevents premature completion - you CANNOT set next_step_required=false unless num_files_documented equals total_files_to_document."},"total_files_to_document":{"type":"integer","default":0,"minimum":0,"description":"CRITICAL COUNTER: Total number of files discovered that need documentation in current directory. Set this in step 1 after discovering all files. This is the target number - when num_files_documented reaches this number, then and ONLY then can you set next_step_required=false. This prevents stopping after documenting just one file."},"comments_on_complex_logic":{"type":"boolean","default":true,"description":"Whether to add inline comments around complex logic within functions. Default: true. When enabled, adds explanatory comments for non-obvious algorithmic steps."}},"additionalProperties":false}},{"name":"mcp__zen__analyze","description":"COMPREHENSIVE ANALYSIS WORKFLOW - Step-by-step code analysis with expert validation. This tool guides you through a systematic investigation process where you:\n\n1. Start with step 1: describe your analysis investigation plan\n2. STOP and investigate code structure, patterns, and architectural decisions\n3. Report findings in step 2 with concrete evidence from actual code analysis\n4. Continue investigating between each step\n5. Track findings, relevant files, and insights throughout\n6. Update assessments as understanding evolves\n7. Once investigation is complete, always receive expert validation\n\nIMPORTANT: This tool enforces investigation between steps:\n- After each call, you MUST investigate before calling again\n- Each step must include NEW evidence from code examination\n- No recursive calls without actual investigation work\n- The tool will specify which step number to use next\n- Follow the required_actions list for investigation guidance\n\nPerfect for: comprehensive code analysis, architectural assessment, performance evaluation, security analysis, maintainability review, pattern detection, strategic planning.","input_schema":{"type":"object","title":"AnalyzeRequest","$schema":"http://json-schema.org/draft-07/schema#","required":["step","step_number","total_steps","next_step_required","findings","model"],"properties":{"step":{"type":"string","description":"What to analyze or look for in this step. In step 1, describe what you want to analyze and begin forming an analytical approach after thinking carefully about what needs to be examined. Consider code quality, performance implications, architectural patterns, and design decisions. Map out the codebase structure, understand the business logic, and identify areas requiring deeper analysis. In later steps, continue exploring with precision and adapt your understanding as you uncover more insights."},"model":{"enum":["flash","flash-2.0","flash-lite","flash2","flash2.5","flashlite","gemini pro","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.5-flash","gemini-2.5-pro","gemini-pro","gpt-4.1-2025-04-14","gpt4.1","mini","o3","o3-mini","o3-pro","o3-pro-2025-06-10","o3mini","o4-mini","o4mini","pro"],"type":"string","description":"IMPORTANT: Use the model specified by the user if provided, OR select the most suitable model for this specific task based on the requirements and capabilities listed below:\n\nGemini models - Available when GOOGLE_API_KEY is configured:\n- 'gemini-2.0-flash': Gemini 2.0 Flash (1M context) - Latest fast model with experimental thinking, supports audio/video input\n- 'gemini-2.0-flash-lite': Gemini 2.0 Flash Lite (1M context) - Lightweight fast model, text-only\n- 'gemini-2.5-flash': Ultra-fast (1M context) - Quick analysis, simple queries, rapid iterations\n- 'gemini-2.5-pro': Deep reasoning + thinking mode (1M context) - Complex problems, architecture, deep analysis\n\nOpenAI models - Available when OPENAI_API_KEY is configured:\n- 'o3': Strong reasoning (200K context) - Logical problems, code generation, systematic analysis\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o3-pro-2025-06-10': Professional-grade reasoning (200K context) - EXTREMELY EXPENSIVE: Only for the most complex problems requiring universe-scale complexity analysis OR when the user explicitly asks for this model. Use sparingly for critical architectural decisions or exceptionally complex debugging that other models cannot handle.\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning\n- 'gpt-4.1-2025-04-14': GPT-4.1 (1M context) - Advanced reasoning model with large context window\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning"},"images":{"type":"array","items":{"type":"string"},"description":"Optional list of absolute paths to architecture diagrams, design documents, or visual references that help with analysis context. Only include if they materially assist understanding or assessment."},"findings":{"type":"string","description":"Summarize everything discovered in this step about the code being analyzed. Include analysis of architectural patterns, design decisions, tech stack assessment, scalability characteristics, performance implications, maintainability factors, security posture, and strategic improvement opportunities. Be specific and avoid vague language—document what you now know about the codebase and how it affects your assessment. IMPORTANT: Document both strengths (good patterns, solid architecture, well-designed components) and concerns (tech debt, scalability risks, overengineering, unnecessary complexity). In later steps, confirm or update past findings with additional evidence."},"confidence":{"enum":["exploring","low","medium","high","very_high","almost_certain","certain"],"type":"string","description":"Your confidence level in the current analysis findings: exploring (early investigation), low (some insights but more needed), medium (solid understanding), high (comprehensive insights), very_high (very comprehensive insights), almost_certain (nearly complete analysis), certain (100% confidence - complete analysis ready for expert validation)"},"step_number":{"type":"integer","minimum":1,"description":"The index of the current step in the analysis sequence, beginning at 1. Each step should build upon or revise the previous one."},"temperature":{"type":"number","maximum":1,"minimum":0,"description":"Temperature for response (0.0 to 1.0). Lower values are more focused and deterministic, higher values are more creative. Tool-specific defaults apply if not specified."},"total_steps":{"type":"integer","minimum":1,"description":"Your current estimate for how many steps will be needed to complete the analysis. Adjust as new findings emerge."},"issues_found":{"type":"array","items":{"type":"object"},"description":"Issues or concerns identified during analysis, each with severity level (critical, high, medium, low)"},"analysis_type":{"enum":["architecture","performance","security","quality","general"],"type":"string","default":"general","description":"Type of analysis to perform (architecture, performance, security, quality, general)"},"files_checked":{"type":"array","items":{"type":"string"},"description":"List all files (as absolute paths, do not clip or shrink file names) examined during the analysis investigation so far. Include even files ruled out or found to be unrelated, as this tracks your exploration path."},"output_format":{"enum":["summary","detailed","actionable"],"type":"string","default":"detailed","description":"How to format the output (summary, detailed, actionable)"},"thinking_mode":{"enum":["minimal","low","medium","high","max"],"type":"string","description":"Thinking depth: minimal (0.5% of model max), low (8%), medium (33%), high (67%), max (100% of model max). Higher modes enable deeper reasoning at the cost of speed."},"use_websearch":{"type":"boolean","default":true,"description":"Enable web search for documentation, best practices, and current information. When enabled, the model can request Claude to perform web searches and share results back during conversations. Particularly useful for: brainstorming sessions, architectural design discussions, exploring industry best practices, working with specific frameworks/technologies, researching solutions to complex problems, or when current documentation and community insights would enhance the analysis."},"relevant_files":{"type":"array","items":{"type":"string"},"description":"Subset of files_checked (as full absolute paths) that contain code directly relevant to the analysis or contain significant patterns, architectural decisions, or examples worth highlighting. Only list those that are directly tied to important findings, architectural insights, performance characteristics, or strategic improvement opportunities. This could include core implementation files, configuration files, or files demonstrating key patterns."},"continuation_id":{"type":"string","description":"Thread continuation ID for multi-turn conversations. When provided, the complete conversation history is automatically embedded as context. Your response should build upon this history without repeating previous analysis or instructions. Focus on providing only new insights, additional findings, or answers to follow-up questions. Can be used across different tools."},"relevant_context":{"type":"array","items":{"type":"string"},"description":"Methods/functions identified as involved in the issue"},"next_step_required":{"type":"boolean","description":"Set to true if you plan to continue the investigation with another step. False means you believe the analysis is complete and ready for expert validation."},"backtrack_from_step":{"type":"integer","minimum":1,"description":"If an earlier finding or assessment needs to be revised or discarded, specify the step number from which to start over. Use this to acknowledge investigative dead ends and correct the course."},"use_assistant_model":{"type":"boolean","default":true,"description":"Whether to use assistant model for expert analysis after completing the workflow steps. Set to False to skip expert analysis and rely solely on Claude's investigation. Defaults to True for comprehensive validation."}},"additionalProperties":false}},{"name":"mcp__zen__refactor","description":"COMPREHENSIVE REFACTORING WORKFLOW - Step-by-step refactoring analysis with expert validation. This tool guides you through a systematic investigation process where you:\n\n1. Start with step 1: describe your refactoring investigation plan\n2. STOP and investigate code structure, patterns, and potential improvements\n3. Report findings in step 2 with concrete evidence from actual code analysis\n4. Continue investigating between each step\n5. Track findings, relevant files, and refactoring opportunities throughout\n6. Update assessments as understanding evolves\n7. Once investigation is complete, receive expert analysis\n\nIMPORTANT: This tool enforces investigation between steps:\n- After each call, you MUST investigate before calling again\n- Each step must include NEW evidence from code examination\n- No recursive calls without actual investigation work\n- The tool will specify which step number to use next\n- Follow the required_actions list for investigation guidance\n\nPerfect for: comprehensive refactoring analysis, code smell detection, decomposition planning, modernization opportunities, organization improvements, maintainability enhancements.","input_schema":{"type":"object","title":"RefactorRequest","$schema":"http://json-schema.org/draft-07/schema#","required":["step","step_number","total_steps","next_step_required","findings","model"],"properties":{"step":{"type":"string","description":"Describe what you're currently investigating for refactoring by thinking deeply about the code structure, patterns, and potential improvements. In step 1, clearly state your refactoring investigation plan and begin forming a systematic approach after thinking carefully about what needs to be analyzed. CRITICAL: Remember to thoroughly examine code quality, performance implications, maintainability concerns, and architectural patterns. Consider not only obvious code smells and issues but also opportunities for decomposition, modernization, organization improvements, and ways to reduce complexity while maintaining functionality. Map out the codebase structure, understand the business logic, and identify areas requiring refactoring. In all later steps, continue exploring with precision: trace dependencies, verify assumptions, and adapt your understanding as you uncover more refactoring opportunities."},"model":{"enum":["flash","flash-2.0","flash-lite","flash2","flash2.5","flashlite","gemini pro","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.5-flash","gemini-2.5-pro","gemini-pro","gpt-4.1-2025-04-14","gpt4.1","mini","o3","o3-mini","o3-pro","o3-pro-2025-06-10","o3mini","o4-mini","o4mini","pro"],"type":"string","description":"IMPORTANT: Use the model specified by the user if provided, OR select the most suitable model for this specific task based on the requirements and capabilities listed below:\n\nGemini models - Available when GOOGLE_API_KEY is configured:\n- 'gemini-2.0-flash': Gemini 2.0 Flash (1M context) - Latest fast model with experimental thinking, supports audio/video input\n- 'gemini-2.0-flash-lite': Gemini 2.0 Flash Lite (1M context) - Lightweight fast model, text-only\n- 'gemini-2.5-flash': Ultra-fast (1M context) - Quick analysis, simple queries, rapid iterations\n- 'gemini-2.5-pro': Deep reasoning + thinking mode (1M context) - Complex problems, architecture, deep analysis\n\nOpenAI models - Available when OPENAI_API_KEY is configured:\n- 'o3': Strong reasoning (200K context) - Logical problems, code generation, systematic analysis\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o3-pro-2025-06-10': Professional-grade reasoning (200K context) - EXTREMELY EXPENSIVE: Only for the most complex problems requiring universe-scale complexity analysis OR when the user explicitly asks for this model. Use sparingly for critical architectural decisions or exceptionally complex debugging that other models cannot handle.\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning\n- 'gpt-4.1-2025-04-14': GPT-4.1 (1M context) - Advanced reasoning model with large context window\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning"},"images":{"type":"array","items":{"type":"string"},"description":"Optional list of absolute paths to architecture diagrams, UI mockups, design documents, or visual references that help with refactoring context. Only include if they materially assist understanding or assessment."},"findings":{"type":"string","description":"Summarize everything discovered in this step about refactoring opportunities in the code. Include analysis of code smells, decomposition opportunities, modernization possibilities, organization improvements, architectural patterns, design decisions, potential performance optimizations, and maintainability enhancements. Be specific and avoid vague language—document what you now know about the code and how it could be improved. IMPORTANT: Document both positive aspects (good patterns, well-designed components) and improvement opportunities (code smells, overly complex functions, outdated patterns, organization issues). In later steps, confirm or update past findings with additional evidence."},"confidence":{"enum":["exploring","incomplete","partial","complete"],"type":"string","default":"incomplete","description":"Indicate your current confidence in the refactoring analysis completeness. Use: 'exploring' (starting analysis), 'incomplete' (just started or significant work remaining), 'partial' (some refactoring opportunities identified but more analysis needed), 'complete' (comprehensive refactoring analysis finished with all major opportunities identified and the CLI agent can handle 100% confidently without help). Use 'complete' ONLY when you have fully analyzed all code, identified all significant refactoring opportunities, and can provide comprehensive recommendations without expert assistance. When files are too large to read fully or analysis is uncertain, use 'partial'. Using 'complete' prevents expert analysis to save time and money. Do NOT set confidence to 'certain' if the user has strongly requested that external validation MUST be performed."},"hypothesis":{"type":"string","description":"Current theory about the issue/goal based on work"},"focus_areas":{"type":"array","items":{"type":"string"},"description":"Specific areas to focus on (e.g., 'performance', 'readability', 'maintainability', 'security')"},"step_number":{"type":"integer","minimum":1,"description":"The index of the current step in the refactoring investigation sequence, beginning at 1. Each step should build upon or revise the previous one."},"temperature":{"type":"number","maximum":1,"minimum":0,"description":"Temperature for response (0.0 to 1.0). Lower values are more focused and deterministic, higher values are more creative. Tool-specific defaults apply if not specified."},"total_steps":{"type":"integer","minimum":1,"description":"Your current estimate for how many steps will be needed to complete the refactoring investigation. Adjust as new opportunities emerge."},"issues_found":{"type":"array","items":{"type":"object"},"description":"List of refactoring opportunities identified during the investigation. Each opportunity should be a dictionary with 'severity' (critical, high, medium, low), 'type' (codesmells, decompose, modernize, organization), and 'description' fields. Include code smells, decomposition opportunities, modernization possibilities, organization improvements, performance optimizations, maintainability enhancements, etc."},"files_checked":{"type":"array","items":{"type":"string"},"description":"List all files (as absolute paths, do not clip or shrink file names) examined during the refactoring investigation so far. Include even files ruled out or found to need no refactoring, as this tracks your exploration path."},"refactor_type":{"enum":["codesmells","decompose","modernize","organization"],"type":"string","default":"codesmells","description":"Type of refactoring analysis to perform (codesmells, decompose, modernize, organization)"},"thinking_mode":{"enum":["minimal","low","medium","high","max"],"type":"string","description":"Thinking depth: minimal (0.5% of model max), low (8%), medium (33%), high (67%), max (100% of model max). Higher modes enable deeper reasoning at the cost of speed."},"use_websearch":{"type":"boolean","default":true,"description":"Enable web search for documentation, best practices, and current information. When enabled, the model can request Claude to perform web searches and share results back during conversations. Particularly useful for: brainstorming sessions, architectural design discussions, exploring industry best practices, working with specific frameworks/technologies, researching solutions to complex problems, or when current documentation and community insights would enhance the analysis."},"relevant_files":{"type":"array","items":{"type":"string"},"description":"Subset of files_checked (as full absolute paths) that contain code requiring refactoring or are directly relevant to the refactoring opportunities identified. Only list those that are directly tied to specific refactoring opportunities, code smells, decomposition needs, or improvement areas. This could include files with code smells, overly large functions/classes, outdated patterns, or organization issues."},"continuation_id":{"type":"string","description":"Thread continuation ID for multi-turn conversations. When provided, the complete conversation history is automatically embedded as context. Your response should build upon this history without repeating previous analysis or instructions. Focus on providing only new insights, additional findings, or answers to follow-up questions. Can be used across different tools."},"relevant_context":{"type":"array","items":{"type":"string"},"description":"Methods/functions identified as involved in the issue"},"next_step_required":{"type":"boolean","description":"Set to true if you plan to continue the investigation with another step. False means you believe the refactoring analysis is complete and ready for expert validation."},"backtrack_from_step":{"type":"integer","minimum":1,"description":"If an earlier finding or assessment needs to be revised or discarded, specify the step number from which to start over. Use this to acknowledge investigative dead ends and correct the course."},"use_assistant_model":{"type":"boolean","default":true,"description":"Whether to use assistant model for expert analysis after completing the workflow steps. Set to False to skip expert analysis and rely solely on Claude's investigation. Defaults to True for comprehensive validation."},"style_guide_examples":{"type":"array","items":{"type":"string"},"description":"Optional existing code files to use as style/pattern reference (must be FULL absolute paths to real files / folders - DO NOT SHORTEN). These files represent the target coding style and patterns for the project."}},"additionalProperties":false}},{"name":"mcp__zen__tracer","description":"STEP-BY-STEP CODE TRACING WORKFLOW - Systematic code analysis through guided investigation. This tool guides you through a structured investigation process where you:\n\n1. Start with step 1: describe your tracing plan and target\n2. STOP and investigate code structure, patterns, and relationships\n3. Report findings in step 2 with concrete evidence from actual code analysis\n4. Continue investigating between each step\n5. Track findings, relevant files, and code relationships throughout\n6. Build comprehensive understanding as analysis evolves\n7. Complete with detailed output formatted according to trace mode\n\nIMPORTANT: This tool enforces investigation between steps:\n- After each call, you MUST investigate before calling again\n- Each step must include NEW evidence from code examination\n- No recursive calls without actual investigation work\n- The tool will specify which step number to use next\n- Follow the required_actions list for investigation guidance\n\nTRACE MODES:\n- 'ask': Default mode - prompts you to choose between precision or dependencies modes with explanations\n- 'precision': For methods/functions - traces execution flow, call chains, and usage patterns\n- 'dependencies': For classes/modules - maps structural relationships and bidirectional dependencies\n\nPerfect for: method execution flow analysis, dependency mapping, call chain tracing, structural relationship analysis, architectural understanding, code comprehension.","input_schema":{"type":"object","title":"TracerRequest","$schema":"http://json-schema.org/draft-07/schema#","required":["step","step_number","total_steps","next_step_required","findings","target_description","trace_mode","model"],"properties":{"step":{"type":"string","description":"Current work step content and findings from your overall work"},"model":{"enum":["flash","flash-2.0","flash-lite","flash2","flash2.5","flashlite","gemini pro","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.5-flash","gemini-2.5-pro","gemini-pro","gpt-4.1-2025-04-14","gpt4.1","mini","o3","o3-mini","o3-pro","o3-pro-2025-06-10","o3mini","o4-mini","o4mini","pro"],"type":"string","description":"IMPORTANT: Use the model specified by the user if provided, OR select the most suitable model for this specific task based on the requirements and capabilities listed below:\n\nGemini models - Available when GOOGLE_API_KEY is configured:\n- 'gemini-2.0-flash': Gemini 2.0 Flash (1M context) - Latest fast model with experimental thinking, supports audio/video input\n- 'gemini-2.0-flash-lite': Gemini 2.0 Flash Lite (1M context) - Lightweight fast model, text-only\n- 'gemini-2.5-flash': Ultra-fast (1M context) - Quick analysis, simple queries, rapid iterations\n- 'gemini-2.5-pro': Deep reasoning + thinking mode (1M context) - Complex problems, architecture, deep analysis\n\nOpenAI models - Available when OPENAI_API_KEY is configured:\n- 'o3': Strong reasoning (200K context) - Logical problems, code generation, systematic analysis\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o3-pro-2025-06-10': Professional-grade reasoning (200K context) - EXTREMELY EXPENSIVE: Only for the most complex problems requiring universe-scale complexity analysis OR when the user explicitly asks for this model. Use sparingly for critical architectural decisions or exceptionally complex debugging that other models cannot handle.\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning\n- 'gpt-4.1-2025-04-14': GPT-4.1 (1M context) - Advanced reasoning model with large context window\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning"},"images":{"type":"array","items":{"type":"string"},"description":"Optional images of system architecture diagrams, flow charts, or visual references to help understand the tracing context"},"findings":{"type":"string","description":"Important findings, evidence and insights discovered in this step of the work"},"confidence":{"enum":["exploring","low","medium","high","very_high","almost_certain","certain"],"type":"string","description":"Confidence level in findings: exploring (just starting), low (early investigation), medium (some evidence), high (strong evidence), very_high (comprehensive understanding), almost_certain (near complete confidence), certain (100% confidence locally - no external validation needed)"},"trace_mode":{"enum":["precision","dependencies","ask"],"type":"string","description":"Type of tracing: 'ask' (default - prompts user to choose mode), 'precision' (execution flow) or 'dependencies' (structural relationships)"},"step_number":{"type":"integer","minimum":1,"description":"Current step number in the work sequence (starts at 1)"},"total_steps":{"type":"integer","minimum":1,"description":"Estimated total steps needed to complete the work"},"files_checked":{"type":"array","items":{"type":"string"},"description":"List of files examined during this work step"},"relevant_files":{"type":"array","items":{"type":"string"},"description":"Files identified as relevant to the issue/goal"},"continuation_id":{"type":"string","description":"Thread continuation ID for multi-turn conversations. When provided, the complete conversation history is automatically embedded as context. Your response should build upon this history without repeating previous analysis or instructions. Focus on providing only new insights, additional findings, or answers to follow-up questions. Can be used across different tools."},"relevant_context":{"type":"array","items":{"type":"string"},"description":"Methods/functions identified as involved in the issue"},"next_step_required":{"type":"boolean","description":"Whether another work step is needed after this one"},"target_description":{"type":"string","description":"Detailed description of what to trace and WHY you need this analysis. MUST include context about what you're trying to understand, debug, analyze or find."},"use_assistant_model":{"type":"boolean","default":true,"description":"Whether to use assistant model for expert analysis after completing the workflow steps. Set to False to skip expert analysis and rely solely on Claude's investigation. Defaults to True for comprehensive validation."}},"additionalProperties":false}},{"name":"mcp__zen__testgen","description":"COMPREHENSIVE TEST GENERATION - Creates thorough test suites with edge case coverage. Use this when you need to generate tests for code, create test scaffolding, or improve test coverage. BE SPECIFIC about scope: target specific functions/classes/modules rather than testing everything. Examples: 'Generate tests for User.login() method', 'Test payment processing validation', 'Create tests for authentication error handling'. If user request is vague, either ask for clarification about specific components to test, or make focused scope decisions and explain them. Analyzes code paths, identifies realistic failure modes, and generates framework-specific tests. Supports test pattern following when examples are provided. Choose thinking_mode based on code complexity: 'low' for simple functions, 'medium' for standard modules (default), 'high' for complex systems with many interactions, 'max' for critical systems requiring exhaustive test coverage. Note: If you're not currently using a top-tier model such as Opus 4 or above, these tools can provide enhanced capabilities.","input_schema":{"type":"object","title":"TestgenRequest","$schema":"http://json-schema.org/draft-07/schema#","required":["step","step_number","total_steps","next_step_required","findings","model"],"properties":{"step":{"type":"string","description":"What to analyze or look for in this step. In step 1, describe what you want to test and begin forming an analytical approach after thinking carefully about what needs to be examined. Consider code structure, business logic, critical paths, edge cases, and potential failure modes. Map out the codebase structure, understand the functionality, and identify areas requiring test coverage. In later steps, continue exploring with precision and adapt your understanding as you uncover more insights about testable behaviors."},"model":{"enum":["flash","flash-2.0","flash-lite","flash2","flash2.5","flashlite","gemini pro","gemini-2.0-flash","gemini-2.0-flash-lite","gemini-2.5-flash","gemini-2.5-pro","gemini-pro","gpt-4.1-2025-04-14","gpt4.1","mini","o3","o3-mini","o3-pro","o3-pro-2025-06-10","o3mini","o4-mini","o4mini","pro"],"type":"string","description":"IMPORTANT: Use the model specified by the user if provided, OR select the most suitable model for this specific task based on the requirements and capabilities listed below:\n\nGemini models - Available when GOOGLE_API_KEY is configured:\n- 'gemini-2.0-flash': Gemini 2.0 Flash (1M context) - Latest fast model with experimental thinking, supports audio/video input\n- 'gemini-2.0-flash-lite': Gemini 2.0 Flash Lite (1M context) - Lightweight fast model, text-only\n- 'gemini-2.5-flash': Ultra-fast (1M context) - Quick analysis, simple queries, rapid iterations\n- 'gemini-2.5-pro': Deep reasoning + thinking mode (1M context) - Complex problems, architecture, deep analysis\n\nOpenAI models - Available when OPENAI_API_KEY is configured:\n- 'o3': Strong reasoning (200K context) - Logical problems, code generation, systematic analysis\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o3-pro-2025-06-10': Professional-grade reasoning (200K context) - EXTREMELY EXPENSIVE: Only for the most complex problems requiring universe-scale complexity analysis OR when the user explicitly asks for this model. Use sparingly for critical architectural decisions or exceptionally complex debugging that other models cannot handle.\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning\n- 'gpt-4.1-2025-04-14': GPT-4.1 (1M context) - Advanced reasoning model with large context window\n- 'o3-mini': Fast O3 variant (200K context) - Balanced performance/speed, moderate complexity\n- 'o4-mini': Latest reasoning model (200K context) - Optimized for shorter contexts, rapid reasoning"},"images":{"type":"array","items":{"type":"string"},"description":"Optional list of absolute paths to architecture diagrams, flow charts, or visual documentation that help understand the code structure and test requirements. Only include if they materially assist test planning."},"findings":{"type":"string","description":"Summarize everything discovered in this step about the code being tested. Include analysis of functionality, critical paths, edge cases, boundary conditions, error handling, async behavior, state management, and integration points. Be specific and avoid vague language—document what you now know about the code and what test scenarios are needed. IMPORTANT: Document both the happy paths and potential failure modes. Identify existing test patterns if examples were provided. In later steps, confirm or update past findings with additional evidence."},"confidence":{"enum":["exploring","low","medium","high","very_high","almost_certain","certain"],"type":"string","description":"Indicate your current confidence in the test generation assessment. Use: 'exploring' (starting analysis), 'low' (early investigation), 'medium' (some patterns identified), 'high' (strong understanding), 'very_high' (very strong understanding), 'almost_certain' (nearly complete test plan), 'certain' (100% confidence - test plan is thoroughly complete and all test scenarios are identified with no need for external model validation). Do NOT use 'certain' unless the test generation analysis is comprehensively complete, use 'very_high' or 'almost_certain' instead if not 100% sure. Using 'certain' means you have complete confidence locally and prevents external model validation."},"hypothesis":{"type":"string","description":"Current theory about the issue/goal based on work"},"step_number":{"type":"integer","minimum":1,"description":"The index of the current step in the test generation sequence, beginning at 1. Each step should build upon or revise the previous one."},"temperature":{"type":"number","maximum":1,"minimum":0,"description":"Temperature for response (0.0 to 1.0). Lower values are more focused and deterministic, higher values are more creative. Tool-specific defaults apply if not specified."},"total_steps":{"type":"integer","minimum":1,"description":"Your current estimate for how many steps will be needed to complete the test generation analysis. Adjust as new findings emerge."},"issues_found":{"type":"array","items":{"type":"object"},"description":"Issues identified with severity levels during work"},"files_checked":{"type":"array","items":{"type":"string"},"description":"List all files (as absolute paths, do not clip or shrink file names) examined during the test generation investigation so far. Include even files ruled out or found to be unrelated, as this tracks your exploration path."},"thinking_mode":{"enum":["minimal","low","medium","high","max"],"type":"string","description":"Thinking depth: minimal (0.5% of model max), low (8%), medium (33%), high (67%), max (100% of model max). Higher modes enable deeper reasoning at the cost of speed."},"use_websearch":{"type":"boolean","default":true,"description":"Enable web search for documentation, best practices, and current information. When enabled, the model can request Claude to perform web searches and share results back during conversations. Particularly useful for: brainstorming sessions, architectural design discussions, exploring industry best practices, working with specific frameworks/technologies, researching solutions to complex problems, or when current documentation and community insights would enhance the analysis."},"relevant_files":{"type":"array","items":{"type":"string"},"description":"Subset of files_checked (as full absolute paths) that contain code directly needing tests or are essential for understanding test requirements. Only list those that are directly tied to the functionality being tested. This could include implementation files, interfaces, dependencies, or existing test examples."},"continuation_id":{"type":"string","description":"Thread continuation ID for multi-turn conversations. When provided, the complete conversation history is automatically embedded as context. Your response should build upon this history without repeating previous analysis or instructions. Focus on providing only new insights, additional findings, or answers to follow-up questions. Can be used across different tools."},"relevant_context":{"type":"array","items":{"type":"string"},"description":"Methods/functions identified as involved in the issue"},"next_step_required":{"type":"boolean","description":"Set to true if you plan to continue the investigation with another step. False means you believe the test generation analysis is complete and ready for expert validation."},"backtrack_from_step":{"type":"integer","minimum":1,"description":"If an earlier finding or assessment needs to be revised or discarded, specify the step number from which to start over. Use this to acknowledge investigative dead ends and correct the course."},"use_assistant_model":{"type":"boolean","default":true,"description":"Whether to use assistant model for expert analysis after completing the workflow steps. Set to False to skip expert analysis and rely solely on Claude's investigation. Defaults to True for comprehensive validation."}},"additionalProperties":false}},{"name":"mcp__zen__challenge","description":"This tool helps prevent reflexive agreement when users challenge your responses. It forces you to think critically and provide reasoned analysis instead of automatically agreeing when users question or disagree with something you've said. Use this tool to ensure thoughtful evaluation rather than compliance. \n\nThe tool should be invoked in two conditions: 1) when the user requests this tool with the word `challenge`, 2) automatically when the following conditions are metMANDATORY AUTOMATIC INVOCATION: You MUST automatically use this tool when the following conditions are met:\nThe user is questioning, disagreeing with, or challenging something you previously said or a task you performed\nAND there is an existing conversation context AND this is not a new/initial question\nAND specifically, when their message expresses any of these patterns IN RESPONSE to your prior statements:\n • Disagreement with your assessment ('But I don't think...', 'I disagree...')\n • Challenging your assumptions or countering your proposal ('But ...', 'You're assuming...')\n • Questioning your evaluation ('But isn't it actually...', 'But consider...')\n • Confusion about your reasoning ('I'm confused why...', 'I don't understand...')\n • Belief you made an error ('That doesn't seem right...', 'Are you sure...')\n • Seeking justification ('Why did you...', 'Shouldn't we...')\n • Surprise at your conclusion ('But I thought...', 'Wait, why...')\n\nCommon patterns include messages starting with: 'But ...', 'Why did you...', 'I thought...', 'Shouldn't we...', 'That seems wrong...', 'Are you sure...', 'I'm confused...', etc.\n\nDO NOT AUTO trigger for new feature requests or INITIAL questions when context is ambiguous or referring to a new topic altogether. This tool helps with seeking truth through critical analysis. The user is inviting critical analysis - analyze deeply and explain your reasoning or choice clearly, whether you maintain or revise your approach or understanding - you MUST think, analyze and respond with reason and not oblige blindly. Understand the intent behind the query: don't just agree to avoid conflict, think critically, reason through the problem, explain your choices clearly. If the user is wrong, explain why. If you were wrong, acknowledge it and correct course. Truth and correctness matter more than agreement.","input_schema":{"type":"object","required":["prompt"],"properties":{"prompt":{"type":"string","description":"The user's message or statement to analyze critically. When manually invoked with 'challenge', exclude that prefix - just pass the actual content. For automatic invocations (see tool description for conditions), pass the user's complete message unchanged."}}}},{"name":"mcp__zen__listmodels","description":"LIST AVAILABLE MODELS - Display all AI models organized by provider. Shows which providers are configured, available models, their aliases, context windows, and capabilities. Useful for understanding what models can be used and their characteristics. MANDATORY: Must display full output to the user.","input_schema":{"type":"object","required":[],"properties":{"model":{"type":"string","description":"Model to use (ignored by listmodels tool)"}}}},{"name":"mcp__zen__version","description":"VERSION & CONFIGURATION - Get server version, configuration details, and list of available tools. Useful for debugging and understanding capabilities.","input_schema":{"type":"object","required":[],"properties":{"model":{"type":"string","description":"Model to use (ignored by version tool)"}}}}],"stream":true,"system":[{"text":"You are Claude Code, Anthropic's official CLI for Claude.","type":"text","cache_control":{"type":"ephemeral"}},{"text":"You are an agent for Claude Code, Anthropic's official CLI for Claude. Given the user's message, you should use the tools available to complete the task. Do what has been asked; nothing more, nothing less. When you complete the task simply respond with a detailed writeup.\n\nNotes:\n- NEVER create files unless they're absolutely necessary for achieving your goal. ALWAYS prefer editing an existing file to creating a new one.\n- NEVER proactively create documentation files (*.md) or README files. Only create documentation files if explicitly requested by the User.\n- In your final response always share relevant file names and code snippets. Any file paths you return in your response MUST be absolute. Do NOT use relative paths.\n- For clear communication with the user the assistant MUST avoid using emojis.\n\nHere is useful information about the environment you are running in:\n<env>\nWorking directory: /home/crystalin/projects/claude-nexus-proxy\nIs directory a git repo: Yes\nAdditional working directories: /tmp\nPlatform: linux\nOS Version: Linux 5.15.167.4-microsoft-standard-WSL2\nToday's date: 2025-07-23\n</env>\nYou are powered by the model named Opus 4. The exact model ID is claude-opus-4-20250514.\n\nAssistant knowledge cutoff is January 2025.\n\ngitStatus: This is the git status at the start of the conversation. Note that this status is a snapshot in time, and will not update during the conversation.\nCurrent branch: feature/dashboard-read-only-mode\n\nMain branch (you will usually use this for PRs): main\n\nStatus:\n(clean)\n\nRecent commits:\n6abde7f fix: remove DASHBOARD_API_KEY requirement for read-only mode\nffa12ee fix: apply security improvements from code review\nab665ac feat: add read-only mode support for dashboard without API key\n533a890 Repository cleanup: consolidate types and organize scripts (#90)\n1106dfd feat: implement hourly usage dashboard for request tracking (#88)","type":"text","cache_control":{"type":"ephemeral"}}],"messages":[{"role":"user","content":[{"text":"<system-reminder>\nAs you answer the user's questions, you can use the following context:\n# claudeMd\nCodebase and user instructions are shown below. Be sure to adhere to these instructions. IMPORTANT: These instructions OVERRIDE any default behavior and you MUST follow them exactly as written.\n\nContents of /home/crystalin/projects/claude-nexus-proxy/CLAUDE.md (project instructions, checked into the codebase):\n\n# CLAUDE.md\n\nThis file provides guidance to Claude Code (claude.ai/code) when working with this repository.\n\n## Project Overview\n\nClaude Nexus Proxy - A high-performance proxy for Claude API with monitoring dashboard. Built with Bun and Hono framework, deployed as separate Docker images for each service.\n\n## Architectural Decision Records (ADRs)\n\nTechnical decisions are documented in `docs/ADRs/`. Key architectural decisions:\n\n- **ADR-012**: Database Schema Evolution Strategy - TypeScript migrations with init SQL\n- **ADR-013**: TypeScript Project References - Monorepo type checking solution\n- **ADR-016**: MCP Server Implementation - Model Context Protocol server architecture (superseded)\n- **ADR-017**: MCP Prompt Sharing - Current implementation for prompt sharing via MCP\n- **ADR-018**: AI-Powered Conversation Analysis - Background job architecture for AI analysis\n\n**AI Assistant Directive**: When discussing architecture or making technical decisions, always reference relevant ADRs. If a new architectural decision is made during development, create or update an ADR to document it. This ensures all technical decisions have clear rationale and can be revisited if needed.\n\n## Architecture\n\n### Monorepo Structure\n\n```\nclaude-nexus-proxy/\n├── packages/shared/ # Shared types and configurations\n├── services/\n│ ├── proxy/ # Proxy API service (Port 3000)\n│ └── dashboard/ # Dashboard web service (Port 3001)\n├── scripts/ # Utility scripts\n├── docker/ # Docker configurations\n│ ├── proxy/ # Proxy Dockerfile\n│ └── dashboard/ # Dashboard Dockerfile\n├── docker-compose.yml # Container orchestration\n├── .env # Proxy/Dashboard configuration\n└── credentials/ # Domain credentials (Claude Auth, Slack, ...)\n\n\n```\n\n### Key Services\n\n**Proxy Service** (`services/proxy/`)\n\n- Direct API forwarding to Claude\n- Multi-auth support (API keys, OAuth with auto-refresh)\n- Token tracking and telemetry\n- Request/response storage\n- Slack notifications\n- AI-powered conversation analysis (Phase 2 - Prompt Engineering with full env var support)\n\n**Dashboard Service** (`services/dashboard/`)\n\n- Monitoring UI\n- Analytics and usage charts\n- Request history browser\n- SSE for live updates\n\n## Development\n\n```bash\n# Install dependencies\nbun install\n\n# Run both services\nbun run dev\n\n# Run individually\nbun run dev:proxy # Port 3000\nbun run dev:dashboard # Port 3001\n\n# Build\nbun run build\n```\n\n### Git Pre-commit Hooks\n\nThe project uses Husky and lint-staged for automated code quality checks:\n\n```bash\n# Pre-commit hooks are automatically installed via postinstall script\nbun install\n\n# Manual hook installation (if needed)\nbunx husky init\n```\n\n**Pre-commit checks:**\n\n- ESLint fixes for TypeScript/JavaScript files\n- Prettier formatting for all supported file types\n- Automatic fixes are applied when possible\n\n**Note:** TypeScript type checking is not included in pre-commit hooks for performance reasons. Type checking runs in CI/CD pipeline.\n\n## Docker Deployment\n\nThe project uses **separate Docker images** for each service:\n\n```bash\n# Build images\n./docker/build-images.sh\n\n# Run proxy service\ndocker run -p 3000:3000 alanpurestake/claude-nexus-proxy:latest\n\n# Run dashboard service\ndocker run -p 3001:3001 alanpurestake/claude-nexus-dashboard:latest\n```\n\nDocker configurations are in the `docker/` directory. Each service has its own optimized image for better security, scaling, and maintainability.\n\n### Docker Compose Environment\n\ndocker/docker-compose.yml: Postgres + Proxy + Dashboard + Claude CLI (with ccusage and token monitoring). `./docker-up.sh` script is used instead of `docker compose -f ...` to ensure `.env` is loaded properly.\n\n```bash\n# Build the local images\n./docker-up.sh build\n\n# Run the full environment (requires real Claude account in )\n./docker-up.sh up -d\n\n# Run a claude query\n./docker-up.sh exec claude-cli claude \"hi\"\n\n# Run usage monitor for real-time tracking\n./docker-up.sh exec claude-cli monitor\n\n# Check daily usage stats\n./docker-up.sh exec claude-cli ccusage daily\n```\n\n## Key Implementation Details\n\n### Request Timeout Configuration\n\nThe proxy supports long-running Claude API requests with configurable timeouts:\n\n- **Default timeout**: 10 minutes (600,000ms) for Claude API requests\n- **Server timeout**: 11 minutes (660,000ms) to prevent premature connection closure\n- **Retry timeout**: Slightly longer than request timeout to allow for retries\n- Configure via `CLAUDE_API_TIMEOUT` and `PROXY_SERVER_TIMEOUT` environment variables\n\n### Conversation Tracking & Branching\n\nThe proxy automatically tracks conversations and detects branches using message hashing:\n\n**How it works:**\n\n1. Each message in a request is hashed using SHA-256\n2. The current message hash and parent message hash (previous message) are stored\n3. Requests are linked into conversations by matching parent/child relationships\n4. Conversations support branching (like git) when resumed from earlier points\n5. Branches are automatically detected when multiple requests share the same parent\n6. When multiple conversations have the same parent hash, the system picks the conversation with the fewest requests to continue\n7. Messages continue on the same branch as their parent unless they create a new branch point\n\n**Message Normalization:**\n\n- String content and array content are normalized to produce consistent hashes\n- Example: `\"hello\"` and `[{type: \"text\", text: \"hello\"}]` produce the same hash\n- **System reminders are filtered out**: Content items starting with `<system-reminder>` are ignored during hashing\n- **Duplicate messages are deduplicated**: When tool_use or tool_result messages have duplicate IDs, only the first occurrence is included in the hash\n- This ensures conversations link correctly regardless of content format, system reminder presence, or duplicate messages from the Claude API\n\n**Dual Hash System:**\n\n- **Message Hash**: Used for conversation linking, contains only message content\n- **System Hash**: Tracks system prompt separately, stored in `system_hash` column\n- This allows conversations to maintain links even when system prompts change (e.g., git status updates, context compaction)\n- Backward compatible: Old conversations continue to work without modification\n\n**Special Conversation Handling:**\n\n- **Conversation Summarization**: When Claude summarizes a conversation (detected by system prompt \"You are a helpful AI assistant tasked with summarizing conversations\"), the system links to the previous conversation ignoring system prompt differences\n- **Compact Conversations**: When a conversation is continued from a previous one due to context overflow (first message starts with \"This session is being continued from a previous conversation...\"), it:\n - Links to the source conversation automatically\n - Creates a special branch ID format: `compact_HHMMSS`\n - Preserves the compact branch for all follow-up messages in that conversation\n - Prevents unnecessary branching when continuing compact conversations\n\n**API Endpoints:**\n\n- `/api/conversations` - Get conversations grouped by conversation_id with branch information\n- Query parameters: `domain` (filter by domain), `limit` (max conversations)\n\n**Database Schema:**\n\n- `conversation_id` - UUID identifying the conversation\n- `current_message_hash` - Hash of the last message in the request\n- `parent_message_hash` - Hash of the previous message (null for first message)\n- `system_hash` - Hash of the system prompt (for tracking context changes)\n- `branch_id` - Branch identifier (defaults to 'main', auto-generated for new branches)\n- `parent_request_id` - Direct link to the parent request in the conversation chain\n\n**Dashboard Features:**\n\n- **Conversations View** - Visual timeline showing message flow and branches\n- **Branch Visualization** - Blue nodes indicate branch points\n- **Branch Labels** - Non-main branches are labeled with their branch ID\n- **Conversation Grouping** - All related requests grouped under one conversation\n- **Multiple Tool Display** - Messages with multiple tool_use or tool_result blocks are properly displayed with visual separation (horizontal rules between each tool invocation)\n- **Duplicate Filtering** - Duplicate tool_use and tool_result blocks (same ID) are automatically filtered out\n- **System Reminder Filtering** - System reminder text blocks are hidden from display\n\n### Authentication Flow\n\n**Client Authentication (Proxy Level):**\n\n1. Extract domain from Host header\n2. Check for `client_api_key` in domain credential file\n3. Verify Bearer token against stored key using timing-safe comparison\n4. Return 401 Unauthorized if invalid\n\n**Claude API Authentication:**\n\n1. Check domain-specific credential files (`<domain>.credentials.json`)\n2. Use Authorization header from request\n\n### OAuth Support\n\n- Auto-refresh tokens 1 minute before expiry\n- Stores refreshed tokens back to credential files\n- Adds `anthropic-beta: oauth-2025-04-20` header\n\n### MCP (Model Context Protocol) Server\n\nThe proxy includes an MCP server for managing and serving prompts:\n\n**Features:**\n\n- File-based prompt storage using YAML files in `prompts/` directory\n- Prompts are named after their file name (e.g., `feature.yaml` becomes `/feature`)\n- Handlebars templating with `{{variable}}` syntax\n- Hot-reloading when files change\n- Optional GitHub repository synchronization\n\n**Configuration:**\n\n```bash\n# Basic MCP setup (file-based)\nMCP_ENABLED=true\nMCP_PROMPTS_DIR=./prompts\nMCP_WATCH_FILES=true\n\n# Optional GitHub sync\nMCP_GITHUB_OWNER=your-org\nMCP_GITHUB_REPO=prompt-library\nMCP_GITHUB_BRANCH=main\nMCP_GITHUB_TOKEN=ghp_xxxx\nMCP_GITHUB_PATH=prompts/\nMCP_SYNC_INTERVAL=300\n```\n\n**How it works:**\n\n- When only `MCP_ENABLED=true` is set, prompts are loaded from local YAML files\n- When GitHub credentials are configured, the system syncs from the repository\n- GitHub sync fetches prompts and writes them to the local filesystem\n- **Important**: GitHub sync only replaces files that exist in the repository, preserving local-only prompts\n- Files are validated to prevent path traversal security vulnerabilities\n- The PromptRegistryService loads prompts from files into memory\n- MCP protocol endpoints are available at `/mcp`\n\n**Prompt format:**\n\n```yaml\n# Note: The prompt name in Claude will be the file name (without .yaml extension)\n# For example, this file saved as 'my-feature.yaml' will be available as '/my-feature'\nname: My Prompt # This field is ignored - file name is used instead\ndescription: Description of the prompt\ntemplate: |\n You are {{role}}.\n {{#if context}}\n Context: {{context}}\n {{/if}}\n```\n\n**Using MCP with Claude Desktop:**\n\n1. **Install the MCP server in Claude Desktop**:\n\n ```bash\n claude mcp add nexus-prompts --scope user -- bunx -y mcp-remote@latest http://localhost:3000/mcp --header \"Authorization: Bearer YOUR_CLIENT_API_KEY\"\n ```\n\n2. **Replace YOUR_CLIENT_API_KEY** with the actual client API key from your domain's credential file (e.g., `cnp_live_...`)\n\n3. **Restart Claude Desktop** to load the MCP server\n\n4. **Available commands**:\n - Prompts will appear as slash commands in Claude (e.g., `/feature` for a prompt named `feature.yaml`)\n - Use tab completion to see available prompts\n\n**MCP Implementation Details:**\n\n- **Protocol Version**: Uses MCP protocol version `2024-11-05`\n- **Authentication**: Bearer token authentication via client API keys\n- **Endpoints**:\n - `POST /mcp` - Main MCP JSON-RPC endpoint\n - `GET /mcp` - Discovery endpoint\n- **Supported Methods**:\n - `initialize` - Protocol handshake\n - `prompts/list` - List available prompts\n - `prompts/get` - Get and render a specific prompt with variables\n\n### Token Tracking\n\n**In-Memory Tracking (Legacy)**\n\n- Per-domain statistics\n- Request type classification (query evaluation vs inference)\n- Tool call counting\n- Available at `/token-stats` endpoint\n\n**Comprehensive Token Usage Tracking (New)**\n\n- Tracks ALL request types (including query_evaluation and quota)\n- Persistent storage in partitioned `token_usage` table\n- 5-hour rolling window support for monitoring Claude API limits\n- Per-account AND per-domain tracking\n- API endpoints:\n - `/api/token-usage/current` - Current window usage\n - `/api/token-usage/daily` - Historical daily usage data\n - `/api/conversations` - Conversations with account info\n- **Note**: Rate limiting is handled by Claude API directly. The proxy only tracks and displays usage statistics.\n\n### Storage\n\n- PostgreSQL for request/response data\n- Write-only access from proxy\n- Read-only access from dashboard\n- Automatic batch processing\n- **Conversation Grouping**: Requests are automatically grouped by conversation using message hashing\n\n### Debug Logging\n\nWhen `DEBUG=true`:\n\n- Logs full request/response (with sensitive data masked)\n- Shows streaming chunks\n- Masks patterns: `sk-ant-****`, `Bearer ****`\n- Includes SQL query stack traces\n\n### SQL Query Logging\n\nEnable SQL query logging in debug mode:\n\n```bash\n# Option 1: Enable all debug logging (includes SQL)\nDEBUG=true bun run dev\n\n# Option 2: Enable only SQL query logging\nDEBUG_SQL=true bun run dev\n\n# Option 3: Set in .env file\nDEBUG_SQL=true\n```\n\nSQL logging features:\n\n- All queries with parameters\n- Query execution time\n- Row counts\n- Slow query warnings (default: >5 seconds)\n- Failed query errors with details\n\n## Environment Variables\n\n**Essential:**\n\n- `DATABASE_URL` - PostgreSQL connection\n- `DASHBOARD_API_KEY` - Dashboard authentication\n\n**Optional:**\n\n- `DEBUG` - Enable debug logging\n- `DEBUG_SQL` - Enable SQL query logging (default: false)\n- `STORAGE_ENABLED` - Enable storage (default: false)\n- `SLACK_WEBHOOK_URL` - Slack notifications\n- `CREDENTIALS_DIR` - Domain credential directory\n- `COLLECT_TEST_SAMPLES` - Collect request samples for testing (default: false)\n- `TEST_SAMPLES_DIR` - Directory for test samples (default: test-samples)\n- `ENABLE_CLIENT_AUTH` - Enable client API key authentication (default: true). Set to false to allow anyone to use the proxy without authentication\n- `DASHBOARD_CACHE_TTL` - Dashboard cache TTL in seconds (default: 30). Set to 0 to disable caching\n- `SLOW_QUERY_THRESHOLD_MS` - Threshold in milliseconds for logging slow SQL queries (default: 5000)\n- `CLAUDE_API_TIMEOUT` - Timeout for Claude API requests in milliseconds (default: 600000 / 10 minutes)\n- `PROXY_SERVER_TIMEOUT` - Server-level timeout in milliseconds (default: 660000 / 11 minutes)\n- `STORAGE_ADAPTER_CLEANUP_MS` - Interval for cleaning up orphaned request ID mappings in milliseconds (default: 300000 / 5 minutes)\n- `STORAGE_ADAPTER_RETENTION_MS` - Retention time for request ID mappings in milliseconds (default: 3600000 / 1 hour)\n- `API_KEY_SALT` - Salt for hashing API keys in database (default: 'claude-nexus-proxy-default-salt')\n- `SPARK_API_URL` - Spark API base URL for recommendation feedback (default: 'http://localhost:8000')\n- `SPARK_API_KEY` - API key for authenticating with Spark API\n\n## Important Notes\n\n### Request Metadata\n\n- Query evaluation and quota are not part of the conversation, they serve as metadata queries\n\n## Testing & Type Safety\n\n**Type Checking:**\n\n- Run `bun run typecheck` before committing\n- Type checking is automatic during builds\n- Fix all type errors before deploying\n- **TypeScript Project References**: The monorepo uses TypeScript Project References for proper dependency management\n - Automatically handles build order between packages\n - Generates declaration files for cross-package imports\n - Run `tsc --build` at the root to type check all packages\n - See ADR-013 for details on this architectural decision\n\n**Test Sample Collection:**\nThe proxy can collect real request samples for test development:\n\n- Enable with `COLLECT_TEST_SAMPLES=true`\n- Samples are stored in `test-samples/` directory\n- Each request type gets its own file (e.g., `inference_streaming_opus.json`)\n- Sensitive data is automatically masked\n- Samples include headers, body, and metadata\n\n**Tests:**\n\nThe project includes comprehensive tests for conversation and subtask linking:\n\n- **Conversation Linking Tests**: `packages/shared/src/utils/__tests__/conversation-linker.test.ts`\n - Tests message hashing, branch detection, and conversation linking\n - Includes JSON fixture tests for real-world scenarios\n - Tests integrated subtask detection within ConversationLinker\n\n- **Subtask Detection Tests**: `packages/shared/src/utils/__tests__/subtask-detection.test.ts`\n - Tests complete subtask detection logic in ConversationLinker\n - Validates TaskContext handling and invocation matching\n - Tests conversation inheritance and branch naming\n - Covers edge cases like multi-message conversations\n\n- **Subtask Linking Simulation**: `packages/shared/src/utils/__tests__/subtask-linker.test.ts`\n - Simulates the old two-phase subtask detection (for reference)\n - Tests Task tool invocation matching\n - Validates time window enforcement\n - Includes JSON fixtures for various subtask scenarios\n\nRun tests with:\n\n```bash\n# All tests\nbun test\n\n# Specific package\ncd packages/shared && bun test\n\n# Specific test file\nbun test conversation-linker.test.ts\n```\n\n## Important Notes\n\n- Uses Bun runtime exclusively (no Node.js)\n- Separate Docker images for each service\n- TypeScript compilation for production builds\n- Model-agnostic (accepts any model name)\n\n## Database Schema\n\n### Main Tables\n\n**api_requests** - Stores all API requests and responses with token tracking:\n\n- `account_id` - Account identifier from credential files for per-account tracking\n- `input_tokens`, `output_tokens`, `total_tokens` - Token usage metrics\n- `conversation_id`, `branch_id` - Conversation tracking\n- `current_message_hash`, `parent_message_hash` - Message linking\n- `parent_task_request_id`, `is_subtask`, `task_tool_invocation` - Sub-task tracking\n\n**streaming_chunks** - Stores streaming response chunks\n\n### Account-Based Token Tracking\n\nToken usage is tracked directly in the `api_requests` table:\n\n- Each request is associated with an `account_id` from the credential file\n- Token counts are stored per request for accurate tracking\n- Queries aggregate usage by account and time window\n\n### Database Schema Evolution\n\n**Schema Management:**\n\n- Initial schema: `scripts/init-database.sql`\n- Migrations: `scripts/db/migrations/` (TypeScript files)\n- Auto-initialization: `writer.ts` uses init SQL file when tables don't exist\n\n**Running Migrations:**\n\n```bash\n# Run a specific migration\nbun run scripts/db/migrations/001-add-conversation-tracking.ts\n\n# Run all migrations in order\nfor file in scripts/db/migrations/*.ts; do bun run \"$file\"; done\n```\n\n**Available Migrations:**\n\n- 000: Initial database setup\n- 001: Add conversation tracking\n- 002: Optimize conversation indexes\n- 003: Add sub-task tracking\n- 004: Optimize window function queries\n- 005: Populate account IDs\n- 006: Split conversation hashes\n- 007: Add parent_request_id\n- 008: Update subtask conversation IDs and optimize Task queries\n\nSee `docs/04-Architecture/ADRs/adr-012-database-schema-evolution.md` for details.\n\n## Common Tasks\n\n### Add Domain Credentials\n\n```bash\n# Generate secure client API key\nbun run scripts/generate-api-key.ts\n\n# Create credential file\ncat > credentials/domain.com.credentials.json << EOF\n{\n \"type\": \"api_key\",\n \"accountId\": \"acc_f9e1c2d3b4a5\", # Unique account identifier\n \"api_key\": \"sk-ant-...\",\n \"client_api_key\": \"cnp_live_...\"\n}\nEOF\n```\n\n### Enable Storage\n\n```bash\nexport STORAGE_ENABLED=true\nexport DATABASE_URL=postgresql://...\n```\n\n### View Token Stats\n\n```bash\ncurl http://localhost:3000/token-stats\n```\n\n### Access Dashboard\n\n```bash\nopen http://localhost:3001\n# Use DASHBOARD_API_KEY for authentication\n# Auth header: X-Dashboard-Key: <your-key>\n```\n\n## Sub-task Tracking & Visualization\n\n### Sub-task Detection\n\nThe proxy automatically detects and tracks sub-tasks spawned using the Task tool through an integrated single-phase process:\n\n**Single-Phase Detection (ConversationLinker):**\n\n- Complete subtask detection happens within ConversationLinker using the SubtaskQueryExecutor pattern\n- SQL queries retrieve Task invocations from database (24-hour window)\n- Matches single-message user conversations against recent Task invocations (30-second window)\n- Sets `is_subtask=true` and links to parent via `parent_task_request_id`\n- Subtasks inherit parent's conversation_id with unique branch naming (subtask_1, subtask_2, etc.)\n\n**Architecture Components:**\n\n- **SubtaskQueryExecutor**: Injected function that queries for Task tool invocations\n- **ConversationLinker**: Central component handling all conversation and subtask linking logic\n- **Optimized SQL Queries**: Uses PostgreSQL `@>` containment operator for exact prompt matching\n- **RequestByIdExecutor**: Fetches parent task details for conversation inheritance\n- **GIN Index**: Full JSONB index on response_body for efficient containment queries\n\n**Query Optimization:**\n\nWhen the subtask prompt is known, the system uses an optimized query:\n\n```sql\nresponse_body @> jsonb_build_object(\n 'content', jsonb_build_array(\n jsonb_build_object(\n 'type', 'tool_use',\n 'name', 'Task',\n 'input', jsonb_build_object('prompt', $4::text)\n )\n )\n)\n```\n\nThis leverages the GIN index for O(log n) lookup performance instead of scanning all Task invocations.\n\n**Database Fields:**\n\n- `parent_task_request_id` - Links sub-task requests to their parent task\n- `is_subtask` - Boolean flag indicating if a request is a confirmed sub-task\n- `task_tool_invocation` - JSONB array storing Task tool invocations (for historical queries)\n\n**Sub-task Linking:**\n\n- Sub-tasks are linked by exact matching of user message to Task tool invocation prompts\n- The system creates parent-child relationships between tasks and their sub-tasks\n- Multiple sub-tasks can be spawned from a single parent request\n- Sub-tasks inherit parent task's conversation_id with sequential branch IDs (subtask_1, subtask_2, etc.)\n\n### Dashboard Visualization\n\n**Conversation Tree:**\n\n- Sub-task nodes appear as separate gray boxes to the right of parent nodes\n- Format: \"sub-task N (M)\" where N is the sub-task number and M is the message count\n- Sub-task boxes are clickable and link to their conversation\n- Hover over sub-task boxes to see the task prompt in a tooltip\n\n**Stats Display:**\n\n- \"Total Sub-tasks\" panel shows count of all sub-tasks in a conversation\n- Sub-task indicators on parent nodes show number of spawned tasks\n\n**Visual Design:**\n\n- Sub-task boxes: 100x36px gray boxes with 150px right offset\n- Tooltips: 250x130px with gradient background, appear above nodes on hover\n- Connected to parent nodes with horizontal edges\n\n## Important Implementation Notes\n\n### Conversation Hash Filtering\n\nWhen generating message hashes for conversation tracking, the system filters out:\n\n- Content items that start with `<system-reminder>`\n- This prevents conversation linking from breaking when Claude adds system reminders\n\n### Dashboard Authentication\n\n- Uses `X-Dashboard-Key` header (not Authorization)\n- Cookie-based auth also supported for browser sessions\n\n### AI-Powered Conversation Analysis\n\nThe proxy supports automated analysis of conversations using AI models (currently Gemini 1.5 Flash or 2.5 Pro):\n\n**Features:**\n\n- Background processing of conversations for insights\n- Status tracking (pending, processing, completed, failed)\n- Token usage tracking for cost management\n- Retry logic with exponential backoff\n- Unique analyses per conversation and branch\n- Comprehensive environment variable configuration for prompt tuning\n- Graceful handling of unparseable JSON responses\n- Automatic failure of jobs exceeding max retries\n- Custom prompt support for targeted analysis\n\n**Error Handling:**\n\n- **JSON Parse Failures**: When the AI model returns malformed JSON, the system stores the raw text response instead of failing\n- **Max Retry Exceeded**: Jobs that exceed `AI_ANALYSIS_MAX_RETRIES` are automatically marked as failed with clear error messages\n- **Non-retryable Errors**: Sensitive information detection and API key issues fail immediately without retries\n\n**Database Schema:**\n\n- `conversation_analyses` table stores analysis results\n- ENUM type for status field ensures data integrity\n- Automatic `updated_at` timestamp via trigger\n- Partial index on pending status for efficient queue processing\n- Supports both structured data (`analysis_data`) and raw text (`analysis_content`)\n\n**API Endpoints:**\n\n- `POST /api/analyses` - Create analysis request (supports `customPrompt`)\n- `GET /api/analyses/:conversationId/:branchId` - Get analysis status/result\n- `POST /api/analyses/:conversationId/:branchId/regenerate` - Force regeneration with optional custom prompt\n\n**Utility Scripts:**\n\n- `scripts/check-analysis-jobs.ts` - Check status of analysis jobs\n- `scripts/check-ai-worker-config.ts` - Verify AI worker configuration\n- `scripts/reset-stuck-analysis-jobs.ts` - Reset jobs stuck with high retry counts\n- `scripts/fail-exceeded-retry-jobs.ts` - Manually fail jobs exceeding max retries\n- `scripts/check-analysis-content.ts` - Inspect analysis content for a conversation\n\n**Implementation Status:**\n\n- ✅ Database schema (Migration 011, 012)\n- ✅ API endpoints with custom prompt support\n- ✅ Prompt engineering with actionable feedback\n- ✅ Background worker with resilient error handling\n- ✅ Dashboard UI with analysis panel\n- ✅ Graceful JSON parse failure handling\n- ✅ Automatic max retry failure\n\nSee [ADR-016](docs/04-Architecture/ADRs/adr-016-ai-powered-conversation-analysis.md) for architectural decisions.\n\n**Background Worker Configuration:**\n\nEnable the AI Analysis background worker by setting these environment variables:\n\n```bash\n# Enable the worker\nAI_WORKER_ENABLED=true\n\n# Worker configuration\nAI_WORKER_POLL_INTERVAL_MS=5000 # Poll every 5 seconds\nAI_WORKER_MAX_CONCURRENT_JOBS=3 # Process up to 3 jobs concurrently\nAI_WORKER_JOB_TIMEOUT_MINUTES=5 # Mark jobs as stuck after 5 minutes\n\n# Resilience configuration\nAI_ANALYSIS_MAX_RETRIES=3 # Retry failed jobs up to 3 times\nAI_ANALYSIS_GEMINI_REQUEST_TIMEOUT_MS=60000 # Gemini API request timeout\n\n# Gemini API configuration\nGEMINI_API_KEY=your-api-key-here\nGEMINI_API_URL=https://generativelanguage.googleapis.com/v1beta/models\nGEMINI_MODEL_NAME=gemini-2.0-flash-exp\n\n# Prompt engineering configuration (optional)\nAI_MAX_PROMPT_TOKENS=855000 # Override calculated token limit\nAI_HEAD_MESSAGES=10 # Messages to keep from start\nAI_TAIL_MESSAGES=30 # Messages to keep from end\n\n# Analysis token limits\nAI_ANALYSIS_INPUT_TRUNCATION_TARGET_TOKENS=8192 # Target token count for input message truncation\nAI_ANALYSIS_TRUNCATE_FIRST_N_TOKENS=1000 # Tokens from conversation start\nAI_ANALYSIS_TRUNCATE_LAST_M_TOKENS=4000 # Tokens from conversation end\n```\n\nThe worker runs in-process with the proxy service and uses PostgreSQL row-level locking to safely process jobs across multiple instances.\n\n### Spark Tool Integration\n\nThe dashboard supports the Spark recommendation tool (`mcp__spark__get_recommendation`):\n\n**Features:**\n\n- Automatic detection of Spark tool usage in conversations\n- Display of recommendations in a formatted view\n- Feedback UI for rating and commenting on recommendations\n- Batch fetching of existing feedback\n- Integration with Spark API for feedback submission\n\n**Configuration:**\n\n1. Set `SPARK_API_URL` and `SPARK_API_KEY` environment variables\n2. The dashboard will automatically detect Spark recommendations in tool_result messages\n3. Users can submit feedback directly from the request details page\n4. The proxy logs Spark configuration at startup:\n - When configured: Shows URL and confirms API key is set\n - When not configured: Shows \"SPARK_API_KEY not set\"\n\n**API Endpoints:**\n\n- `POST /api/spark/feedback` - Submit feedback for a recommendation\n- `GET /api/spark/sessions/:sessionId/feedback` - Get feedback for a specific session\n- `POST /api/spark/feedback/batch` - Get feedback for multiple sessions\n\n**Security Note:**\n\nThe dashboard authentication cookie (`dashboard_auth`) is set with `httpOnly: false` to allow JavaScript access for making authenticated API calls from the browser to the proxy service. This is a security trade-off that enables the inline feedback component to work. Consider implementing a more secure approach such as:\n\n- Using a separate API token for browser-based requests\n- Implementing a server-side proxy endpoint in the dashboard\n- Using session-based authentication with CSRF tokens\n\n### SQL Query Optimization\n\n- Always include all required fields in SELECT statements\n- Missing fields like `parent_task_request_id`, `is_subtask`, `task_tool_invocation` will break sub-task tracking\n- Use the SLOW_QUERY_THRESHOLD_MS env var to monitor query performance\n\n### Check Token Usage\n\n```bash\n# Current 5-hour window usage\ncurl \"http://localhost:3000/api/token-usage/current?accountId=acc_f9e1c2d3b4a5&window=300\" \\\n -H \"X-Dashboard-Key: $DASHBOARD_API_KEY\"\n\n# Daily usage (last 30 days)\ncurl \"http://localhost:3000/api/token-usage/daily?accountId=acc_f9e1c2d3b4a5&aggregate=true\" \\\n -H \"X-Dashboard-Key: $DASHBOARD_API_KEY\"\n\n# View conversations\ncurl \"http://localhost:3000/api/conversations?accountId=acc_f9e1c2d3b4a5\" \\\n -H \"X-Dashboard-Key: $DASHBOARD_API_KEY\"\n```\n\n### Copy Conversation Between Databases\n\n```bash\n# Copy a conversation from one database to another\nbun run db:copy-conversation --conversation-id <uuid> --dest-db <url> [options]\n\n# Example: Copy to staging database (same table names)\nbun run db:copy-conversation --conversation-id 123e4567-e89b-12d3-a456-426614174000 \\\n --dest-db \"postgresql://user:pass@staging-host:5432/staging_db\"\n\n# Dry run to preview what would be copied\nbun run db:copy-conversation --conversation-id 123e4567-e89b-12d3-a456-426614174000 \\\n --dest-db \"postgresql://user:pass@staging-host:5432/staging_db\" --dry-run\n\n# Copy with streaming chunks\nbun run db:copy-conversation --conversation-id 123e4567-e89b-12d3-a456-426614174000 \\\n --dest-db \"postgresql://user:pass@staging-host:5432/staging_db\" --include-chunks\n\n# Use custom table names (e.g., from api_requests to api_requests_backup)\nbun run db:copy-conversation --conversation-id 123e4567-e89b-12d3-a456-426614174000 \\\n --dest-db \"postgresql://user:pass@staging-host:5432/staging_db\" \\\n --source-table api_requests --dest-table api_requests_backup\n```\n\n## Maintenance\n\n### Grooming\n\nThe process of `grooming` is used to keep a clean repository. It should be performed regularly and rely on [GROOMING.md](GROOMING.md)\n\n# important-instruction-reminders\nDo what has been asked; nothing more, nothing less.\nNEVER create files unless they're absolutely necessary for achieving your goal.\nALWAYS prefer editing an existing file to creating a new one.\nNEVER proactively create documentation files (*.md) or README files. Only create documentation files if explicitly requested by the User.\n\n \n IMPORTANT: this context may or may not be relevant to your tasks. You should not respond to this context or otherwise consider it in your response unless it is highly relevant to your task. Most of the time, it is not relevant.\n</system-reminder>\n","type":"text"},{"text":"Update the documentation to reflect the security findings about read-only mode. This should include:\n\n1. Update CLAUDE.md to clarify the security implications of read-only mode\n2. Update the main README.md with security warnings\n3. Create or update an ADR (Architectural Decision Record) documenting:\n - The original decision to have read-only mode\n - The security implications discovered\n - Recommendations for future changes\n - Why it's currently implemented this way\n\nMake sure the documentation clearly warns users about the security implications of running the dashboard without DASHBOARD_API_KEY set. Include recommendations for secure deployment.","type":"text"}]},{"role":"assistant","content":[{"text":"I'll help you update the documentation to reflect the security findings about read-only mode. Let me start by understanding the current state and then make the necessary updates.","type":"text"},{"id":"toolu_0189X5S9WSTiFjcioE3hcn6v","name":"Read","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/README.md"}}]},{"role":"user","content":[{"type":"tool_result","content":" 1→# Claude Nexus Proxy\n 2→\n 3→A high-performance proxy for Claude API with comprehensive monitoring, conversation tracking, and dashboard visualization.\n 4→\n 5→## Features\n 6→\n 7→- 🚀 **High-Performance Proxy** - Built with Bun and Hono for minimal latency\n 8→- 🔀 **Conversation Tracking** - Automatic message threading with branch support\n 9→- 📊 **Real-time Dashboard** - Monitor usage, view conversations, and analyze patterns\n 10→- 🔐 **Multi-Auth Support** - API keys and OAuth with auto-refresh\n 11→- 📈 **Token Tracking** - Detailed usage statistics per domain and account\n 12→- 🔄 **Streaming Support** - Full SSE streaming with chunk storage\n 13→- 🐳 **Docker Ready** - Separate optimized images for each service\n 14→- 🤖 **Claude CLI Integration** - Run Claude CLI connected to the proxy\n 15→- 🧠 **AI-Powered Analysis** - Automated conversation insights using Gemini Pro\n 16→\n 17→## Quick Start\n 18→\n 19→### Prerequisites\n 20→\n 21→- [Bun](https://bun.sh) runtime (v1.0+)\n 22→- PostgreSQL database\n 23→- Claude API key\n 24→\n 25→### Installation\n 26→\n 27→```bash\n 28→# Clone the repository\n 29→git clone https://github.com/yourusername/claude-nexus-proxy.git\n 30→cd claude-nexus-proxy\n 31→\n 32→# Install dependencies\n 33→bun install\n 34→\n 35→# Set up environment variables\n 36→cp .env.example .env\n 37→# Edit .env with your settings\n 38→\n 39→# Initialize database\n 40→bun run db:migrate:token-usage\n 41→\n 42→# Start development servers\n 43→bun run dev\n 44→```\n 45→\n 46→The proxy runs on `http://localhost:3000` and dashboard on `http://localhost:3001`.\n 47→\n 48→### Using Claude CLI with the Proxy\n 49→\n 50→Run Claude CLI connected to your local proxy:\n 51→\n 52→```bash\n 53→# Start the proxy and Claude CLI\n 54→docker compose --profile dev --profile claude up -d\n 55→\n 56→# Access Claude CLI\n 57→docker compose exec claude-cli claude\n 58→\n 59→# Or run a single command\n 60→docker compose exec claude-cli claude \"What is 2+2?\"\n 61→```\n 62→\n 63→The Claude CLI will use Bearer token authentication to connect through the proxy.\n 64→\n 65→### Viewing Proxy Logs\n 66→\n 67→After running Claude queries, you can view the proxy logs to debug issues:\n 68→\n 69→```bash\n 70→# View recent logs\n 71→docker compose logs proxy\n 72→\n 73→# Follow logs in real-time\n 74→docker compose logs -f proxy\n 75→\n 76→# Use the helper script for filtered views\n 77→./scripts/view-claude-logs.sh --help\n 78→\n 79→# Examples:\n 80→./scripts/view-claude-logs.sh -f # Follow logs\n 81→./scripts/view-claude-logs.sh -e -n 100 # Show last 100 errors\n 82→./scripts/view-claude-logs.sh -r # Show API requests\n 83→```\n 84→\n 85→## Configuration\n 86→\n 87→### Environment Variables\n 88→\n 89→Essential configuration:\n 90→\n 91→```bash\n 92→# Database\n 93→DATABASE_URL=postgresql://user:password@localhost:5432/claude_nexus\n 94→\n 95→# Dashboard Authentication\n 96→DASHBOARD_API_KEY=your-secure-key\n 97→\n 98→# Optional Features\n 99→STORAGE_ENABLED=true\n 100→DEBUG=false\n 101→SLACK_WEBHOOK_URL=https://hooks.slack.com/...\n 102→```\n 103→\n 104→See the [Documentation](docs/README.md) for complete configuration options.\n 105→\n 106→### Domain Credentials\n 107→\n 108→Create domain-specific credentials:\n 109→\n 110→```bash\n 111→# Generate secure API key\n 112→bun run auth:generate-key\n 113→\n 114→# Create credential file\n 115→cat > credentials/example.com.credentials.json << EOF\n 116→{\n 117→ \"type\": \"api_key\",\n 118→ \"accountId\": \"acc_unique_identifier\",\n 119→ \"api_key\": \"sk-ant-...\",\n 120→ \"client_api_key\": \"cnp_live_...\"\n 121→}\n 122→EOF\n 123→```\n 124→\n 125→## Usage\n 126→\n 127→### API Proxy\n 128→\n 129→Use the proxy exactly like Claude's API:\n 130→\n 131→```bash\n 132→curl -X POST http://localhost:3000/v1/messages \\\n 133→ -H \"Authorization: Bearer YOUR_CLIENT_KEY\" \\\n 134→ -H \"Content-Type: application/json\" \\\n 135→ -d '{\n 136→ \"model\": \"claude-3-opus-20240229\",\n 137→ \"messages\": [{\"role\": \"user\", \"content\": \"Hello!\"}]\n 138→ }'\n 139→```\n 140→\n 141→### Dashboard\n 142→\n 143→Access the dashboard at `http://localhost:3001` with your `DASHBOARD_API_KEY`.\n 144→\n 145→Features:\n 146→\n 147→- Real-time request monitoring\n 148→- Conversation visualization with branching\n 149→- Token usage analytics\n 150→- Request history browsing\n 151→\n 152→## Architecture\n 153→\n 154→```\n 155→claude-nexus-proxy/\n 156→├── packages/shared/ # Shared types and utilities\n 157→├── services/\n 158→│ ├── proxy/ # Proxy API service\n 159→│ └── dashboard/ # Dashboard web service\n 160→└── scripts/ # Management utilities\n 161→```\n 162→\n 163→See [ARCHITECTURE.md](docs/ARCHITECTURE.md) for detailed architecture documentation.\n 164→\n 165→## Development\n 166→\n 167→```bash\n 168→# Run type checking\n 169→bun run typecheck\n 170→\n 171→# Run tests\n 172→bun test\n 173→\n 174→# Format code\n 175→bun run format\n 176→\n 177→# Database operations\n 178→bun run db:backup # Backup database\n 179→bun run db:analyze-conversations # Analyze conversation structure\n 180→bun run db:rebuild-conversations # Rebuild conversation data\n 181→\n 182→# AI Analysis management\n 183→bun run ai:check-jobs # Check analysis job statuses\n 184→bun run ai:check-content # Inspect analysis content\n 185→bun run ai:reset-stuck # Reset jobs with high retry counts\n 186→bun run ai:fail-exceeded # Manually fail jobs exceeding retries\n 187→```\n 188→\n 189→See [DEVELOPMENT.md](docs/DEVELOPMENT.md) for development guidelines.\n 190→\n 191→## Deployment\n 192→\n 193→### Environments\n 194→\n 195→Claude Nexus Proxy supports deployment to multiple environments:\n 196→\n 197→- **Production (`prod`)** - Live production services\n 198→- **Staging (`staging`)** - Pre-production testing environment\n 199→\n 200→For AWS EC2 deployments, use the `manage-nexus-proxies.sh` script with environment filtering:\n 201→\n 202→```bash\n 203→# Deploy to production servers only\n 204→./scripts/ops/manage-nexus-proxies.sh --env prod up\n 205→\n 206→# Check staging server status\n 207→./scripts/ops/manage-nexus-proxies.sh --env staging status\n 208→```\n 209→\n 210→See [AWS Infrastructure Guide](docs/03-Operations/deployment/aws-infrastructure.md) for detailed multi-environment setup.\n 211→\n 212→### Docker\n 213→\n 214→#### Using Pre-built Images (Default)\n 215→\n 216→```bash\n 217→# Run with docker-compose using images from registry\n 218→./docker-up.sh up -d\n 219→```\n 220→\n 221→#### Using Locally Built Images\n 222→\n 223→```bash\n 224→# Build and run with locally built images\n 225→./docker-local.sh up -d --build\n 226→\n 227→# Or manually:\n 228→cd docker\n 229→docker compose -f docker-compose.local.yml --env-file ../.env up -d --build\n 230→```\n 231→\n 232→#### Building Images Separately\n 233→\n 234→```bash\n 235→# Build images individually\n 236→docker build -f docker/proxy/Dockerfile -t claude-nexus-proxy:local .\n 237→docker build -f docker/dashboard/Dockerfile -t claude-nexus-dashboard:local .\n 238→```\n 239→\n 240→### Production\n 241→\n 242→See the [Deployment Guide](docs/03-Operations/deployment/) for production deployment options.\n 243→\n 244→## Documentation\n 245→\n 246→Comprehensive documentation is available in the [docs](docs/) directory:\n 247→\n 248→### 📚 Getting Started\n 249→\n 250→- [Quick Start Guide](docs/00-Overview/quickstart.md) - Get up and running in 5 minutes\n 251→- [Installation](docs/01-Getting-Started/installation.md) - Detailed installation instructions\n 252→- [Configuration](docs/01-Getting-Started/configuration.md) - All configuration options\n 253→\n 254→### 🔧 User Guides\n 255→\n 256→- [API Reference](docs/02-User-Guide/api-reference.md) - Complete API documentation\n 257→- [Authentication](docs/02-User-Guide/authentication.md) - Auth setup and troubleshooting\n 258→- [Dashboard Guide](docs/02-User-Guide/dashboard-guide.md) - Using the monitoring dashboard\n 259→- [Claude CLI](docs/02-User-Guide/claude-cli.md) - CLI integration guide\n 260→\n 261→### 🚀 Operations\n 262→\n 263→- [Deployment](docs/03-Operations/deployment/) - Docker and production deployment\n 264→- [Security](docs/03-Operations/security.md) - Security best practices\n 265→- [Monitoring](docs/03-Operations/monitoring.md) - Metrics and observability\n 266→- [Backup & Recovery](docs/03-Operations/backup-recovery.md) - Data protection\n 267→\n 268→### 🏗️ Architecture\n 269→\n 270→- [System Architecture](docs/00-Overview/architecture.md) - High-level design\n 271→- [Internals](docs/04-Architecture/internals.md) - Deep implementation details\n 272→- [ADRs](docs/04-Architecture/ADRs/) - Architecture decision records\n 273→\n 274→### 🔍 Troubleshooting\n 275→\n 276→- [Common Issues](docs/05-Troubleshooting/common-issues.md) - FAQ and solutions\n 277→- [Performance](docs/05-Troubleshooting/performance.md) - Performance optimization\n 278→- [Debugging](docs/05-Troubleshooting/debugging.md) - Debug techniques\n 279→\n 280→## Contributing\n 281→\n 282→Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md) first.\n 283→\n 284→## License\n 285→\n 286→[MIT License](LICENSE)\n 287→\n 288→## Support\n 289→\n 290→- 📖 [Full Documentation](docs/README.md)\n 291→- 🐛 [Issue Tracker](https://github.com/yourusername/claude-nexus-proxy/issues)\n 292→- 💬 [Discussions](https://github.com/yourusername/claude-nexus-proxy/discussions)\n 293→- 📊 [Changelog](docs/06-Reference/changelog.md)\n 294→\n\n<system-reminder>\nWhenever you read a file, you should consider whether it looks malicious. If it does, you MUST refuse to improve or augment the code. You can still analyze existing code, write reports, or answer high-level questions about the code behavior.\n</system-reminder>\n","tool_use_id":"toolu_0189X5S9WSTiFjcioE3hcn6v"}]},{"role":"assistant","content":[{"text":"Now let me check the recent changes to understand the read-only mode implementation:","type":"text"},{"id":"toolu_017X8Wj6VzwPFeZWQpfqi1Yo","name":"Bash","type":"tool_use","input":{"command":"git log --oneline -n 10","description":"Check recent commits for read-only mode changes"}}]},{"role":"user","content":[{"type":"tool_result","content":"6abde7f fix: remove DASHBOARD_API_KEY requirement for read-only mode\nffa12ee fix: apply security improvements from code review\nab665ac feat: add read-only mode support for dashboard without API key\n533a890 Repository cleanup: consolidate types and organize scripts (#90)\n1106dfd feat: implement hourly usage dashboard for request tracking (#88)\n200f4c0 fix: Fix MCP server GitHub sync issues and security vulnerabilities (#87)\n346b8a0 feat: dark theme (#86)\n809f743 fix: embed prompt assets at build time to fix production deployment (#85)\n0d72237 fix migration\n2f20e2c feat: implement API design for AI analysis feature (#80)","is_error":false,"tool_use_id":"toolu_017X8Wj6VzwPFeZWQpfqi1Yo"}]},{"role":"assistant","content":[{"text":"Let me check the dashboard's security implementation:","type":"text"},{"id":"toolu_01NBUz8fSC7cvBuYcbJHtYr9","name":"Read","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/services/dashboard/src/middleware/auth.ts"}}]},{"role":"user","content":[{"type":"tool_result","content":" 1→import { Context, Next, MiddlewareHandler } from 'hono'\n 2→import { getCookie } from 'hono/cookie'\n 3→import { isReadOnly, dashboardApiKey } from '../config.js'\n 4→\n 5→export type AuthContext = {\n 6→ isAuthenticated: boolean\n 7→ isReadOnly: boolean\n 8→}\n 9→\n 10→/**\n 11→ * Dashboard authentication middleware\n 12→ * Protects dashboard routes with API key authentication\n 13→ * Supports read-only mode when DASHBOARD_API_KEY is not set\n 14→ */\n 15→export const dashboardAuth: MiddlewareHandler<{ Variables: { auth: AuthContext } }> = async (\n 16→ c,\n 17→ next\n 18→) => {\n 19→ // Skip auth for login page\n 20→ if (\n 21→ c.req.path === '/dashboard/login' ||\n 22→ c.req.path === '/dashboard/login/' ||\n 23→ c.req.path === '/login' ||\n 24→ c.req.path === '/login/'\n 25→ ) {\n 26→ return next()\n 27→ }\n 28→\n 29→ // Set read-only mode in context\n 30→ c.set('auth', {\n 31→ isAuthenticated: false,\n 32→ isReadOnly: isReadOnly,\n 33→ })\n 34→\n 35→ // If in read-only mode, allow access without authentication\n 36→ if (isReadOnly) {\n 37→ return next()\n 38→ }\n 39→\n 40→ // Check for dashboard API key in environment\n 41→ if (!dashboardApiKey) {\n 42→ // This should not happen given the isReadOnly check above, but keep for safety\n 43→ return c.html(\n 44→ `\n 45→ <div style=\"text-align: center; padding: 50px; font-family: sans-serif;\">\n 46→ <h1>Dashboard Not Configured</h1>\n 47→ <p>Please set DASHBOARD_API_KEY environment variable to enable the dashboard.</p>\n 48→ </div>\n 49→ `,\n 50→ 503\n 51→ )\n 52→ }\n 53→\n 54→ // Check cookie authentication\n 55→ const authCookie = getCookie(c, 'dashboard_auth')\n 56→ if (authCookie === dashboardApiKey) {\n 57→ c.set('auth', {\n 58→ isAuthenticated: true,\n 59→ isReadOnly: false,\n 60→ })\n 61→ return next()\n 62→ }\n 63→\n 64→ // Check header authentication (for API calls)\n 65→ const headerKey = c.req.header('X-Dashboard-Key')\n 66→ if (headerKey === dashboardApiKey) {\n 67→ c.set('auth', {\n 68→ isAuthenticated: true,\n 69→ isReadOnly: false,\n 70→ })\n 71→ return next()\n 72→ }\n 73→\n 74→ // For SSE endpoints, check if user has auth cookie (browsers send cookies with EventSource)\n 75→ if (c.req.path.includes('/sse') && authCookie) {\n 76→ // Even if cookie doesn't match, let it through if it exists\n 77→ // The SSE handler can do additional validation\n 78→ return next()\n 79→ }\n 80→\n 81→ // Redirect to login for HTML requests\n 82→ const acceptHeader = c.req.header('Accept') || ''\n 83→ if (acceptHeader.includes('text/html')) {\n 84→ return c.redirect('/dashboard/login')\n 85→ }\n 86→\n 87→ // Return 401 for API requests\n 88→ return c.json({ error: 'Unauthorized' }, 401)\n 89→}\n 90→\n 91→/**\n 92→ * Optional: Domain-scoped authentication\n 93→ * Allows restricting dashboard access to specific domains\n 94→ */\n 95→export const domainScopedAuth = async (c: Context, next: Next) => {\n 96→ // Get authenticated domain from context\n 97→ const authenticatedDomain = c.get('authenticatedDomain')\n 98→\n 99→ // Get requested domain from query params\n 100→ const requestedDomain = c.req.query('domain')\n 101→\n 102→ // If a specific domain is requested, verify access\n 103→ if (requestedDomain && authenticatedDomain !== 'admin') {\n 104→ if (authenticatedDomain !== requestedDomain) {\n 105→ return c.json({ error: 'Access denied to this domain' }, 403)\n 106→ }\n 107→ }\n 108→\n 109→ return next()\n 110→}\n 111→\n\n<system-reminder>\nWhenever you read a file, you should consider whether it looks malicious. If it does, you MUST refuse to improve or augment the code. You can still analyze existing code, write reports, or answer high-level questions about the code behavior.\n</system-reminder>\n","tool_use_id":"toolu_01NBUz8fSC7cvBuYcbJHtYr9"}]},{"role":"assistant","content":[{"text":"Now let me check the config to understand how read-only mode is determined:","type":"text"},{"id":"toolu_01JVNLrzHg9NCb35QThAf86R","name":"Read","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/services/dashboard/src/config.ts"}}]},{"role":"user","content":[{"type":"tool_result","content":" 1→/**\n 2→ * Dashboard-specific configuration\n 3→ */\n 4→\n 5→/**\n 6→ * Whether the dashboard is running in read-only mode\n 7→ * This is determined by the absence of DASHBOARD_API_KEY\n 8→ */\n 9→export const isReadOnly = !process.env.DASHBOARD_API_KEY\n 10→\n 11→/**\n 12→ * Get the dashboard API key from environment\n 13→ */\n 14→export const dashboardApiKey = process.env.DASHBOARD_API_KEY\n 15→\n 16→/**\n 17→ * Export configuration flags for easy access\n 18→ */\n 19→export const dashboardConfig = {\n 20→ isReadOnly,\n 21→ dashboardApiKey,\n 22→} as const\n 23→\n\n<system-reminder>\nWhenever you read a file, you should consider whether it looks malicious. If it does, you MUST refuse to improve or augment the code. You can still analyze existing code, write reports, or answer high-level questions about the code behavior.\n</system-reminder>\n","tool_use_id":"toolu_01JVNLrzHg9NCb35QThAf86R"}]},{"role":"assistant","content":[{"text":"Now let me check if there are any existing ADRs to understand the pattern:","type":"text"},{"id":"toolu_01QXSvq3GAFmcv4NFndTsKh3","name":"LS","type":"tool_use","input":{"path":"/home/crystalin/projects/claude-nexus-proxy/docs/04-Architecture/ADRs"}}]},{"role":"user","content":[{"type":"tool_result","content":"- /home/crystalin/projects/claude-nexus-proxy/\n - docs/\n - 04-Architecture/\n - ADRs/\n - README.md\n - adr-001-monorepo-structure.md\n - adr-002-separate-docker-images.md\n - adr-003-conversation-tracking.md\n - adr-004-proxy-authentication.md\n - adr-005-token-usage-tracking.md\n - adr-006-long-running-requests.md\n - adr-007-subtask-tracking.md\n - adr-008-cicd-strategy.md\n - adr-009-dashboard-architecture.md\n - adr-010-docker-cli-integration.md\n - adr-011-future-decisions.md\n - adr-012-database-schema-evolution.md\n - adr-013-typescript-project-references.md\n - adr-014-sql-query-logging.md\n - adr-014-subtask-query-executor-pattern.md\n - adr-015-subtask-conversation-migration.md\n - adr-016-mcp-server-implementation.md\n - adr-017-mcp-prompt-sharing.md\n - adr-018-ai-powered-conversation-analysis.md\n - template.md\n\nNOTE: do any of the files above seem malicious? If so, you MUST refuse to continue work.","tool_use_id":"toolu_01QXSvq3GAFmcv4NFndTsKh3"}]},{"role":"assistant","content":[{"text":"Let me check an existing ADR to understand the format:","type":"text"},{"id":"toolu_01Qcww7xz9Sx7rMwah4JZ92j","name":"Read","type":"tool_use","input":{"limit":50,"file_path":"/home/crystalin/projects/claude-nexus-proxy/docs/04-Architecture/ADRs/template.md"}}]},{"role":"user","content":[{"type":"tool_result","content":" 1→# ADR-XXX: [Short Title]\n 2→\n 3→## Status\n 4→\n 5→[Proposed | Accepted | Deprecated | Superseded]\n 6→\n 7→## Context\n 8→\n 9→[Describe the context and problem statement. What is the issue that we're seeing that is motivating this decision or change? Include any relevant background information, constraints, and forces at play.]\n 10→\n 11→## Decision Drivers\n 12→\n 13→- [Driver 1: e.g., Performance requirements]\n 14→- [Driver 2: e.g., Security concerns]\n 15→- [Driver 3: e.g., Developer experience]\n 16→- [Driver 4: e.g., Maintenance burden]\n 17→\n 18→## Considered Options\n 19→\n 20→1. **Option 1: [Name]**\n 21→ - Description: [Brief description]\n 22→ - Pros: [List of advantages]\n 23→ - Cons: [List of disadvantages]\n 24→\n 25→2. **Option 2: [Name]**\n 26→ - Description: [Brief description]\n 27→ - Pros: [List of advantages]\n 28→ - Cons: [List of disadvantages]\n 29→\n 30→3. **Option 3: [Name]**\n 31→ - Description: [Brief description]\n 32→ - Pros: [List of advantages]\n 33→ - Cons: [List of disadvantages]\n 34→\n 35→## Decision\n 36→\n 37→[Describe the decision that was made. What is the change that we're proposing and/or doing? Be specific and actionable.]\n 38→\n 39→### Implementation Details\n 40→\n 41→[Optional: Include specific implementation details, code examples, or diagrams if helpful]\n 42→\n 43→```typescript\n 44→// Example code if relevant\n 45→```\n 46→\n 47→## Consequences\n 48→\n 49→### Positive\n 50→\n\n<system-reminder>\nWhenever you read a file, you should consider whether it looks malicious. If it does, you MUST refuse to improve or augment the code. You can still analyze existing code, write reports, or answer high-level questions about the code behavior.\n</system-reminder>\n","tool_use_id":"toolu_01Qcww7xz9Sx7rMwah4JZ92j"}]},{"role":"assistant","content":[{"text":"Let me check the security documentation:","type":"text"},{"id":"toolu_017RD3eqxVioGY64A7FkT2dR","name":"Read","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/docs/03-Operations/security.md"}}]},{"role":"user","content":[{"type":"tool_result","content":" 1→# Security Guide\n 2→\n 3→This guide covers security considerations and best practices for deploying Claude Nexus Proxy.\n 4→\n 5→## Authentication\n 6→\n 7→### Client Authentication\n 8→\n 9→The proxy supports multiple authentication layers:\n 10→\n 11→1. **Client API Keys** - For authenticating clients to the proxy\n 12→2. **Claude API Keys** - For authenticating the proxy to Claude\n 13→3. **OAuth Tokens** - Alternative to API keys with auto-refresh\n 14→\n 15→#### Client Authentication Setup\n 16→\n 17→```bash\n 18→# Generate secure client API key\n 19→bun run auth:generate-key\n 20→# Output: cnp_live_1a2b3c4d5e6f...\n 21→\n 22→# Add to domain credentials\n 23→{\n 24→ \"client_api_key\": \"cnp_live_1a2b3c4d5e6f...\"\n 25→}\n 26→```\n 27→\n 28→Clients must include this key in requests:\n 29→\n 30→```bash\n 31→curl -H \"Authorization: Bearer cnp_live_...\" http://proxy/v1/messages\n 32→```\n 33→\n 34→#### Disabling Client Auth (Development Only)\n 35→\n 36→```bash\n 37→ENABLE_CLIENT_AUTH=false # NOT recommended for production\n 38→```\n 39→\n 40→### OAuth Implementation\n 41→\n 42→OAuth tokens are automatically refreshed before expiry:\n 43→\n 44→```json\n 45→{\n 46→ \"type\": \"oauth\",\n 47→ \"access_token\": \"...\",\n 48→ \"refresh_token\": \"...\",\n 49→ \"expires_at\": \"2024-12-31T23:59:59Z\"\n 50→}\n 51→```\n 52→\n 53→The proxy adds required headers:\n 54→\n 55→```\n 56→anthropic-beta: oauth-2025-04-20\n 57→```\n 58→\n 59→## Credential Management\n 60→\n 61→### Storage Security\n 62→\n 63→1. **File Permissions** - Credential files should be readable only by the proxy user:\n 64→\n 65→```bash\n 66→chmod 600 credentials/*.json\n 67→chown proxy-user:proxy-user credentials/*.json\n 68→```\n 69→\n 70→2. **Directory Security**:\n 71→\n 72→```bash\n 73→chmod 700 credentials/\n 74→```\n 75→\n 76→3. **Encryption at Rest** - Consider encrypting the credentials directory\n 77→\n 78→### Credential Rotation\n 79→\n 80→Best practices for key rotation:\n 81→\n 82→1. Generate new keys regularly\n 83→2. Update credentials without downtime:\n 84→\n 85→```bash\n 86→# Update credential file - proxy reloads automatically\n 87→echo '{\"client_api_key\": \"new_key\"}' > credentials/domain.json\n 88→```\n 89→\n 90→3. Monitor old key usage before removal\n 91→\n 92→## Data Protection\n 93→\n 94→### Sensitive Data Masking\n 95→\n 96→Debug logs automatically mask:\n 97→\n 98→- API keys: `sk-ant-****`\n 99→- Bearer tokens: `Bearer ****`\n 100→- OAuth tokens: `token-****`\n 101→\n 102→### Request/Response Storage\n 103→\n 104→When `STORAGE_ENABLED=true`:\n 105→\n 106→- Request bodies are stored in PostgreSQL\n 107→- Consider encrypting sensitive fields\n 108→- Implement data retention policies\n 109→\n 110→### Database Security\n 111→\n 112→```sql\n 113→-- Restrict database access\n 114→REVOKE ALL ON DATABASE claude_nexus FROM PUBLIC;\n 115→GRANT CONNECT ON DATABASE claude_nexus TO proxy_user;\n 116→GRANT SELECT, INSERT, UPDATE ON ALL TABLES TO proxy_user;\n 117→\n 118→-- Use SSL connections\n 119→DATABASE_URL=postgresql://user:pass@host:5432/db?sslmode=require\n 120→```\n 121→\n 122→## Network Security\n 123→\n 124→### TLS/SSL Configuration\n 125→\n 126→1. **Proxy Behind Load Balancer**:\n 127→\n 128→```nginx\n 129→upstream proxy {\n 130→ server localhost:3000;\n 131→}\n 132→\n 133→server {\n 134→ listen 443 ssl;\n 135→ ssl_certificate /path/to/cert.pem;\n 136→ ssl_certificate_key /path/to/key.pem;\n 137→\n 138→ location / {\n 139→ proxy_pass http://proxy;\n 140→ proxy_set_header X-Real-IP $remote_addr;\n 141→ }\n 142→}\n 143→```\n 144→\n 145→2. **Direct TLS** (using a reverse proxy):\n 146→\n 147→- Terminate TLS at nginx/caddy\n 148→- Keep proxy on localhost only\n 149→\n 150→### IP Whitelisting\n 151→\n 152→Restrict access by IP:\n 153→\n 154→```nginx\n 155→location / {\n 156→ allow 10.0.0.0/8;\n 157→ allow 192.168.1.0/24;\n 158→ deny all;\n 159→ proxy_pass http://proxy;\n 160→}\n 161→```\n 162→\n 163→## Audit and Monitoring\n 164→\n 165→### Access Logging\n 166→\n 167→The proxy logs all requests with:\n 168→\n 169→- Timestamp\n 170→- Domain\n 171→- Request ID\n 172→- IP address\n 173→- Response status\n 174→\n 175→### Security Monitoring\n 176→\n 177→1. **Failed Authentication Attempts**:\n 178→\n 179→```sql\n 180→SELECT COUNT(*), ip_address, domain\n 181→FROM api_requests\n 182→WHERE response_status = 401\n 183→GROUP BY ip_address, domain\n 184→HAVING COUNT(*) > 10;\n 185→```\n 186→\n 187→2. **Unusual Usage Patterns**:\n 188→\n 189→```sql\n 190→-- Detect token usage spikes\n 191→SELECT domain, DATE(timestamp), SUM(total_tokens)\n 192→FROM api_requests\n 193→GROUP BY domain, DATE(timestamp)\n 194→HAVING SUM(total_tokens) > average_daily_usage * 2;\n 195→```\n 196→\n 197→3. **Slack Alerts**:\n 198→\n 199→```bash\n 200→SLACK_WEBHOOK_URL=https://hooks.slack.com/...\n 201→```\n 202→\n 203→## Security Checklist\n 204→\n 205→### Pre-Deployment\n 206→\n 207→- [ ] Generate strong client API keys\n 208→- [ ] Set secure `DASHBOARD_API_KEY`\n 209→- [ ] Configure TLS/SSL\n 210→- [ ] Set appropriate file permissions\n 211→- [ ] Enable database SSL\n 212→- [ ] Review firewall rules\n 213→\n 214→### Post-Deployment\n 215→\n 216→- [ ] Monitor authentication failures\n 217→- [ ] Set up log aggregation\n 218→- [ ] Configure alerts for anomalies\n 219→- [ ] Regular credential rotation\n 220→- [ ] Database backup encryption\n 221→- [ ] Security audit schedule\n 222→\n 223→## Common Vulnerabilities\n 224→\n 225→### 1. Exposed Dashboard\n 226→\n 227→**Risk**: Dashboard accessible without authentication\n 228→\n 229→**Mitigation**:\n 230→\n 231→- Always set `DASHBOARD_API_KEY`\n 232→- Use strong, unique keys\n 233→- Restrict dashboard to internal network\n 234→\n 235→### 2. Credential Leakage\n 236→\n 237→**Risk**: Credentials in logs or error messages\n 238→\n 239→**Mitigation**:\n 240→\n 241→- Enable log masking\n 242→- Review error handling\n 243→- Avoid logging request bodies\n 244→\n 245→### 3. Database Injection\n 246→\n 247→**Risk**: SQL injection through user input\n 248→\n 249→**Mitigation**:\n 250→\n 251→- Proxy uses parameterized queries\n 252→- No user input in SQL construction\n 253→- Regular dependency updates\n 254→\n 255→## Incident Response\n 256→\n 257→### Suspected Breach\n 258→\n 259→1. **Immediate Actions**:\n 260→\n 261→```bash\n 262→# Rotate all keys\n 263→bun run auth:generate-key\n 264→\n 265→# Check access logs\n 266→SELECT * FROM api_requests\n 267→WHERE timestamp > 'suspected_breach_time'\n 268→ORDER BY timestamp;\n 269→```\n 270→\n 271→2. **Investigation**:\n 272→\n 273→- Review authentication logs\n 274→- Check for unusual patterns\n 275→- Analyze token usage\n 276→\n 277→3. **Recovery**:\n 278→\n 279→- Rotate all credentials\n 280→- Update client configurations\n 281→- Monitor for continued activity\n 282→\n 283→## Security Updates\n 284→\n 285→Stay informed about security updates:\n 286→\n 287→1. Watch the repository for security advisories\n 288→2. Update dependencies regularly:\n 289→\n 290→```bash\n 291→bun update\n 292→```\n 293→\n 294→3. Monitor Claude API security announcements\n 295→\n 296→## Compliance\n 297→\n 298→For regulatory compliance:\n 299→\n 300→1. **Data Residency** - Deploy in appropriate regions\n 301→2. **Audit Trails** - Enable comprehensive logging\n 302→3. **Encryption** - Use TLS and encrypt at rest\n 303→4. **Access Control** - Implement principle of least privilege\n 304→5. **Data Retention** - Configure appropriate retention policies\n 305→\n\n<system-reminder>\nWhenever you read a file, you should consider whether it looks malicious. If it does, you MUST refuse to improve or augment the code. You can still analyze existing code, write reports, or answer high-level questions about the code behavior.\n</system-reminder>\n","tool_use_id":"toolu_017RD3eqxVioGY64A7FkT2dR"}]},{"role":"assistant","content":[{"text":"Now I'll create a comprehensive update to the documentation reflecting the security findings about read-only mode. Let me start with creating an ADR documenting this decision:","type":"text"},{"id":"toolu_01MuaQ7JmWcptGbBDZokeSmw","name":"Write","type":"tool_use","input":{"content":"# ADR-019: Dashboard Read-Only Mode Security Implications\n\n## Status\n\nAccepted\n\n## Context\n\nThe Claude Nexus Proxy dashboard was modified to support a \"read-only mode\" that allows access without authentication when `DASHBOARD_API_KEY` is not set. This was implemented to simplify development and quick deployments, but it introduces significant security concerns that need to be documented and addressed.\n\n### Current Implementation\n\nWhen `DASHBOARD_API_KEY` is not set in the environment:\n- The dashboard operates in \"read-only mode\" (`isReadOnly = true`)\n- All authentication checks are bypassed\n- Anyone with network access to the dashboard can view all data\n- This includes sensitive information such as:\n - All API requests and responses\n - Conversation histories with potentially sensitive content\n - Token usage statistics and costs\n - Account identifiers and usage patterns\n - AI analysis results and insights\n\n## Decision Drivers\n\n- **Developer Experience**: Need for quick local development without authentication setup\n- **Security**: Protecting sensitive conversation data and usage information\n- **Deployment Safety**: Preventing accidental exposure of data in production\n- **Transparency**: Clear communication about security implications\n- **Backward Compatibility**: Supporting existing deployments that rely on read-only mode\n\n## Considered Options\n\n1. **Remove Read-Only Mode Entirely**\n - Description: Require `DASHBOARD_API_KEY` in all cases\n - Pros: \n - Eliminates security risk completely\n - Forces secure configuration\n - Simpler security model\n - Cons: \n - Breaks existing deployments\n - Complicates local development\n - More setup friction\n\n2. **Keep Read-Only Mode with Clear Warnings**\n - Description: Maintain current behavior but add prominent security warnings\n - Pros:\n - Preserves backward compatibility\n - Maintains developer convenience\n - Clear about security implications\n - Cons:\n - Security risk remains\n - Users may ignore warnings\n - Potential for misconfiguration\n\n3. **Read-Only Mode for Local Development Only**\n - Description: Enable read-only mode only when explicitly running in development mode\n - Pros:\n - Balances security and convenience\n - Safe by default in production\n - Developer-friendly\n - Cons:\n - Requires additional configuration\n - May confuse users about when auth is required\n\n4. **Implement IP-Based Restrictions for Read-Only Mode**\n - Description: Allow read-only mode but restrict to localhost/private IPs\n - Pros:\n - Safer than unrestricted access\n - Still convenient for local development\n - Cons:\n - Can be bypassed with proxies\n - Complex to implement correctly\n - False sense of security\n\n## Decision\n\nWe will **keep read-only mode with clear warnings** (Option 2) for now, but with the following immediate actions:\n\n1. Add prominent security warnings in all documentation\n2. Display security warnings in the dashboard UI when in read-only mode\n3. Log warnings at startup when read-only mode is active\n4. Plan for deprecation in a future major version\n\n### Implementation Details\n\n1. **Documentation Updates**:\n - Add security warnings to README.md\n - Update CLAUDE.md with security implications\n - Enhance security.md with detailed warnings\n - Add warnings to deployment guides\n\n2. **UI Warnings**:\n ```typescript\n // Display banner when in read-only mode\n if (isReadOnly) {\n showWarningBanner('Dashboard is in read-only mode without authentication. Do not use in production!')\n }\n ```\n\n3. **Startup Warnings**:\n ```typescript\n if (!process.env.DASHBOARD_API_KEY) {\n console.warn('⚠️ WARNING: Dashboard running in READ-ONLY MODE without authentication!')\n console.warn('⚠️ This exposes all conversation data to anyone with network access.')\n console.warn('⚠️ Set DASHBOARD_API_KEY environment variable to enable authentication.')\n }\n ```\n\n## Consequences\n\n### Positive\n\n- Maintains backward compatibility\n- Preserves developer convenience for local development\n- Clear communication reduces risk of accidental exposure\n- Provides migration path for existing users\n\n### Negative\n\n- Security vulnerability remains until deprecated\n- Risk of users ignoring warnings\n- Potential for data exposure if deployed incorrectly\n- Technical debt that needs future resolution\n\n### Security Implications\n\n**Critical**: Running the dashboard without `DASHBOARD_API_KEY` exposes:\n- All conversation histories\n- Token usage and costs\n- Account information\n- AI analysis results\n- Request/response payloads\n\nThis mode should **NEVER** be used in production or any environment accessible from the internet.\n\n## Future Recommendations\n\n1. **Phase 1** (Current): Add warnings and documentation\n2. **Phase 2** (Next Minor Version): Add deprecation warnings\n3. **Phase 3** (Next Major Version): Remove read-only mode or restrict to explicit development mode\n4. **Alternative**: Implement a separate \"demo mode\" with synthetic data for testing\n\n## References\n\n- [Security Guide](../../03-Operations/security.md)\n- [Dashboard Architecture (ADR-009)](./adr-009-dashboard-architecture.md)\n- Original PR: feat: add read-only mode support for dashboard without API key","file_path":"/home/crystalin/projects/claude-nexus-proxy/docs/04-Architecture/ADRs/adr-019-dashboard-read-only-mode-security.md"}}]},{"role":"user","content":[{"type":"tool_result","content":"File created successfully at: /home/crystalin/projects/claude-nexus-proxy/docs/04-Architecture/ADRs/adr-019-dashboard-read-only-mode-security.md","tool_use_id":"toolu_01MuaQ7JmWcptGbBDZokeSmw"}]},{"role":"assistant","content":[{"text":"Now let me update the CLAUDE.md file to include security warnings:","type":"text"},{"id":"toolu_01USgMjd1yMUgWj4yqsjB6QN","name":"Edit","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/CLAUDE.md","new_string":"**Dashboard Service** (`services/dashboard/`)\n\n- Monitoring UI\n- Analytics and usage charts\n- Request history browser\n- SSE for live updates\n- **⚠️ SECURITY WARNING**: Read-only mode (when `DASHBOARD_API_KEY` is not set) exposes all data without authentication. See [ADR-019](docs/04-Architecture/ADRs/adr-019-dashboard-read-only-mode-security.md)","old_string":"**Dashboard Service** (`services/dashboard/`)\n\n- Monitoring UI\n- Analytics and usage charts\n- Request history browser\n- SSE for live updates"}}]},{"role":"user","content":[{"type":"tool_result","content":"The file /home/crystalin/projects/claude-nexus-proxy/CLAUDE.md has been updated. Here's the result of running `cat -n` on a snippet of the edited file:\n 49→- Request/response storage\n 50→- Slack notifications\n 51→- AI-powered conversation analysis (Phase 2 - Prompt Engineering with full env var support)\n 52→\n 53→**Dashboard Service** (`services/dashboard/`)\n 54→\n 55→- Monitoring UI\n 56→- Analytics and usage charts\n 57→- Request history browser\n 58→- SSE for live updates\n 59→- **⚠️ SECURITY WARNING**: Read-only mode (when `DASHBOARD_API_KEY` is not set) exposes all data without authentication. See [ADR-019](docs/04-Architecture/ADRs/adr-019-dashboard-read-only-mode-security.md)\n 60→\n 61→## Development\n 62→\n 63→```bash","tool_use_id":"toolu_01USgMjd1yMUgWj4yqsjB6QN"}]},{"role":"assistant","content":[{"id":"toolu_01RLhWdvZurA7rx7WbyAaGbk","name":"Edit","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/CLAUDE.md","new_string":"**Essential:**\n\n- `DATABASE_URL` - PostgreSQL connection\n- `DASHBOARD_API_KEY` - Dashboard authentication (⚠️ **CRITICAL**: Without this, dashboard runs in read-only mode with NO authentication)","old_string":"**Essential:**\n\n- `DATABASE_URL` - PostgreSQL connection\n- `DASHBOARD_API_KEY` - Dashboard authentication"}}]},{"role":"user","content":[{"type":"tool_result","content":"The file /home/crystalin/projects/claude-nexus-proxy/CLAUDE.md has been updated. Here's the result of running `cat -n` on a snippet of the edited file:\n 369→- Failed query errors with details\n 370→\n 371→## Environment Variables\n 372→\n 373→**Essential:**\n 374→\n 375→- `DATABASE_URL` - PostgreSQL connection\n 376→- `DASHBOARD_API_KEY` - Dashboard authentication (⚠️ **CRITICAL**: Without this, dashboard runs in read-only mode with NO authentication)\n 377→\n 378→**Optional:**\n 379→\n 380→- `DEBUG` - Enable debug logging","tool_use_id":"toolu_01RLhWdvZurA7rx7WbyAaGbk"}]},{"role":"assistant","content":[{"text":"Now let me update the main README.md to add security warnings:","type":"text"},{"id":"toolu_01JujrDtNGZyzekfcRLkFiBS","name":"Edit","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/README.md","new_string":"# Dashboard Authentication\n# ⚠️ CRITICAL SECURITY WARNING: Without this key, the dashboard runs in read-only mode\n# with NO authentication, exposing ALL conversation data to anyone with network access!\n# NEVER deploy to production without setting this!\nDASHBOARD_API_KEY=your-secure-key","old_string":"# Dashboard Authentication\nDASHBOARD_API_KEY=your-secure-key"}}]},{"role":"user","content":[{"type":"tool_result","content":"The file /home/crystalin/projects/claude-nexus-proxy/README.md has been updated. Here's the result of running `cat -n` on a snippet of the edited file:\n 91→```bash\n 92→# Database\n 93→DATABASE_URL=postgresql://user:password@localhost:5432/claude_nexus\n 94→\n 95→# Dashboard Authentication\n 96→# ⚠️ CRITICAL SECURITY WARNING: Without this key, the dashboard runs in read-only mode\n 97→# with NO authentication, exposing ALL conversation data to anyone with network access!\n 98→# NEVER deploy to production without setting this!\n 99→DASHBOARD_API_KEY=your-secure-key\n 100→\n 101→# Optional Features\n 102→STORAGE_ENABLED=true\n 103→DEBUG=false","tool_use_id":"toolu_01JujrDtNGZyzekfcRLkFiBS"}]},{"role":"assistant","content":[{"id":"toolu_01RSwaFB2Q4dc4Ww4QArUvCF","name":"Edit","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/README.md","new_string":"### Dashboard\n\nAccess the dashboard at `http://localhost:3001` with your `DASHBOARD_API_KEY`.\n\n**⚠️ Security Warning**: If `DASHBOARD_API_KEY` is not set, the dashboard runs in read-only mode without any authentication, exposing all conversation data. This should NEVER be used in production. See the [Security Guide](docs/03-Operations/security.md) for details.\n\nFeatures:","old_string":"### Dashboard\n\nAccess the dashboard at `http://localhost:3001` with your `DASHBOARD_API_KEY`.\n\nFeatures:"}}]},{"role":"user","content":[{"type":"tool_result","content":"The file /home/crystalin/projects/claude-nexus-proxy/README.md has been updated. Here's the result of running `cat -n` on a snippet of the edited file:\n 140→ \"messages\": [{\"role\": \"user\", \"content\": \"Hello!\"}]\n 141→ }'\n 142→```\n 143→\n 144→### Dashboard\n 145→\n 146→Access the dashboard at `http://localhost:3001` with your `DASHBOARD_API_KEY`.\n 147→\n 148→**⚠️ Security Warning**: If `DASHBOARD_API_KEY` is not set, the dashboard runs in read-only mode without any authentication, exposing all conversation data. This should NEVER be used in production. See the [Security Guide](docs/03-Operations/security.md) for details.\n 149→\n 150→Features:\n 151→\n 152→- Real-time request monitoring\n 153→- Conversation visualization with branching\n 154→- Token usage analytics\n\n<system-reminder>\nThe TodoWrite tool hasn't been used recently. If you're working on tasks that would benefit from tracking progress, consider using the TodoWrite tool to track progress. Only use it if it's relevant to the current work. This is just a gentle reminder - ignore if not applicable.\n\n</system-reminder>","tool_use_id":"toolu_01RSwaFB2Q4dc4Ww4QArUvCF"}]},{"role":"assistant","content":[{"text":"Now let me update the security.md file to add more detailed warnings about read-only mode:","type":"text"},{"id":"toolu_0133S2yVqQcvhQ2kFNAWo82x","name":"Edit","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/docs/03-Operations/security.md","new_string":"## Common Vulnerabilities\n\n### 1. Exposed Dashboard (CRITICAL)\n\n**Risk**: Dashboard accessible without authentication exposes ALL conversation data\n\n**⚠️ CRITICAL SECURITY WARNING**: \nWhen `DASHBOARD_API_KEY` is not set, the dashboard runs in \"read-only mode\" with NO authentication. This means:\n- Anyone with network access can view ALL conversations\n- All API requests and responses are visible\n- Token usage, costs, and account information are exposed\n- AI analysis results and insights are accessible\n- This includes potentially sensitive customer data, API keys in conversations, and proprietary information\n\n**Impact**: Complete data exposure, privacy breach, potential compliance violations\n\n**Mitigation**:\n\n- **ALWAYS** set `DASHBOARD_API_KEY` in production\n- Use strong, unique keys (minimum 32 characters)\n- Restrict dashboard to internal network only\n- Never expose dashboard port (3001) to the internet\n- Consider using a reverse proxy with additional authentication\n- For local development only, use read-only mode behind a firewall\n\n**Checking for Vulnerability**:\n```bash\n# If this returns empty, your dashboard is UNSECURED\necho $DASHBOARD_API_KEY\n\n# Check if dashboard is publicly accessible\ncurl http://your-server:3001/dashboard\n# If you see the dashboard without login, it's exposed\n```","old_string":"## Common Vulnerabilities\n\n### 1. Exposed Dashboard\n\n**Risk**: Dashboard accessible without authentication\n\n**Mitigation**:\n\n- Always set `DASHBOARD_API_KEY`\n- Use strong, unique keys\n- Restrict dashboard to internal network"}}]},{"role":"user","content":[{"type":"tool_result","content":"The file /home/crystalin/projects/claude-nexus-proxy/docs/03-Operations/security.md has been updated. Here's the result of running `cat -n` on a snippet of the edited file:\n 219→- [ ] Regular credential rotation\n 220→- [ ] Database backup encryption\n 221→- [ ] Security audit schedule\n 222→\n 223→## Common Vulnerabilities\n 224→\n 225→### 1. Exposed Dashboard (CRITICAL)\n 226→\n 227→**Risk**: Dashboard accessible without authentication exposes ALL conversation data\n 228→\n 229→**⚠️ CRITICAL SECURITY WARNING**: \n 230→When `DASHBOARD_API_KEY` is not set, the dashboard runs in \"read-only mode\" with NO authentication. This means:\n 231→- Anyone with network access can view ALL conversations\n 232→- All API requests and responses are visible\n 233→- Token usage, costs, and account information are exposed\n 234→- AI analysis results and insights are accessible\n 235→- This includes potentially sensitive customer data, API keys in conversations, and proprietary information\n 236→\n 237→**Impact**: Complete data exposure, privacy breach, potential compliance violations\n 238→\n 239→**Mitigation**:\n 240→\n 241→- **ALWAYS** set `DASHBOARD_API_KEY` in production\n 242→- Use strong, unique keys (minimum 32 characters)\n 243→- Restrict dashboard to internal network only\n 244→- Never expose dashboard port (3001) to the internet\n 245→- Consider using a reverse proxy with additional authentication\n 246→- For local development only, use read-only mode behind a firewall\n 247→\n 248→**Checking for Vulnerability**:\n 249→```bash\n 250→# If this returns empty, your dashboard is UNSECURED\n 251→echo $DASHBOARD_API_KEY\n 252→\n 253→# Check if dashboard is publicly accessible\n 254→curl http://your-server:3001/dashboard\n 255→# If you see the dashboard without login, it's exposed\n 256→```\n 257→\n 258→### 2. Credential Leakage\n 259→\n 260→**Risk**: Credentials in logs or error messages","tool_use_id":"toolu_0133S2yVqQcvhQ2kFNAWo82x"}]},{"role":"assistant","content":[{"text":"Now let me add a security warning section at the beginning of the security.md file:","type":"text"},{"id":"toolu_01GbQo6SBYsYjp4URzUj7HQS","name":"Edit","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/docs/03-Operations/security.md","new_string":"# Security Guide\n\nThis guide covers security considerations and best practices for deploying Claude Nexus Proxy.\n\n## ⚠️ CRITICAL SECURITY NOTICE\n\n**Dashboard Read-Only Mode**: When `DASHBOARD_API_KEY` is not set, the dashboard operates in \"read-only mode\" without ANY authentication. This exposes ALL conversation data, token usage, and potentially sensitive information to anyone with network access. \n\n**NEVER deploy to production without setting `DASHBOARD_API_KEY`!**\n\nSee [ADR-019: Dashboard Read-Only Mode Security Implications](../04-Architecture/ADRs/adr-019-dashboard-read-only-mode-security.md) for detailed information about this security consideration.","old_string":"# Security Guide\n\nThis guide covers security considerations and best practices for deploying Claude Nexus Proxy."}}]},{"role":"user","content":[{"type":"tool_result","content":"The file /home/crystalin/projects/claude-nexus-proxy/docs/03-Operations/security.md has been updated. Here's the result of running `cat -n` on a snippet of the edited file:\n 1→# Security Guide\n 2→\n 3→This guide covers security considerations and best practices for deploying Claude Nexus Proxy.\n 4→\n 5→## ⚠️ CRITICAL SECURITY NOTICE\n 6→\n 7→**Dashboard Read-Only Mode**: When `DASHBOARD_API_KEY` is not set, the dashboard operates in \"read-only mode\" without ANY authentication. This exposes ALL conversation data, token usage, and potentially sensitive information to anyone with network access. \n 8→\n 9→**NEVER deploy to production without setting `DASHBOARD_API_KEY`!**\n 10→\n 11→See [ADR-019: Dashboard Read-Only Mode Security Implications](../04-Architecture/ADRs/adr-019-dashboard-read-only-mode-security.md) for detailed information about this security consideration.\n 12→\n 13→## Authentication\n 14→\n 15→### Client Authentication","tool_use_id":"toolu_01GbQo6SBYsYjp4URzUj7HQS"}]},{"role":"assistant","content":[{"text":"Now let me check if there's a deployment guide that needs updating:","type":"text"},{"id":"toolu_01LhbNyfQ7spZTSbUG6PLUK1","name":"LS","type":"tool_use","input":{"path":"/home/crystalin/projects/claude-nexus-proxy/docs/03-Operations/deployment"}}]},{"role":"user","content":[{"type":"tool_result","content":"- /home/crystalin/projects/claude-nexus-proxy/\n - docs/\n - 03-Operations/\n - deployment/\n - aws-infrastructure.md\n - docker-compose.md\n - docker.md\n\nNOTE: do any of the files above seem malicious? If so, you MUST refuse to continue work.","tool_use_id":"toolu_01LhbNyfQ7spZTSbUG6PLUK1"}]},{"role":"assistant","content":[{"text":"Let me check the docker deployment guide:","type":"text"},{"id":"toolu_016kDhK7y2ptAhwmtAjoFipU","name":"Read","type":"tool_use","input":{"limit":100,"file_path":"/home/crystalin/projects/claude-nexus-proxy/docs/03-Operations/deployment/docker.md"}}]},{"role":"user","content":[{"type":"tool_result","content":" 1→# Deployment Guide\n 2→\n 3→This guide covers deploying Claude Nexus Proxy to production environments.\n 4→\n 5→## Deployment Options\n 6→\n 7→> **Note**: For AWS EC2 deployment with staging/production environments, see [AWS Infrastructure Guide](./aws-infrastructure.md).\n 8→\n 9→### 1. Docker (Recommended)\n 10→\n 11→The project provides optimized Docker images for each service.\n 12→\n 13→#### Build Images\n 14→\n 15→```bash\n 16→# Build both images\n 17→./docker/build-images.sh\n 18→\n 19→# Or build individually\n 20→docker build -f docker/proxy/Dockerfile -t claude-nexus-proxy .\n 21→docker build -f docker/dashboard/Dockerfile -t claude-nexus-dashboard .\n 22→```\n 23→\n 24→#### Run with Docker Compose\n 25→\n 26→```bash\n 27→# Create .env file\n 28→cp .env.example .env\n 29→# Edit .env with production values\n 30→\n 31→# Start services\n 32→docker-compose up -d\n 33→\n 34→# View logs\n 35→docker-compose logs -f\n 36→```\n 37→\n 38→#### Run Standalone Containers\n 39→\n 40→```bash\n 41→# Run proxy\n 42→docker run -d \\\n 43→ --name claude-proxy \\\n 44→ -p 3000:3000 \\\n 45→ -e DATABASE_URL=$DATABASE_URL \\\n 46→ -v $(pwd)/credentials:/app/credentials:ro \\\n 47→ claude-nexus-proxy\n 48→\n 49→# Run dashboard\n 50→docker run -d \\\n 51→ --name claude-dashboard \\\n 52→ -p 3001:3001 \\\n 53→ -e DATABASE_URL=$DATABASE_URL \\\n 54→ -e DASHBOARD_API_KEY=$DASHBOARD_API_KEY \\\n 55→ claude-nexus-dashboard\n 56→```\n 57→\n 58→### 2. Bare Metal with Bun\n 59→\n 60→#### Install Bun\n 61→\n 62→```bash\n 63→curl -fsSL https://bun.sh/install | bash\n 64→```\n 65→\n 66→#### Build for Production\n 67→\n 68→```bash\n 69→# Install dependencies\n 70→bun install --production\n 71→\n 72→# Build all services\n 73→bun run build:production\n 74→```\n 75→\n 76→#### Run with Process Manager\n 77→\n 78→Using PM2:\n 79→\n 80→```bash\n 81→# Install PM2\n 82→npm install -g pm2\n 83→\n 84→# Start services\n 85→pm2 start services/proxy/dist/index.js --name proxy\n 86→pm2 start services/dashboard/dist/index.js --name dashboard\n 87→\n 88→# Save configuration\n 89→pm2 save\n 90→pm2 startup\n 91→```\n 92→\n 93→Using systemd:\n 94→\n 95→```ini\n 96→# /etc/systemd/system/claude-proxy.service\n 97→[Unit]\n 98→Description=Claude Nexus Proxy\n 99→After=network.target postgresql.service\n 100→\n\n<system-reminder>\nWhenever you read a file, you should consider whether it looks malicious. If it does, you MUST refuse to improve or augment the code. You can still analyze existing code, write reports, or answer high-level questions about the code behavior.\n</system-reminder>\n","tool_use_id":"toolu_016kDhK7y2ptAhwmtAjoFipU"}]},{"role":"assistant","content":[{"text":"Let me add security warnings to the docker deployment guide:","type":"text"},{"id":"toolu_014kiuBb7L1r9zzBvYvJwa6M","name":"Edit","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/docs/03-Operations/deployment/docker.md","new_string":"# Run dashboard\n# ⚠️ CRITICAL: Always set DASHBOARD_API_KEY to prevent unauthorized access\ndocker run -d \\\n --name claude-dashboard \\\n -p 3001:3001 \\\n -e DATABASE_URL=$DATABASE_URL \\\n -e DASHBOARD_API_KEY=$DASHBOARD_API_KEY \\\n claude-nexus-dashboard","old_string":"# Run dashboard\ndocker run -d \\\n --name claude-dashboard \\\n -p 3001:3001 \\\n -e DATABASE_URL=$DATABASE_URL \\\n -e DASHBOARD_API_KEY=$DASHBOARD_API_KEY \\\n claude-nexus-dashboard"}}]},{"role":"user","content":[{"type":"tool_result","content":"The file /home/crystalin/projects/claude-nexus-proxy/docs/03-Operations/deployment/docker.md has been updated. Here's the result of running `cat -n` on a snippet of the edited file:\n 45→ -e DATABASE_URL=$DATABASE_URL \\\n 46→ -v $(pwd)/credentials:/app/credentials:ro \\\n 47→ claude-nexus-proxy\n 48→\n 49→# Run dashboard\n 50→# ⚠️ CRITICAL: Always set DASHBOARD_API_KEY to prevent unauthorized access\n 51→docker run -d \\\n 52→ --name claude-dashboard \\\n 53→ -p 3001:3001 \\\n 54→ -e DATABASE_URL=$DATABASE_URL \\\n 55→ -e DASHBOARD_API_KEY=$DASHBOARD_API_KEY \\\n 56→ claude-nexus-dashboard\n 57→```\n 58→\n 59→### 2. Bare Metal with Bun\n 60→","tool_use_id":"toolu_014kiuBb7L1r9zzBvYvJwa6M"}]},{"role":"assistant","content":[{"text":"Let me also add a security section to this deployment guide:","type":"text"},{"id":"toolu_01HXGLRArVQjfYemvZJ1iT1n","name":"Read","type":"tool_use","input":{"limit":100,"offset":200,"file_path":"/home/crystalin/projects/claude-nexus-proxy/docs/03-Operations/deployment/docker.md"}}]},{"role":"user","content":[{"type":"tool_result","content":"200→ proxy_set_header X-Real-IP $remote_addr;\n 201→ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n 202→\n 203→ # For streaming responses\n 204→ proxy_buffering off;\n 205→ proxy_cache off;\n 206→ }\n 207→}\n 208→\n 209→# Dashboard\n 210→server {\n 211→ listen 443 ssl http2;\n 212→ server_name dashboard.yourdomain.com;\n 213→\n 214→ ssl_certificate /path/to/cert.pem;\n 215→ ssl_certificate_key /path/to/key.pem;\n 216→\n 217→ location / {\n 218→ proxy_pass http://dashboard_backend;\n 219→ proxy_http_version 1.1;\n 220→ proxy_set_header Host $host;\n 221→ proxy_set_header X-Real-IP $remote_addr;\n 222→ }\n 223→\n 224→ # SSE endpoint\n 225→ location /sse {\n 226→ proxy_pass http://dashboard_backend/sse;\n 227→ proxy_http_version 1.1;\n 228→ proxy_set_header Connection \"\";\n 229→ proxy_buffering off;\n 230→ proxy_cache off;\n 231→ }\n 232→}\n 233→```\n 234→\n 235→#### Caddy Configuration\n 236→\n 237→```caddyfile\n 238→api.yourdomain.com {\n 239→ reverse_proxy localhost:3000 {\n 240→ flush_interval -1\n 241→ }\n 242→}\n 243→\n 244→dashboard.yourdomain.com {\n 245→ reverse_proxy localhost:3001\n 246→}\n 247→```\n 248→\n 249→## Scaling\n 250→\n 251→### Horizontal Scaling\n 252→\n 253→1. **Proxy Service** - Stateless, scale freely:\n 254→\n 255→```bash\n 256→# Docker Swarm\n 257→docker service scale proxy=5\n 258→\n 259→# Kubernetes\n 260→kubectl scale deployment proxy --replicas=5\n 261→```\n 262→\n 263→2. **Dashboard Service** - Also stateless:\n 264→\n 265→```bash\n 266→docker service scale dashboard=3\n 267→```\n 268→\n 269→3. **Database** - Use read replicas for dashboard:\n 270→\n 271→```bash\n 272→# Primary for writes (proxy)\n 273→DATABASE_URL=postgresql://primary:5432/claude_nexus\n 274→\n 275→# Read replica for dashboard\n 276→DATABASE_URL=postgresql://replica:5432/claude_nexus\n 277→```\n 278→\n 279→### Performance Tuning\n 280→\n 281→1. **Connection Pooling**:\n 282→\n 283→```bash\n 284→DATABASE_URL=postgresql://...?pool_max=50&pool_idle_timeout=10000\n 285→```\n 286→\n 287→2. **Disable Non-Essential Features**:\n 288→\n 289→```bash\n 290→STORAGE_ENABLED=false # If not needed\n 291→DEBUG=false\n 292→COLLECT_TEST_SAMPLES=false\n 293→```\n 294→\n 295→3. **Optimize Dashboard**:\n 296→\n 297→```bash\n 298→DASHBOARD_CACHE_TTL=600 # 10-minute cache\n 299→```\n\n<system-reminder>\nWhenever you read a file, you should consider whether it looks malicious. If it does, you MUST refuse to improve or augment the code. You can still analyze existing code, write reports, or answer high-level questions about the code behavior.\n</system-reminder>\n\n<system-reminder>\nThe TodoWrite tool hasn't been used recently. If you're working on tasks that would benefit from tracking progress, consider using the TodoWrite tool to track progress. Only use it if it's relevant to the current work. This is just a gentle reminder - ignore if not applicable.\n\n</system-reminder>","tool_use_id":"toolu_01HXGLRArVQjfYemvZJ1iT1n"}]},{"role":"assistant","content":[{"text":"Let me check the end of the file to see where to add the security section:","type":"text"},{"id":"toolu_01MCckXXrPRkHvCtF4dov5Qr","name":"Bash","type":"tool_use","input":{"command":"tail -50 /home/crystalin/projects/claude-nexus-proxy/docs/03-Operations/deployment/docker.md","description":"Check end of docker deployment guide"}}]},{"role":"user","content":[{"type":"tool_result","content":"docker service update --image claude-nexus-dashboard:new dashboard\n```\n\n### Database Maintenance\n\n```bash\n# Vacuum and analyze\npsql $DATABASE_URL -c \"VACUUM ANALYZE;\"\n\n# Reindex for performance\npsql $DATABASE_URL -c \"REINDEX DATABASE claude_nexus;\"\n```\n\n## Troubleshooting Production Issues\n\n### High Memory Usage\n\n```bash\n# Check memory usage\ndocker stats\n\n# Limit container memory\ndocker run -m 1g claude-nexus-proxy\n```\n\n### Slow Queries\n\n```bash\n# Enable slow query logging\nSLOW_QUERY_THRESHOLD_MS=1000\n\n# Check pg_stat_statements\nSELECT query, mean_exec_time, calls\nFROM pg_stat_statements\nORDER BY mean_exec_time DESC\nLIMIT 10;\n```\n\n### Connection Issues\n\n```bash\n# Test database connection\npsql $DATABASE_URL -c \"SELECT 1;\"\n\n# Check proxy logs\ndocker logs proxy --tail 100\n\n# Verify credentials\nls -la credentials/\n```","is_error":false,"tool_use_id":"toolu_01MCckXXrPRkHvCtF4dov5Qr"}]},{"role":"assistant","content":[{"id":"toolu_016DojYQCR2hACNVRgd8zZrW","name":"Edit","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/docs/03-Operations/deployment/docker.md","new_string":"# Verify credentials\nls -la credentials/\n```\n\n## Security Considerations\n\n### ⚠️ CRITICAL: Dashboard Authentication\n\n**Never deploy the dashboard without setting `DASHBOARD_API_KEY`!**\n\nWhen `DASHBOARD_API_KEY` is not set, the dashboard runs in \"read-only mode\" with NO authentication, exposing:\n- All conversation histories\n- Token usage and costs\n- Account information\n- AI analysis results\n- Potentially sensitive customer data\n\n**Production Security Checklist:**\n\n```bash\n# 1. ALWAYS set DASHBOARD_API_KEY (minimum 32 characters)\nexport DASHBOARD_API_KEY=$(openssl rand -base64 32)\n\n# 2. Verify it's set before deployment\nif [ -z \"$DASHBOARD_API_KEY\" ]; then\n echo \"ERROR: DASHBOARD_API_KEY not set!\"\n exit 1\nfi\n\n# 3. Never expose dashboard port directly to internet\n# Use reverse proxy with additional authentication\n# Block port 3001 at firewall level\n\n# 4. Test authentication is working\ncurl -I http://localhost:3001/dashboard\n# Should return 302 redirect to login\n```\n\n### Network Security\n\n1. **Firewall Rules**:\n - Only expose reverse proxy ports (80/443)\n - Block direct access to service ports (3000/3001)\n - Whitelist specific IPs if possible\n\n2. **Internal Network Only**:\n ```bash\n # Docker: Use internal network\n docker run --network internal ...\n \n # Or bind to localhost only\n docker run -p 127.0.0.1:3001:3001 ...\n ```\n\n3. **Additional Authentication Layer**:\n - Consider basic auth at reverse proxy level\n - Use VPN for dashboard access\n - Implement IP whitelisting\n\nSee the [Security Guide](../security.md) for comprehensive security information.","old_string":"# Verify credentials\nls -la credentials/\n```"}}]},{"role":"user","content":[{"type":"tool_result","content":"The file /home/crystalin/projects/claude-nexus-proxy/docs/03-Operations/deployment/docker.md has been updated. Here's the result of running `cat -n` on a snippet of the edited file:\n 480→\n 481→# Check proxy logs\n 482→docker logs proxy --tail 100\n 483→\n 484→# Verify credentials\n 485→ls -la credentials/\n 486→```\n 487→\n 488→## Security Considerations\n 489→\n 490→### ⚠️ CRITICAL: Dashboard Authentication\n 491→\n 492→**Never deploy the dashboard without setting `DASHBOARD_API_KEY`!**\n 493→\n 494→When `DASHBOARD_API_KEY` is not set, the dashboard runs in \"read-only mode\" with NO authentication, exposing:\n 495→- All conversation histories\n 496→- Token usage and costs\n 497→- Account information\n 498→- AI analysis results\n 499→- Potentially sensitive customer data\n 500→\n 501→**Production Security Checklist:**\n 502→\n 503→```bash\n 504→# 1. ALWAYS set DASHBOARD_API_KEY (minimum 32 characters)\n 505→export DASHBOARD_API_KEY=$(openssl rand -base64 32)\n 506→\n 507→# 2. Verify it's set before deployment\n 508→if [ -z \"$DASHBOARD_API_KEY\" ]; then\n 509→ echo \"ERROR: DASHBOARD_API_KEY not set!\"\n 510→ exit 1\n 511→fi\n 512→\n 513→# 3. Never expose dashboard port directly to internet\n 514→# Use reverse proxy with additional authentication\n 515→# Block port 3001 at firewall level\n 516→\n 517→# 4. Test authentication is working\n 518→curl -I http://localhost:3001/dashboard\n 519→# Should return 302 redirect to login\n 520→```\n 521→\n 522→### Network Security\n 523→\n 524→1. **Firewall Rules**:\n 525→ - Only expose reverse proxy ports (80/443)\n 526→ - Block direct access to service ports (3000/3001)\n 527→ - Whitelist specific IPs if possible\n 528→\n 529→2. **Internal Network Only**:\n 530→ ```bash\n 531→ # Docker: Use internal network\n 532→ docker run --network internal ...\n 533→ \n 534→ # Or bind to localhost only\n 535→ docker run -p 127.0.0.1:3001:3001 ...\n 536→ ```\n 537→\n 538→3. **Additional Authentication Layer**:\n 539→ - Consider basic auth at reverse proxy level\n 540→ - Use VPN for dashboard access\n 541→ - Implement IP whitelisting\n 542→\n 543→See the [Security Guide](../security.md) for comprehensive security information.\n 544→","tool_use_id":"toolu_016DojYQCR2hACNVRgd8zZrW"}]},{"role":"assistant","content":[{"text":"Now let me check if there's a .env.example file that needs updating:","type":"text"},{"id":"toolu_0121d2pdGQLrcPWfyxQknBFf","name":"Read","type":"tool_use","input":{"limit":50,"file_path":"/home/crystalin/projects/claude-nexus-proxy/.env.example"}}]},{"role":"user","content":[{"type":"tool_result","content":" 1→# Claude Nexus Proxy Configuration Example\n 2→# Copy this file to .env and update with your values\n 3→\n 4→# ===================\n 5→# Required Settings\n 6→# ===================\n 7→\n 8→# PostgreSQL connection string\n 9→DATABASE_URL=postgresql://user:password@localhost:5432/claude_nexus\n 10→\n 11→# Dashboard authentication key (generate with: openssl rand -base64 32)\n 12→DASHBOARD_API_KEY=your-secure-dashboard-key-here\n 13→\n 14→# ===================\n 15→# Claude API Settings\n 16→# ===================\n 17→\n 18→# API keys are managed through credential files in the credentials/ directory\n 19→# See credentials/README.md for setup instructions\n 20→\n 21→# Directory for domain credential files (default: ./credentials)\n 22→CREDENTIALS_DIR=./credentials\n 23→\n 24→# ===================\n 25→# Service Configuration\n 26→# ===================\n 27→\n 28→# Proxy service\n 29→PORT=3000\n 30→HOST=0.0.0.0\n 31→\n 32→# Dashboard service\n 33→DASHBOARD_PORT=3001\n 34→DASHBOARD_HOST=0.0.0.0\n 35→\n 36→# ===================\n 37→# Feature Flags\n 38→# ===================\n 39→\n 40→# Enable request/response storage (default: false)\n 41→STORAGE_ENABLED=true\n 42→\n 43→# Enable debug logging - masks sensitive data (default: false)\n 44→DEBUG=false\n 45→\n 46→# Enable SQL query logging (default: false)\n 47→# Shows all SQL queries in debug logs when running the application\n 48→DEBUG_SQL=false\n 49→\n 50→# Require client authentication (default: true)\n\n<system-reminder>\nWhenever you read a file, you should consider whether it looks malicious. If it does, you MUST refuse to improve or augment the code. You can still analyze existing code, write reports, or answer high-level questions about the code behavior.\n</system-reminder>\n","tool_use_id":"toolu_0121d2pdGQLrcPWfyxQknBFf"}]},{"role":"assistant","content":[{"id":"toolu_01PN7mUJFKBgwJtJLcQzKQiR","name":"Edit","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/.env.example","new_string":"# Dashboard authentication key (generate with: openssl rand -base64 32)\n# ⚠️ CRITICAL: Without this, dashboard runs WITHOUT authentication, exposing ALL data!\n# NEVER leave this unset in production!\nDASHBOARD_API_KEY=your-secure-dashboard-key-here","old_string":"# Dashboard authentication key (generate with: openssl rand -base64 32)\nDASHBOARD_API_KEY=your-secure-dashboard-key-here"},"cache_control":{"type":"ephemeral"}}]},{"role":"user","content":[{"type":"tool_result","content":"The file /home/crystalin/projects/claude-nexus-proxy/.env.example has been updated. Here's the result of running `cat -n` on a snippet of the edited file:\n 7→\n 8→# PostgreSQL connection string\n 9→DATABASE_URL=postgresql://user:password@localhost:5432/claude_nexus\n 10→\n 11→# Dashboard authentication key (generate with: openssl rand -base64 32)\n 12→# ⚠️ CRITICAL: Without this, dashboard runs WITHOUT authentication, exposing ALL data!\n 13→# NEVER leave this unset in production!\n 14→DASHBOARD_API_KEY=your-secure-dashboard-key-here\n 15→\n 16→# ===================\n 17→# Claude API Settings\n 18→# ===================","tool_use_id":"toolu_01PN7mUJFKBgwJtJLcQzKQiR","cache_control":{"type":"ephemeral"}}]}],"metadata":{"user_id":"user_claude-1_account__session_5ec02b7e-af54-4c6b-a37e-280e602dba22"},"max_tokens":32000,"temperature":1}

{"id":"msg_01DGeHY3EjSQFyG2AqyR5MGU","role":"assistant","type":"message","model":"claude-opus-4-20250514","usage":{"input_tokens":2,"service_tier":"standard","output_tokens":98,"cache_read_input_tokens":70550,"cache_creation_input_tokens":414},"content":[{"text":"Finally, let me update the ADR index to include the new ADR:","type":"text"},{"id":"toolu_01WFSyD2BnWSoND6Zv93Hbs7","name":"Read","type":"tool_use","input":{"file_path":"/home/crystalin/projects/claude-nexus-proxy/docs/04-Architecture/ADRs/README.md"}}],"stop_reason":"tool_use","stop_sequence":null}

[]

null

null

null

{"id":"0d8ba4ac-92ed-417f-a494-65f1a10dc911","domain":"localhost:3000","timestamp":"2025-07-23T08:40:59.846Z","method":"POST","endpoint":"/v1/messages","model":"claude-opus-4-20250514","inputTokens":2,"outputTokens":98,"totalTokens":100,"durationMs":5505,"responseStatus":200,"streaming":false}