ToolConfiguration
Configuration settings for a tool used by AI Agents.
Contents
- toolName
-
The name of the tool.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: Yes
- toolType
-
The type of the tool.
Type: String
Valid Values:
MODEL_CONTEXT_PROTOCOL | RETURN_TO_CONTROL | CONSTANTRequired: Yes
- annotations
-
Annotations for the tool configuration.
Type: Annotation object
Required: No
- description
-
The description of the tool configuration.
Type: String
Required: No
- inputSchema
-
The input schema for the tool configuration.
Type: JSON value
Required: No
- instruction
-
Instructions for using the tool.
Type: ToolInstruction object
Required: No
- outputFilters
-
Output filters applies to the tool result.
Type: Array of ToolOutputFilter objects
Required: No
- outputSchema
-
The output schema for the tool configuration.
Type: JSON value
Required: No
- overrideInputValues
-
Override input values for the tool configuration.
Type: Array of ToolOverrideInputValue objects
Required: No
- title
-
The title of the tool configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No
- toolId
-
The identifier of the tool, for example toolName from Model Context Provider server.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No
- userInteractionConfiguration
-
Configuration for user interaction with the tool.
Type: UserInteractionConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
