Skip to content

Commit 1b5c223

Browse files
authored
docs: added the documentation for introspect in the built in tools. (#2727)
1 parent f385e49 commit 1b5c223

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/built-in-tools.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Amazon Q CLI includes several built-in tools that agents can use. This document
55
- [`execute_bash`](#execute_bash-tool) — Execute a shell command.
66
- [`fs_read`](#fs_read-tool) — Read files, directories, and images.
77
- [`fs_write`](#fs_write-tool) — Create and edit files.
8+
- [`introspect`](#introspect-tool) — Provide information about Q CLI capabilities and documentation.
89
- [`report_issue`](#report_issue-tool) — Open a GitHub issue template.
910
- [`knowledge`](#knowledge-tool) — Store and retrieve information in a knowledge base.
1011
- [`thinking`](#thinking-tool) — Internal reasoning mechanism.
@@ -84,6 +85,24 @@ Tool for creating and editing files.
8485
| `allowedPaths` | array of strings | `[]` | List of paths that can be written to without prompting. Supports glob patterns. Glob patterns have the same behavior as gitignore.For example, `~/temp` would match `~/temp/child` and `~/temp/child/grandchild` |
8586
| `deniedPaths` | array of strings | `[]` | List of paths that are denied. Supports glob patterns. Deny rules are evaluated before allow rules. Glob patterns have the same behavior as gitignore.For example, `~/temp` would match `~/temp/child` and `~/temp/child/grandchild` |
8687

88+
## Introspect Tool
89+
90+
Provide information about Q CLI capabilities, features, commands, and documentation. This tool accesses Q CLI's built-in documentation and help content to answer questions about the CLI's functionality.
91+
92+
### Usage
93+
94+
The introspect tool is automatically used when you ask questions about Q CLI itself, such as:
95+
- "What can you do?"
96+
- "How do I save conversations?"
97+
- "What commands are available?"
98+
- "Do you have feature X?"
99+
100+
### Behavior
101+
102+
- Tries to provide the information that is explicitly documented
103+
- Accesses README, built-in tools documentation, experiments, and settings information
104+
- Automatically enters tangent mode when configured to do so and if we set the setting introspect.tangentMode = true.
105+
87106
## Report_issue Tool
88107

89108
Opens the browser to a pre-filled GitHub issue template to report chat issues, bugs, or feature requests.

0 commit comments

Comments
 (0)