ToolDefinition

class aws_cdk.aws_bedrock_agentcore_alpha.ToolDefinition(*, description, input_schema, name, output_schema=None)

Bases: object

(experimental) Tool definition for inline payload.

Parameters:

• description (str) – (experimental) The description of the tool. This description provides information about the purpose and usage of the tool.

• input_schema (Union[SchemaDefinition, Dict[str, Any]]) – (experimental) The input schema for the tool. This schema defines the structure of the input that the tool accepts.

• name (str) – (experimental) The name of the tool. This name identifies the tool in the Model Context Protocol.

• output_schema (Union[SchemaDefinition, Dict[str, Any], None]) – (experimental) The output schema for the tool. This schema defines the structure of the output that the tool produces. Default: - No output schema

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha

# schema_definition_: bedrock_agentcore_alpha.SchemaDefinition

tool_definition = bedrock_agentcore_alpha.ToolDefinition(
    description="description",
    input_schema=bedrock_agentcore_alpha.SchemaDefinition(
        type=bedrock_agentcore_alpha.SchemaDefinitionType.STRING,

        # the properties below are optional
        description="description",
        items=schema_definition_,
        properties={
            "properties_key": schema_definition_
        },
        required=["required"]
    ),
    name="name",

    # the properties below are optional
    output_schema=bedrock_agentcore_alpha.SchemaDefinition(
        type=bedrock_agentcore_alpha.SchemaDefinitionType.STRING,

        # the properties below are optional
        description="description",
        items=schema_definition_,
        properties={
            "properties_key": schema_definition_
        },
        required=["required"]
    )
)

Attributes

description

(experimental) The description of the tool.

This description provides information about the purpose and usage of the tool.

Stability:

experimental

input_schema

(experimental) The input schema for the tool.

This schema defines the structure of the input that the tool accepts.

Stability:

experimental

name

(experimental) The name of the tool.

This name identifies the tool in the Model Context Protocol.

Stability:

experimental

output_schema

(experimental) The output schema for the tool.

This schema defines the structure of the output that the tool produces.

Default:

• No output schema

Stability:

experimental