Skip to content

Commit 6d29006

Browse files
authored
docs: Cleanup agent docs, tools docs, and intro (#2300)
* add agent documentation * docs changes * add more docs * fix typo * docs cleanups
1 parent 03ad23a commit 6d29006

File tree

3 files changed

+24
-32
lines changed

3 files changed

+24
-32
lines changed

docs/introduction.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,4 @@
22

33
Welcome to the Amazon Q CLI developer documentation.
44

5-
These docs are a work in progress and subject to change. As of now, they do not represent latest stable builds, instead documenting the functionality of development builds.
6-
7-
For information on configuring agents, see [The Agent Format](./the-agent-format.md)
8-
9-
For information on managing knowledge, see [Knowledge Management](./knowledge-management.md)
5+
These docs are experimental, work in progress, and subject to change. As of now, they do not represent latest stable builds, instead documenting the functionality of development builds.

docs/native-tools.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
1-
## execute_bash
1+
# Native tools
22

3-
Execute the specified bash command.
3+
- [`execute_bash`](#the_execute_bash_tool) — Execute a shell command.
4+
- [`fs_read`](#the_fs_read_tool) — Read files, directories, and images.
5+
- [`fs_write`](#the_fs_write_tool) — Create and edit files.
6+
- [`gh_issue`](#the_gh_issue_tool) — Open a GitHub issue template.
7+
- [`knowledge`](#the_knowledge_tool) — Store and retrieve information in a knowledge base.
8+
- [`thinking`](#the_thinking_tool) — Internal reasoning mechanism.
9+
- [`use_aws`](#the_use_aws_tool) — Make AWS CLI API calls.
10+
11+
## The `execute_bash` tool
412

5-
### Config
13+
Execute the specified bash command.
614

715
#### Schema
816

@@ -34,12 +42,10 @@ Execute the specified bash command.
3442
}
3543
```
3644

37-
## fs_read
45+
## The `fs_read` tool
3846

3947
Tool for reading files, directories and images.
4048

41-
### Config
42-
4349
#### Schema
4450

4551
```json
@@ -65,12 +71,10 @@ Tool for reading files, directories and images.
6571
}
6672
```
6773

68-
## fs_write
74+
## The `fs_write` tool
6975

7076
Tool for creating and editing files.
7177

72-
### Config
73-
7478
#### Schema
7579

7680
```json
@@ -100,36 +104,28 @@ Tool for creating and editing files.
100104
}
101105
```
102106

103-
## gh_issue
107+
## The `gh_issue` tool
104108

105109
Opens the browser to our GitHub template for reporting issues with `q`.
106110

107-
### Config
108-
109111
This tool has no configuration.
110112

111-
## knowledge
113+
## The `knowledge` tool
112114

113115
Store and retrieve information in knowledge base across chat sessions
114116

115-
### Config
116-
117117
This tool has no configuration.
118118

119-
## thinking
119+
## The `thinking` tool
120120

121121
Thinking is an internal reasoning mechanism improving the quality of complex tasks by breaking their atomic actions down.
122122

123-
### Config
124-
125123
This tool has no configuration.
126124

127-
## use_aws
125+
## The `use_aws` tool
128126

129127
Make an AWS CLI api call with the specified service, operation, and parameters.
130128

131-
### Config
132-
133129
#### Schema
134130

135131
```json

docs/the-agent-format.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ The agent configuration file for each agent is called its _manifest_. It is writ
44

55
Every manifest file consists of the following sections:
66

7-
- [`name`](#the-name-field) --- The name of the agent.
8-
- [`version`](#the-version-field) --- The version of the agent.
9-
- [`description`](#the-description-field) --- A description of the agent.
10-
- [`mcpServers`](#the-mcp-servers-field) --- The MCP servers the agent has access to.
7+
- [`name`](#the-name-field) The name of the agent.
8+
- [`version`](#the-version-field) The version of the agent.
9+
- [`description`](#the-description-field) A description of the agent.
10+
- [`mcpServers`](#the-mcp-servers-field) The MCP servers the agent has access to.
1111
- [`tools`](#the-tools-field) --- The tools available to the agent.
12-
- [`allowedTools`](#the-allowed-tools-field) --- Tools that can be used without prompting.
13-
- [`toolsSettings`](#the-tools-settings-field) --- Configuration for specific tools.
12+
- [`allowedTools`](#the-allowed-tools-field) Tools that can be used without prompting.
13+
- [`toolsSettings`](#the-tools-settings-field) Configuration for specific tools.
1414

1515
### The `name` field
1616

0 commit comments

Comments
 (0)