interface ToolDefinition 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.ToolDefinition
Go	github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#ToolDefinition
Java	software.amazon.awscdk.services.bedrock.agentcore.alpha.ToolDefinition
Python	aws_cdk.aws_bedrock_agentcore_alpha.ToolDefinition
TypeScript (source)	@aws-cdk/aws-bedrock-agentcore-alpha » ToolDefinition

Tool definition for inline payload.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';

declare const schemaDefinition_: bedrock_agentcore_alpha.SchemaDefinition;
const toolDefinition: bedrock_agentcore_alpha.ToolDefinition = {
  description: 'description',
  inputSchema: {
    type: bedrock_agentcore_alpha.SchemaDefinitionType.STRING,

    // the properties below are optional
    description: 'description',
    items: schemaDefinition_,
    properties: {
      propertiesKey: schemaDefinition_,
    },
    required: ['required'],
  },
  name: 'name',

  // the properties below are optional
  outputSchema: {
    type: bedrock_agentcore_alpha.SchemaDefinitionType.STRING,

    // the properties below are optional
    description: 'description',
    items: schemaDefinition_,
    properties: {
      propertiesKey: schemaDefinition_,
    },
    required: ['required'],
  },
};

Properties

Name	Type	Description
description🔹	string	The description of the tool.
inputSchema🔹	SchemaDefinition	The input schema for the tool.
name🔹	string	The name of the tool.
outputSchema?🔹	SchemaDefinition	The output schema for the tool.

---

description🔹

Type: string

The description of the tool.

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

---

inputSchema🔹

Type: SchemaDefinition

The input schema for the tool.

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

---

name🔹

Type: string

The name of the tool.

This name identifies the tool in the Model Context Protocol.

---

outputSchema?🔹

Type: SchemaDefinition (optional, default: No output schema)

The output schema for the tool.

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