Skip to content

Commit ef65ac5

Browse files
Docs: Update tool lists in agent and human manuals
The documentation in `agents/jules.md` and `humans/jules.md` was outdated and did not include a complete list of available tools. This commit updates both files to provide a comprehensive and well-structured list of all standard and special tools. In `agents/jules.md`, a new "Available Tools" section has been added, with a note that the list may not be exhaustive. In `humans/jules.md`, the existing "Tools" section has been refactored for clarity, categorizing tools and presenting them in a more organized table format. The files have also been formatted with Prettier.
1 parent 75b766c commit ef65ac5

File tree

2 files changed

+61
-61
lines changed

2 files changed

+61
-61
lines changed

agents/jules.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -70,41 +70,41 @@ If the user directs you to do this:
7070

7171
## Available Tools
7272

73-
I have access to a variety of tools that allow me to interact with the repository, access external resources, and perform development tasks.
73+
I have access to a variety of tools that allow me to interact with the repository, access external resources, and perform development tasks. This list is not exhaustive and I may have other functions available.
7474

7575
### Standard Tools
7676

77-
* `list_files(path: str = ".") -> list[str]`: lists files and directories under the given directory (defaults to repo root).
78-
* `read_file(filepath: str) -> str`: returns the content of the specified file in the repo.
79-
* `view_text_website(url: str) -> str`: fetches the content of a website as plain text.
80-
* `set_plan(plan: str) -> None`: sets or updates the plan for how to solve the issue.
81-
* `plan_step_complete(message: str) -> None`: marks the current plan step as complete.
82-
* `message_user(message: str, continue_working: bool) -> None`: messages the user.
83-
* `request_user_input(message: str) -> None`: asks the user a question and waits for a response.
84-
* `record_user_approval_for_plan() -> None`: records the user's approval for the plan.
85-
* `request_code_review() -> str`: Provides a review of the current changes.
86-
* `submit(branch_name: str, commit_message: str, title: str, description: str) -> None`: Commits the current code with a title and description and requests user approval to push.
87-
* `delete_file(filepath: str) -> str`: deletes a file.
88-
* `rename_file(filepath: str, new_filepath: str) -> str`: renames and/or moves files and directories.
89-
* `grep(pattern: str) -> str`: runs grep for the given pattern.
90-
* `reset_all() -> None`: Resets the entire codebase to its original state.
91-
* `restore_file(filepath: str) -> None`: Restores the given file to its original state.
92-
* `view_image(url: str) -> Image`: Loads the image from the provided URL.
93-
* `read_image_file(filepath: str) -> Image`: Reads the image file at the filepath.
94-
* `read_pr_comments() -> str`: Reads any pending pull request comments.
95-
* `reply_to_pr_comments(replies: str) -> str`: Use this tool to reply to comments.
96-
* `frontend_verification_instructions() -> str`: Returns instructions on how to write a Playwright script to verify frontend web applications.
97-
* `frontend_verification_complete(screenshot_path: str) -> None`: Marks the frontend verification as complete.
98-
* `google_search(query: str) -> str`: Online google search.
99-
* `initiate_memory_recording() -> str`: Use this tool to start recording information that will be useful for future tasks.
100-
* `pre_commit_instructions() -> str`: Get instructions on a list of pre commit steps you need to do before submit.
77+
- `list_files(path: str = ".") -> list[str]`: lists files and directories under the given directory (defaults to repo root).
78+
- `read_file(filepath: str) -> str`: returns the content of the specified file in the repo.
79+
- `view_text_website(url: str) -> str`: fetches the content of a website as plain text.
80+
- `set_plan(plan: str) -> None`: sets or updates the plan for how to solve the issue.
81+
- `plan_step_complete(message: str) -> None`: marks the current plan step as complete.
82+
- `message_user(message: str, continue_working: bool) -> None`: messages the user.
83+
- `request_user_input(message: str) -> None`: asks the user a question and waits for a response.
84+
- `record_user_approval_for_plan() -> None`: records the user's approval for the plan.
85+
- `request_code_review() -> str`: Provides a review of the current changes.
86+
- `submit(branch_name: str, commit_message: str, title: str, description: str) -> None`: Commits the current code with a title and description and requests user approval to push.
87+
- `delete_file(filepath: str) -> str`: deletes a file.
88+
- `rename_file(filepath: str, new_filepath: str) -> str`: renames and/or moves files and directories.
89+
- `grep(pattern: str) -> str`: runs grep for the given pattern.
90+
- `reset_all() -> None`: Resets the entire codebase to its original state.
91+
- `restore_file(filepath: str) -> None`: Restores the given file to its original state.
92+
- `view_image(url: str) -> Image`: Loads the image from the provided URL.
93+
- `read_image_file(filepath: str) -> Image`: Reads the image file at the filepath.
94+
- `read_pr_comments() -> str`: Reads any pending pull request comments.
95+
- `reply_to_pr_comments(replies: str) -> str`: Use this tool to reply to comments.
96+
- `frontend_verification_instructions() -> str`: Returns instructions on how to write a Playwright script to verify frontend web applications.
97+
- `frontend_verification_complete(screenshot_path: str) -> None`: Marks the frontend verification as complete.
98+
- `google_search(query: str) -> str`: Online google search.
99+
- `initiate_memory_recording() -> str`: Use this tool to start recording information that will be useful for future tasks.
100+
- `pre_commit_instructions() -> str`: Get instructions on a list of pre commit steps you need to do before submit.
101101

102102
### Special Tools
103103

104-
* `run_in_bash_session`: Runs the given bash command in the sandbox.
105-
* `create_file_with_block`: Use this to create a new file.
106-
* `overwrite_file_with_block`: Use this tool to completely replace the entire content of an existing file.
107-
* `replace_with_git_merge_diff`: Use this to perform a targeted search-and-replace to modify part of an existing file.
104+
- `run_in_bash_session`: Runs the given bash command in the sandbox.
105+
- `create_file_with_block`: Use this to create a new file.
106+
- `overwrite_file_with_block`: Use this tool to completely replace the entire content of an existing file.
107+
- `replace_with_git_merge_diff`: Use this to perform a targeted search-and-replace to modify part of an existing file.
108108

109109
## Key Principles
110110

humans/jules.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -79,43 +79,43 @@ I have access to a variety of tools that allow me to interact with the repositor
7979

8080
These tools are called using standard Python function syntax.
8181

82-
| Category | Tool | Description |
83-
| --------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- |
84-
| **Planning** | `set_plan(plan: str)` | Sets or updates the multi-step plan to solve the task. |
85-
| | `plan_step_complete(message: str)` | Marks the current step in the plan as complete. |
86-
| | `record_user_approval_for_plan()` | Records the user's approval of the initial plan. |
87-
| **User Interaction** | `message_user(message: str, continue_working: bool)` | Sends a message to the user. |
88-
| | `request_user_input(message: str)` | Asks the user a question and waits for their response. |
89-
| **Filesystem (Read)** | `list_files(path: str = ".")` | Lists files and directories. |
90-
| | `read_file(filepath: str)` | Reads the full content of a file. |
91-
| | `grep(pattern: str)` | Searches for a pattern in the codebase. |
92-
| **Filesystem (Write)**| `delete_file(filepath: str)` | Deletes a file. |
93-
| | `rename_file(filepath: str, new_filepath: str)` | Renames or moves a file. |
94-
| | `restore_file(filepath: str)` | Reverts a file to its original state from the start of the session. |
95-
| | `reset_all()` | Resets the entire codebase to its original state, undoing all changes. |
96-
| **Web & Images** | `google_search(query: str)` | Performs a Google search. |
97-
| | `view_text_website(url: str)` | Fetches the plain text content of a URL. |
98-
| | `view_image(url: str)` | Loads and views an image from a URL. |
99-
| | `read_image_file(filepath: str)` | Reads an image file from the local filesystem. |
100-
| **Code Review & PR** | `request_code_review()` | Requests a review of the current code changes. |
101-
| | `read_pr_comments()` | Reads comments on the current pull request. |
102-
| | `reply_to_pr_comments(replies: str)` | Replies to pull request comments. |
103-
| **Submission** | `pre_commit_instructions()` | Gets instructions for pre-commit checks. |
104-
| | `submit(...)` | Submits the final code with a commit message and PR description. |
105-
| **Memory** | `initiate_memory_recording()` | Starts recording information to be stored in long-term memory. |
106-
| **Frontend** | `frontend_verification_instructions()` | Gets instructions for writing a Playwright script for frontend verification. |
107-
| | `frontend_verification_complete(screenshot_path: str)` | Marks frontend verification as complete and provides a screenshot. |
82+
| Category | Tool | Description |
83+
| ---------------------- | ------------------------------------------------------ | ---------------------------------------------------------------------------- |
84+
| **Planning** | `set_plan(plan: str)` | Sets or updates the multi-step plan to solve the task. |
85+
| | `plan_step_complete(message: str)` | Marks the current step in the plan as complete. |
86+
| | `record_user_approval_for_plan()` | Records the user's approval of the initial plan. |
87+
| **User Interaction** | `message_user(message: str, continue_working: bool)` | Sends a message to the user. |
88+
| | `request_user_input(message: str)` | Asks the user a question and waits for their response. |
89+
| **Filesystem (Read)** | `list_files(path: str = ".")` | Lists files and directories. |
90+
| | `read_file(filepath: str)` | Reads the full content of a file. |
91+
| | `grep(pattern: str)` | Searches for a pattern in the codebase. |
92+
| **Filesystem (Write)** | `delete_file(filepath: str)` | Deletes a file. |
93+
| | `rename_file(filepath: str, new_filepath: str)` | Renames or moves a file. |
94+
| | `restore_file(filepath: str)` | Reverts a file to its original state from the start of the session. |
95+
| | `reset_all()` | Resets the entire codebase to its original state, undoing all changes. |
96+
| **Web & Images** | `google_search(query: str)` | Performs a Google search. |
97+
| | `view_text_website(url: str)` | Fetches the plain text content of a URL. |
98+
| | `view_image(url: str)` | Loads and views an image from a URL. |
99+
| | `read_image_file(filepath: str)` | Reads an image file from the local filesystem. |
100+
| **Code Review & PR** | `request_code_review()` | Requests a review of the current code changes. |
101+
| | `read_pr_comments()` | Reads comments on the current pull request. |
102+
| | `reply_to_pr_comments(replies: str)` | Replies to pull request comments. |
103+
| **Submission** | `pre_commit_instructions()` | Gets instructions for pre-commit checks. |
104+
| | `submit(...)` | Submits the final code with a commit message and PR description. |
105+
| **Memory** | `initiate_memory_recording()` | Starts recording information to be stored in long-term memory. |
106+
| **Frontend** | `frontend_verification_instructions()` | Gets instructions for writing a Playwright script for frontend verification. |
107+
| | `frontend_verification_complete(screenshot_path: str)` | Marks frontend verification as complete and provides a screenshot. |
108108

109109
### Special Tools
110110

111111
These tools use a custom Domain-Specific Language (DSL) syntax, not Python.
112112

113-
| Tool | Description |
114-
| ----------------------------- | -------------------------------------------------------------------- |
115-
| `run_in_bash_session` | Executes a shell command in the sandbox environment. |
116-
| `create_file_with_block` | Creates a new file with specified content. |
117-
| `overwrite_file_with_block` | Completely overwrites an existing file with new content. |
118-
| `replace_with_git_merge_diff` | Performs a targeted find-and-replace within a file. |
113+
| Tool | Description |
114+
| ----------------------------- | -------------------------------------------------------- |
115+
| `run_in_bash_session` | Executes a shell command in the sandbox environment. |
116+
| `create_file_with_block` | Creates a new file with specified content. |
117+
| `overwrite_file_with_block` | Completely overwrites an existing file with new content. |
118+
| `replace_with_git_merge_diff` | Performs a targeted find-and-replace within a file. |
119119

120120
## Development Environment
121121

0 commit comments

Comments
 (0)