Skip to content

Commit 808ac8b

Browse files
attogramattogram
authored
Merge pull request #23 from attogram/docs-update-tool-list
Docs: Update tool lists in agent and human manuals
2 parents 56821d0 + ef65ac5 commit 808ac8b

File tree

2 files changed

+81
-68
lines changed

2 files changed

+81
-68
lines changed

‎agents/jules.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,44 @@ If the user directs you to do this:
6868
- When adding external links (e.g., to `https://example.com`), double-check the URL for typos.
6969
- Ensure the URL starts with `http://` or `https://`.
7070

71+
## Available Tools
72+
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.
74+
75+
### Standard Tools
76+
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.
101+
102+
### Special Tools
103+
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.
108+
71109
## Key Principles
72110

73111
- **Diagnose Before Acting:** On errors, diagnose root cause from logs before acting.

‎humans/jules.md‎

Lines changed: 43 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -73,74 +73,49 @@ Some repositories may contain `AGENTS.md` files. These files are a way for human
7373

7474
## Tools
7575

76-
I have access to a variety of tools that allow me to interact with the repository, access external resources, and perform development tasks. Tools are organized by their primary function.
77-
78-
### Session & Planning
79-
80-
| Tool | Description |
81-
| ------------------------------------------ | ---------------------------------------------------------------------------------- |
82-
| `set_plan(plan: str) -> None` | Sets or updates the plan for how to solve the issue. |
83-
| `plan_step_complete(message: str) -> None` | Marks the current plan step as complete. |
84-
| `record_user_approval_for_plan() -> None` | Records the user's approval for the plan. |
85-
| `initiate_memory_recording() -> str` | Use this tool to start recording information that will be useful for future tasks. |
86-
| `reset_all() -> None` | Resets the entire codebase to its original state. |
87-
88-
### User Interaction
89-
90-
| Tool | Description |
91-
| ------------------------------------------------------------ | -------------------------------------------------- |
92-
| `message_user(message: str, continue_working: bool) -> None` | Messages the user. |
93-
| `request_user_input(message: str) -> None` | Asks the user a question and waits for a response. |
94-
| `read_pr_comments() -> str` | Reads pull request comments. |
95-
| `reply_to_pr_comments(replies: str) -> str` | Replies to specific pull request comments. |
96-
97-
### Filesystem
98-
99-
| Tool | Description |
100-
| ------------------------------------------------------ | -------------------------------------------------------------------------- |
101-
| `ls(directory_path: str = "") -> list[str]` | Lists all files and directories. |
102-
| `read_file(filepath: str) -> str` | Returns the content of the specified file. |
103-
| `create_file_with_block` | Creates a new file. |
104-
| `overwrite_file_with_block` | Completely replaces the content of an existing file. |
105-
| `replace_with_git_merge_diff` | Performs a targeted search-and-replace to modify part of an existing file. |
106-
| `delete_file(filepath: str) -> str` | Deletes a file. |
107-
| `rename_file(filepath: str, new_filepath: str) -> str` | Renames and/or moves files and directories. |
108-
| `restore_file(filepath: str) -> None` | Restores the given file to its original state. |
109-
110-
### Code & Inspection
111-
112-
| Tool | Description |
113-
| ------------------------------ | ----------------------------------------- |
114-
| `grep(pattern: str) -> str` | Runs grep for the given pattern. |
115-
| `request_code_review() -> str` | Provides a review of the current changes. |
116-
117-
### Web
118-
119-
| Tool | Description |
120-
| ------------------------------------ | ----------------------------------------------- |
121-
| `google_search(query: str) -> str` | Online google search. |
122-
| `view_text_website(url: str) -> str` | Fetches the content of a website as plain text. |
123-
124-
### Images
125-
126-
| Tool | Description |
127-
| ----------------------------------------- | -------------------------------------- |
128-
| `view_image(url: str) -> Image` | Loads the image from the provided URL. |
129-
| `read_image_file(filepath: str) -> Image` | Reads the image file at the filepath. |
130-
131-
### Command Execution
132-
133-
| Tool | Description |
134-
| --------------------- | ------------------------------------------- |
135-
| `run_in_bash_session` | Runs the given bash command in the sandbox. |
136-
137-
### Submission & Verification
138-
139-
| Tool | Description |
140-
| -------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
141-
| `frontend_verification_instructions() -> str` | Returns instructions on how to write a Playwright script to verify frontend web applications. |
142-
| `frontend_verification_complete(screenshot_path: str) -> None` | Marks the frontend verification as complete. |
143-
| `submit(...)` | Commits the current code and requests user approval to push. |
76+
I have access to a variety of tools that allow me to interact with the repository, access external resources, and perform development tasks. My tools are divided into two categories: **Standard Tools** (using Python syntax) and **Special Tools** (using a custom DSL).
77+
78+
### Standard Tools
79+
80+
These tools are called using standard Python function syntax.
81+
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. |
108+
109+
### Special Tools
110+
111+
These tools use a custom Domain-Specific Language (DSL) syntax, not Python.
112+
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. |
144119

145120
## Development Environment
146121

0 commit comments

Comments
 (0)