Waiting for engine...
Skip to main content

aiAgentToolCreate

Create a new AI Agent Tool in the AI Agent Registry.

Description: This mutation creates a new AI Agent Tool associated with the authenticated user’s account.

Input Parameters (AiAgentToolCreateInput):

  • providerAccountId: ID! - Required. The unique identifier of the AI Agent Custom Type Provider account where the tool will be created.
  • toolType: AiAgentToolType! - Required. Specifies the classification type of the AI Agent tool.
  • name: String! - Required. Defines the unique identifier or title of the AI agent tool.
  • externalId: String - Optional. External identifier from the provider system (e.g., AWS Bedrock, Salesforce).
  • version: String - Optional. Specifies the version of the AI agent tool. Values can be null, DRAFT or a numeric value.
  • description: String - Optional. Provides detailed information about the AI agent tool's capabilities and features.
  • toolJson: String - Optional. Stores the complete tool configuration represented as a JSON string.
  • status: AiAgentToolStatus - Optional. Specifies the current status of the AI Agent tool.
  • updatedByOrigin: AiAgentOriginType - Optional. Indicates the origin type when creating the tool, either PROVIDER or REGISTRY.
  • aiRegistryEntityType: AiRegistryEntityType - Optional. Specifies the AI registry entity type, either VERSION or TASK.
  • aiRegistryEntityIds: [ID!] - Optional. List of AI registry entity identifiers (GUID of respective entity type to which tool needs to be associated).
  • aiRegistryEntityStatus: String - Optional. Specifies the current status of the Entity Association.
  • resources: [AiAgentToolResourceInput!] - Optional. Array of tool resources associated with the AI Agent tool.
  • tags: [AiAgentTagInput!] - Optional. Optional labeling system that allows classification and organization of AI agent tools.

Response:

  • Returns the newly created AiAgentTool object.

Example Request:

mutation CreateAiAgentTool {
aiAgentToolCreate(input: {
providerAccountId: "ai-registry-account-12345",
toolType: CUSTOM,
name: "Customer Data Analyzer",
externalId: "customer-data-analyzer-v1",
version: "1.0.0",
description: "Advanced tool for analyzing customer data and generating insights for AI agents.",
toolJson: "{ \"actionGroupName\": \"CustomerDataAnalysis\", \"description\": \"Action group for customer data analysis\", \"actionGroupState\": \"ENABLED\", \"actions\": [{ \"name\": \"analyzeCustomerData\", \"description\": \"Analyzes customer data for patterns\", \"parameters\": { \"customerId\": { \"type\": \"string\", \"required\": true }, \"analysisType\": { \"type\": \"string\", \"required\": false, \"default\": \"comprehensive\" } } }] }",
status: ENABLED,
updatedByOrigin: REGISTRY,
aiRegistryEntityType: VERSION,
aiRegistryEntityIds: ["agent-customer-service-001", "agent-customer-service-002"],
aiRegistryEntityStatus: "ENABLED",
resources: [{
name: "CustomerDataProcessor",
description: "Processes and analyzes customer data",
resourceType: CUSTOM,
toolResourceJson: "{ \"name\": \"CustomerDataProcessor\", \"description\": \"AWS Lambda function for customer data processing\", \"runtime\": \"nodejs18.x\", \"handler\": \"index.handler\", \"environment\": { \"variables\": { \"ANALYSIS_MODE\": \"advanced\" } }, \"timeout\": 300 }",
status: ENABLED,
externalId: "customer-data-processor-fn"
}, {
name: "DataVisualizationService",
description: "Creates visualizations from analyzed data",
resourceType: CUSTOM,
toolResourceJson: "{ \"name\": \"DataVisualizationService\", \"description\": \"REST API for data visualization\", \"baseUrl\": \"https://api.example.com/v1/visualization\", \"endpoints\": [{ \"path\": \"/charts\", \"method\": \"POST\", \"description\": \"Generate charts from data\" }] }",
status: ENABLED,
externalId: "data-viz-service"
}],
tags: [
{
key: "category"
value: "analytics"
},
{
key: "dataType"
value: "customer"
},
{
key: "environment"
value: "production"
}
]
}) {
id
externalId
version
name
description
provider
toolType
toolJson
status
resources {
name
description
resourceType
toolResourceJson
status
externalId
}
tags {
id
key
value
}
agentVersions {
id
externalId
version
name
description
region
purpose
personalityTraitsJson
instructions
agentStatus
versionMetadata
}
tasks {
id
externalId
version
name
description
taskStatus
metaData
instructions
syncData {
lastSyncStatus
lastSyncStartDate
lastSyncEndDate
}
auditData {
createdByUserId
createdTime
modifiedByUserId
modifiedTime
updatedByOrigin
updatedAtProviderTime
}
}
syncData {
lastSyncStatus
lastSyncStartDate
lastSyncEndDate
}
auditData {
createdByUserId
createdTime
modifiedByUserId
modifiedTime
updatedByOrigin
updatedAtProviderTime
}
}
}

aiAgentToolCreate(
input: AiAgentToolCreateInput!
): AiAgentTool

Arguments

aiAgentToolCreate.input ● AiAgentToolCreateInput! non-null input agent-control-tower

Type

AiAgentTool object agent-control-tower

Represents an AI Agent Tool in the AI Agent Registry.

On this Page