## Agent Tools v1.0.json

```json
[
  {
    "description": "Find snippets of code from the codebase most relevant to the search query.\nThis is a semantic search tool, so the query should ask for something semantically matching what is needed.\nIf it makes sense to only search in particular directories, please specify them in the target_directories field.\nUnless there is a clear reason to use your own search query, please just reuse the user's exact query with their wording.\nTheir exact wording/phrasing can often be helpful for the semantic search query. Keeping the same exact question format can also be helpful.",
    "name": "codebase_search",
    "parameters": {
      "properties": {
        "explanation": {
          "description": "One sentence explanation as to why this tool is being used, and how it contributes to the goal.",
          "type": "string"
        },
        "query": {
          "description": "The search query to find relevant code. You should reuse the user's exact query/most recent message with their wording unless there is a clear reason not to.",
          "type": "string"
        },
        "target_directories": {
          "description": "Glob patterns for directories to search over",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "query"
      ],
      "type": "object"
    }
  },
  {
    "description": "Read the contents of a file. the output of this tool call will be the 1-indexed file contents from start_line_one_indexed to end_line_one_indexed_inclusive, together with a summary of the lines outside start_line_one_indexed and end_line_one_indexed_inclusive.\nNote that this call can view at most 250 lines at a time and 200 lines minimum.\n\nWhen using this tool to gather information, it's your responsibility to ensure you have the COMPLETE context. Specifically, each time you call this command you should:\n1) Assess if the contents you viewed are sufficient to proceed with your task.\n2) Take note of where there are lines not shown.\n3) If the file contents you have viewed are insufficient, and you suspect they may be in lines not shown, proactively call the tool again to view those lines.\n4) When in doubt, call this tool again to gather more information. Remember that partial file views may miss critical dependencies, imports, or functionality.\n\nIn some cases, if reading a range of lines is not enough, you may choose to read the entire file.\nReading entire files is often wasteful and slow, especially for large files (i.e. more than a few hundred lines). So you should use this option sparingly.\nReading the entire file is not allowed in most cases. You are only allowed to read the entire file if it has been edited or manually attached to the conversation by the user.",
    "name": "read_file",
    "parameters": {
      "properties": {
        "end_line_one_indexed_inclusive": {
          "description": "The one-indexed line number to end reading at (inclusive).",
          "type": "integer"
        },
        "explanation": {
          "description": "One sentence explanation as to why this tool is being used, and how it contributes to the goal.",
          "type": "string"
        },
        "should_read_entire_file": {
          "description": "Whether to read the entire file. Defaults to false.",
          "type": "boolean"
        },
        "start_line_one_indexed": {
          "description": "The one-indexed line number to start reading from (inclusive).",
          "type": "integer"
        },
        "target_file": {
          "description": "The path of the file to read. You can use either a relative path in the workspace or an absolute path. If an absolute path is provided, it will be preserved as is.",
          "type": "string"
        }
      },
      "required": [
        "target_file",
        "should_read_entire_file",
        "start_line_one_indexed",
        "end_line_one_indexed_inclusive"
      ],
      "type": "object"
    }
  },
  {
    "description": "PROPOSE a command to run on behalf of the user.\nIf you have this tool, note that you DO have the ability to run commands directly on the USER's system.\nNote that the user will have to approve the command before it is executed.\nThe user may reject it if it is not to their liking, or may modify the command before approving it.  If they do change it, take those changes into account.\nThe actual command will NOT execute until the user approves it. The user may not approve it immediately. Do NOT assume the command has started running.\nIf the step is WAITING for user approval, it has NOT started running.\nIn using these tools, adhere to the following guidelines:\n1. Based on the contents of the conversation, you will be told if you are in the same shell as a previous step or a different shell.\n2. If in a new shell, you should `cd` to the appropriate directory and do necessary setup in addition to running the command.\n3. If in the same shell, LOOK IN CHAT HISTORY for your current working directory.\n4. For ANY commands that would require user interaction, ASSUME THE USER IS NOT AVAILABLE TO INTERACT and PASS THE NON-INTERACTIVE FLAGS (e.g. --yes for npx).\n5. If the command would use a pager, append ` | cat` to the command.\n6. For commands that are long running/expected to run indefinitely until interruption, please run them in the background. To run jobs in the background, set `is_background` to true rather than changing the details of the command.\n7. Dont include any newlines in the command.",
    "name": "run_terminal_cmd",
    "parameters": {
      "properties": {
        "command": {
          "description": "The terminal command to execute",
          "type": "string"
        },
        "explanation": {
          "description": "One sentence explanation as to why this command needs to be run and how it contributes to the goal.",
          "type": "string"
        },
        "is_background": {
          "description": "Whether the command should be run in the background",
          "type": "boolean"
        }
      },
      "required": [
        "command",
        "is_background"
      ],
      "type": "object"
    }
  },
  {
    "description": "List the contents of a directory. The quick tool to use for discovery, before using more targeted tools like semantic search or file reading. Useful to try to understand the file structure before diving deeper into specific files. Can be used to explore the codebase.",
    "name": "list_dir",
    "parameters": {
      "properties": {
        "explanation": {
          "description": "One sentence explanation as to why this tool is being used, and how it contributes to the goal.",
          "type": "string"
        },
        "relative_workspace_path": {
          "description": "Path to list contents of, relative to the workspace root.",
          "type": "string"
        }
      },
      "required": [
        "relative_workspace_path"
      ],
      "type": "object"
    }
  },
  {
    "description": "### Instructions:\nThis is best for finding exact text matches or regex patterns.\nThis is preferred over semantic search when we know the exact symbol/function name/etc. to search in some set of directories/file types.\n\nUse this tool to run fast, exact regex searches over text files using the `ripgrep` engine.\nTo avoid overwhelming output, the results are capped at 50 matches.\nUse the include or exclude patterns to filter the search scope by file type or specific paths.\n\n- Always escape special regex characters: ( ) [ ] { } + * ? ^ $ | . \\\n- Use `\\` to escape any of these characters when they appear in your search string.\n- Do NOT perform fuzzy or semantic matches.\n- Return only a valid regex pattern string.\n\n### Examples:\n| Literal               | Regex Pattern            |\n|-----------------------|--------------------------|\n| function(             | function\\(              |\n| value[index]          | value\\[index\\]         |\n| file.txt               | file\\.txt                |\n| user|admin            | user\\|admin             |\n| path\\to\\file         | path\\\\to\\\\file        |\n| hello world           | hello world              |\n| foo\\(bar\\)          | foo\\\\(bar\\\\)         |",
    "name": "grep_search",
    "parameters": {
      "properties": {
        "case_sensitive": {
          "description": "Whether the search should be case sensitive",
          "type": "boolean"
        },
        "exclude_pattern": {
          "description": "Glob pattern for files to exclude",
          "type": "string"
        },
        "explanation": {
          "description": "One sentence explanation as to why this tool is being used, and how it contributes to the goal.",
          "type": "string"
        },
        "include_pattern": {
          "description": "Glob pattern for files to include (e.g. '*.ts' for TypeScript files)",
          "type": "string"
        },
        "query": {
          "description": "The regex pattern to search for",
          "type": "string"
        }
      },
      "required": [
        "query"
      ],
      "type": "object"
    }
  },
  {
    "description": "Use this tool to propose an edit to an existing file or create a new file.\n\nThis will be read by a less intelligent model, which will quickly apply the edit. You should make it clear what the edit is, while also minimizing the unchanged code you write.\nWhen writing the edit, you should specify each edit in sequence, with the special comment `// ... existing code ...` to represent unchanged code in between edited lines.\n\nFor example:\n\n```\n// ... existing code ...\nFIRST_EDIT\n// ... existing code ...\nSECOND_EDIT\n// ... existing code ...\nTHIRD_EDIT\n// ... existing code ...\n```\n\nYou should still bias towards repeating as few lines of the original file as possible to convey the change.\nBut, each edit should contain sufficient context of unchanged lines around the code you're editing to resolve ambiguity.\nDO NOT omit spans of pre-existing code (or comments) without using the `// ... existing code ...` comment to indicate its absence. If you omit the existing code comment, the model may inadvertently delete these lines.\nMake sure it is clear what the edit should be, and where it should be applied.\nTo create a new file, simply specify the content of the file in the `code_edit` field.\n\nYou should specify the following arguments before the others: [target_file]\n\nALWAYS make all edits to a file in a single edit_file instead of multiple edit_file calls to the same file. The apply model can handle many distinct edits at once. When editing multiple files, ALWAYS make parallel edit_file calls.",
    "name": "edit_file",
    "parameters": {
      "properties": {
        "code_edit": {
          "description": "Specify ONLY the precise lines of code that you wish to edit. **NEVER specify or write out unchanged code**. Instead, represent all unchanged code using the comment of the language you're editing in - example: `// ... existing code ...`",
          "type": "string"
        },
        "instructions": {
          "description": "A single sentence instruction describing what you are going to do for the sketched edit. This is used to assist the less intelligent model in applying the edit. Please use the first person to describe what you are going to do. Dont repeat what you have said previously in normal messages. And use it to disambiguate uncertainty in the edit.",
          "type": "string"
        },
        "target_file": {
          "description": "The target file to modify. Always specify the target file as the first argument. You can use either a relative path in the workspace or an absolute path. If an absolute path is provided, it will be preserved as is.",
          "type": "string"
        }
      },
      "required": [
        "target_file",
        "instructions",
        "code_edit"
      ],
      "type": "object"
    }
  },
  {
    "description": "Use this tool to propose a search and replace operation on an existing file.\n\nThe tool will replace ONE occurrence of old_string with new_string in the specified file.\n\nCRITICAL REQUIREMENTS FOR USING THIS TOOL:\n\n1. UNIQUENESS: The old_string MUST uniquely identify the specific instance you want to change. This means:\n   - Include AT LEAST 3-5 lines of context BEFORE the change point\n   - Include AT LEAST 3-5 lines of context AFTER the change point\n   - Include all whitespace, indentation, and surrounding code exactly as it appears in the file\n\n2. SINGLE INSTANCE: This tool can only change ONE instance at a time. If you need to change multiple instances:\n   - Make separate calls to this tool for each instance\n   - Each call must uniquely identify its specific instance using extensive context\n\n3. VERIFICATION: Before using this tool:\n   - If multiple instances exist, gather enough context to uniquely identify each one\n   - Plan separate tool calls for each instance\n",
    "name": "search_replace",
    "parameters": {
      "properties": {
        "file_path": {
          "description": "The path to the file you want to search and replace in. You can use either a relative path in the workspace or an absolute path. If an absolute path is provided, it will be preserved as is.",
          "type": "string"
        },
        "new_string": {
          "description": "The edited text to replace the old_string (must be different from the old_string)",
          "type": "string"
        },
        "old_string": {
          "description": "The text to replace (must be unique within the file, and must match the file contents exactly, including all whitespace and indentation)",
          "type": "string"
        }
      },
      "required": [
        "file_path",
        "old_string",
        "new_string"
      ],
      "type": "object"
    }
  },
  {
    "description": "Fast file search based on fuzzy matching against file path. Use if you know part of the file path but don't know where it's located exactly. Response will be capped to 10 results. Make your query more specific if need to filter results further.",
    "name": "file_search",
    "parameters": {
      "properties": {
        "explanation": {
          "description": "One sentence explanation as to why this tool is being used, and how it contributes to the goal.",
          "type": "string"
        },
        "query": {
          "description": "Fuzzy filename to search for",
          "type": "string"
        }
      },
      "required": [
        "query",
        "explanation"
      ],
      "type": "object"
    }
  },
  {
    "description": "Deletes a file at the specified path. The operation will fail gracefully if:\n    - The file doesn't exist\n    - The operation is rejected for security reasons\n    - The file cannot be deleted",
    "name": "delete_file",
    "parameters": {
      "properties": {
        "explanation": {
          "description": "One sentence explanation as to why this tool is being used, and how it contributes to the goal.",
          "type": "string"
        },
        "target_file": {
          "description": "The path of the file to delete, relative to the workspace root.",
          "type": "string"
        }
      },
      "required": [
        "target_file"
      ],
      "type": "object"
    }
  },
  {
    "description": "Calls a smarter model to apply the last edit to the specified file.\nUse this tool immediately after the result of an edit_file tool call ONLY IF the diff is not what you expected, indicating the model applying the changes was not smart enough to follow your instructions.",
    "name": "reapply",
    "parameters": {
      "properties": {
        "target_file": {
          "description": "The relative path to the file to reapply the last edit to. You can use either a relative path in the workspace or an absolute path. If an absolute path is provided, it will be preserved as is.",
          "type": "string"
        }
      },
      "required": [
        "target_file"
      ],
      "type": "object"
    }
  },
  {
    "description": "Search the web for real-time information about any topic. Use this tool when you need up-to-date information that might not be available in your training data, or when you need to verify current facts. The search results will include relevant snippets and URLs from web pages. This is particularly useful for questions about current events, technology updates, or any topic that requires recent information.",
    "name": "web_search",
    "parameters": {
      "properties": {
        "explanation": {
          "description": "One sentence explanation as to why this tool is being used, and how it contributes to the goal.",
          "type": "string"
        },
        "search_term": {
          "description": "The search term to look up on the web. Be specific and include relevant keywords for better results. For technical queries, include version numbers or dates if relevant.",
          "type": "string"
        }
      },
      "required": [
        "search_term"
      ],
      "type": "object"
    }
  },
  {
    "description": "Creates a Mermaid diagram that will be rendered in the chat UI. Provide the raw Mermaid DSL string via `content`.\nUse <br/> for line breaks, always wrap diagram texts/tags in double quotes, do not use custom colors, do not use :::, and do not use beta features.\nThe diagram will be pre-rendered to validate syntax - if there are any Mermaid syntax errors, they will be returned in the response so you can fix them.",
    "name": "create_diagram",
    "parameters": {
      "properties": {
        "content": {
          "description": "Raw Mermaid diagram definition (e.g., 'graph TD; A-->B;').",
          "type": "string"
        }
      },
      "required": [
        "content"
      ],
      "type": "object"
    }
  },
  {
    "description": "Use this tool to edit a jupyter notebook cell. Use ONLY this tool to edit notebooks.\n\nThis tool supports editing existing cells and creating new cells:\n\t- If you need to edit an existing cell, set 'is_new_cell' to false and provide the 'old_string' and 'new_string'.\n\t\t-- The tool will replace ONE occurrence of 'old_string' with 'new_string' in the specified cell.\n\t- If you need to create a new cell, set 'is_new_cell' to true and provide the 'new_string' (and keep 'old_string' empty).\n\t- It's critical that you set the 'is_new_cell' flag correctly!\n\t- This tool does NOT support cell deletion, but you can delete the content of a cell by passing an empty string as the 'new_string'.\n\nOther requirements:\n\t- Cell indices are 0-based.\n\t- 'old_string' and 'new_string' should be a valid cell content, i.e. WITHOUT any JSON syntax that notebook files use under the hood.\n\t- The old_string MUST uniquely identify the specific instance you want to change. This means:\n\t\t-- Include AT LEAST 3-5 lines of context BEFORE the change point\n\t\t-- Include AT LEAST 3-5 lines of context AFTER the change point\n\t- This tool can only change ONE instance at a time. If you need to change multiple instances:\n\t\t-- Make separate calls to this tool for each instance\n\t\t-- Each call must uniquely identify its specific instance using extensive context\n\t- This tool might save markdown cells as \"raw\" cells. Don't try to change it, it's fine. We need it to properly display the diff.\n\t- If you need to create a new notebook, just set 'is_new_cell' to true and cell_idx to 0.\n\t- ALWAYS generate arguments in the following order: target_notebook, cell_idx, is_new_cell, cell_language, old_string, new_string.\n\t- Prefer editing existing cells over creating new ones!\n",
    "name": "edit_notebook",
    "parameters": {
      "properties": {
        "cell_idx": {
          "description": "The index of the cell to edit (0-based)",
          "type": "number"
        },
        "cell_language": {
          "description": "The language of the cell to edit. Should be STRICTLY one of these: 'python', 'markdown', 'javascript', 'typescript', 'r', 'sql', 'shell', 'raw' or 'other'.",
          "type": "string"
        },
        "is_new_cell": {
          "description": "If true, a new cell will be created at the specified cell index. If false, the cell at the specified cell index will be edited.",
          "type": "boolean"
        },
        "new_string": {
          "description": "The edited text to replace the old_string or the content for the new cell.",
          "type": "string"
        },
        "old_string": {
          "description": "The text to replace (must be unique within the cell, and must match the cell contents exactly, including all whitespace and indentation).",
          "type": "string"
        },
        "target_notebook": {
          "description": "The path to the notebook file you want to edit. You can use either a relative path in the workspace or an absolute path. If an absolute path is provided, it will be preserved as is.",
          "type": "string"
        }
      },
      "required": [
        "target_notebook",
        "cell_idx",
        "is_new_cell",
        "cell_language",
        "old_string",
        "new_string"
      ],
      "type": "object"
    }
  }
]
```