Skip to content

docs: Correct the agent documentation to reflect "name" field now being required. #3232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −4
Open

docs: Correct the agent documentation to reflect "name" field now being required. #3232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2236a84
docs: Update agent-format to reflect "name" field now being required.
JonathanBerkeley Oct 22, 2025
8872cb4
docs: Update agent-file-locations to reflect "name" field now being r…
JonathanBerkeley Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion crates/chat-cli/src/cli/agent/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ pub enum AgentConfigError {
}

/// An [Agent] is a declarative way of configuring a given instance of q chat. Currently, it is
/// impacting q chat in via influenicng [ContextManager] and [ToolManager].
/// impacting q chat via influencing [ContextManager] and [ToolManager].
/// Changes made to [ContextManager] and [ToolManager] do not persist across sessions.
///
/// To increase the usability of the agent config, (both from the perspective of CLI and the users
Expand Down
2 changes: 2 additions & 0 deletions docs/agent-file-locations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ To create a local agent for your current project:
mkdir -p .amazonq/cli-agents
cat > .amazonq/cli-agents/project-helper.json << 'EOF'
{
"name": "Project helper",
"description": "Helper agent for this specific project",
"tools": ["fs_read", "fs_write", "execute_bash"],
"resources": [
Expand All @@ -98,6 +99,7 @@ To create a global agent available everywhere:
mkdir -p ~/.aws/amazonq/cli-agents
cat > ~/.aws/amazonq/cli-agents/general-helper.json << 'EOF'
{
"name": "General helper",
"description": "General purpose assistant",
"tools": ["*"],
"allowedTools": ["fs_read"]
Expand Down
6 changes: 3 additions & 3 deletions docs/agent-format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Agent Format

The agent configuration file for each agent is a JSON file. The filename (without the `.json` extension) becomes the agent's name. It contains configuration needed to instantiate and run the agent.
The agent configuration file for each agent is a JSON file. It contains configuration needed to instantiate and run the agent.

> [!TIP]
> We recommend using the `/agent generate` slash command within your active Q session to intelligently generate your agent configuration with the help of Q.

Every agent configuration file can include the following sections:

- [`name`](#name-field) — The name of the agent (optional, derived from filename if not specified).
- [`name`](#name-field) — The name of the agent.
- [`description`](#description-field) — A description of the agent.
- [`prompt`](#prompt-field) — High-level context for the agent.
- [`mcpServers`](#mcpservers-field) — The MCP servers the agent has access to.
Expand Down Expand Up @@ -228,7 +228,7 @@ Optionally, you can also prefix native tools with the namespace `@builtin`.
"fs_*", // All filesystem tools
"execute_*", // All execute tools
"*_test", // Any tool ending in _test
@builtin, // All native tools
@builtin, // All native tools

// MCP tool wildcards
"@server/api_*", // All API tools from server
Expand Down