diff --git a/crates/chat-cli/src/cli/agent/mod.rs b/crates/chat-cli/src/cli/agent/mod.rs index f6ca84b70..efc8ff8bd 100644 --- a/crates/chat-cli/src/cli/agent/mod.rs +++ b/crates/chat-cli/src/cli/agent/mod.rs @@ -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 diff --git a/docs/agent-file-locations.md b/docs/agent-file-locations.md index b5be46e1b..0f4e1c1a5 100644 --- a/docs/agent-file-locations.md +++ b/docs/agent-file-locations.md @@ -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": [ @@ -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"] diff --git a/docs/agent-format.md b/docs/agent-format.md index f9b925414..0c510358e 100644 --- a/docs/agent-format.md +++ b/docs/agent-format.md @@ -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. @@ -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