1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GenerativeAi
  5. getAgentTools
Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
pulumi/pulumi-oci

oci.GenerativeAi.getAgentTools

Start a Neo task
Explain and create an oci.GenerativeAi.getAgentTools resource
oci logo
Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Tools in Oracle Cloud Infrastructure Generative Ai Agent service.

    Gets a list of tools.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testTools = oci.GenerativeAi.getAgentTools({
    agentId: testAgent.id,
    compartmentId: compartmentId,
    displayName: toolDisplayName,
    state: toolState,
});

    import pulumi
import pulumi_oci as oci

test_tools = oci.GenerativeAi.get_agent_tools(agent_id=test_agent["id"],
    compartment_id=compartment_id,
    display_name=tool_display_name,
    state=tool_state)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/generativeai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := generativeai.GetAgentTools(ctx, &generativeai.GetAgentToolsArgs{
			AgentId:       pulumi.StringRef(testAgent.Id),
			CompartmentId: pulumi.StringRef(compartmentId),
			DisplayName:   pulumi.StringRef(toolDisplayName),
			State:         pulumi.StringRef(toolState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testTools = Oci.GenerativeAi.GetAgentTools.Invoke(new()
    {
        AgentId = testAgent.Id,
        CompartmentId = compartmentId,
        DisplayName = toolDisplayName,
        State = toolState,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
import com.pulumi.oci.GenerativeAi.inputs.GetAgentToolsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testTools = GenerativeAiFunctions.getAgentTools(GetAgentToolsArgs.builder()
            .agentId(testAgent.id())
            .compartmentId(compartmentId)
            .displayName(toolDisplayName)
            .state(toolState)
            .build());

    }
}

    variables:
  testTools:
    fn::invoke:
      function: oci:GenerativeAi:getAgentTools
      arguments:
        agentId: ${testAgent.id}
        compartmentId: ${compartmentId}
        displayName: ${toolDisplayName}
        state: ${toolState}

    Using getAgentTools

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAgentTools(args: GetAgentToolsArgs, opts?: InvokeOptions): Promise<GetAgentToolsResult>
function getAgentToolsOutput(args: GetAgentToolsOutputArgs, opts?: InvokeOptions): Output<GetAgentToolsResult>
    def get_agent_tools(agent_id: Optional[str] = None,
                    compartment_id: Optional[str] = None,
                    display_name: Optional[str] = None,
                    filters: Optional[Sequence[GetAgentToolsFilter]] = None,
                    state: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAgentToolsResult
def get_agent_tools_output(agent_id: Optional[pulumi.Input[str]] = None,
                    compartment_id: Optional[pulumi.Input[str]] = None,
                    display_name: Optional[pulumi.Input[str]] = None,
                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetAgentToolsFilterArgs]]]] = None,
                    state: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAgentToolsResult]
    func GetAgentTools(ctx *Context, args *GetAgentToolsArgs, opts ...InvokeOption) (*GetAgentToolsResult, error)
func GetAgentToolsOutput(ctx *Context, args *GetAgentToolsOutputArgs, opts ...InvokeOption) GetAgentToolsResultOutput

    > Note: This function is named GetAgentTools in the Go SDK.

    public static class GetAgentTools 
{
    public static Task<GetAgentToolsResult> InvokeAsync(GetAgentToolsArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentToolsResult> Invoke(GetAgentToolsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAgentToolsResult> getAgentTools(GetAgentToolsArgs args, InvokeOptions options)
public static Output<GetAgentToolsResult> getAgentTools(GetAgentToolsArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:GenerativeAi/getAgentTools:getAgentTools
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AgentId string
    The OCID of the agent.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters List<GetAgentToolsFilter>
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    AgentId string
    The OCID of the agent.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters []GetAgentToolsFilter
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    agentId String
    The OCID of the agent.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<GetAgentToolsFilter>
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    agentId string
    The OCID of the agent.
    compartmentId string
    The OCID of the compartment in which to list resources.
    displayName string
    A filter to return only resources that match the given display name exactly.
    filters GetAgentToolsFilter[]
    state string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    agent_id str
    The OCID of the agent.
    compartment_id str
    The OCID of the compartment in which to list resources.
    display_name str
    A filter to return only resources that match the given display name exactly.
    filters Sequence[GetAgentToolsFilter]
    state str
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    agentId String
    The OCID of the agent.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<Property Map>
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

    getAgentTools Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    ToolCollections List<GetAgentToolsToolCollection>
    The list of tool_collection.
    AgentId string
    The OCID of the agent that this Tool is attached to.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    Filters List<GetAgentToolsFilter>
    State string
    The current state of the Tool.
    Id string
    The provider-assigned unique ID for this managed resource.
    ToolCollections []GetAgentToolsToolCollection
    The list of tool_collection.
    AgentId string
    The OCID of the agent that this Tool is attached to.
    CompartmentId string
    The OCID of the compartment.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    Filters []GetAgentToolsFilter
    State string
    The current state of the Tool.
    id String
    The provider-assigned unique ID for this managed resource.
    toolCollections List<GetAgentToolsToolCollection>
    The list of tool_collection.
    agentId String
    The OCID of the agent that this Tool is attached to.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters List<GetAgentToolsFilter>
    state String
    The current state of the Tool.
    id string
    The provider-assigned unique ID for this managed resource.
    toolCollections GetAgentToolsToolCollection[]
    The list of tool_collection.
    agentId string
    The OCID of the agent that this Tool is attached to.
    compartmentId string
    The OCID of the compartment.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters GetAgentToolsFilter[]
    state string
    The current state of the Tool.
    id str
    The provider-assigned unique ID for this managed resource.
    tool_collections Sequence[GetAgentToolsToolCollection]
    The list of tool_collection.
    agent_id str
    The OCID of the agent that this Tool is attached to.
    compartment_id str
    The OCID of the compartment.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters Sequence[GetAgentToolsFilter]
    state str
    The current state of the Tool.
    id String
    The provider-assigned unique ID for this managed resource.
    toolCollections List<Property Map>
    The list of tool_collection.
    agentId String
    The OCID of the agent that this Tool is attached to.
    compartmentId String
    The OCID of the compartment.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters List<Property Map>
    state String
    The current state of the Tool.

    Supporting Types

    GetAgentToolsFilter

    Name string
    The name of the function to invoke.
    Values List<string>
    Regex bool
    Name string
    The name of the function to invoke.
    Values []string
    Regex bool
    name String
    The name of the function to invoke.
    values List<String>
    regex Boolean
    name string
    The name of the function to invoke.
    values string[]
    regex boolean
    name str
    The name of the function to invoke.
    values Sequence[str]
    regex bool
    name String
    The name of the function to invoke.
    values List<String>
    regex Boolean

    GetAgentToolsToolCollection

    GetAgentToolsToolCollectionItem

    AgentId string
    The OCID of the agent.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    A description of the function.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the Tool.
    Metadata Dictionary<string, string>
    Key-value pairs to allow additional configurations.
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    ToolConfigs List<GetAgentToolsToolCollectionItemToolConfig>
    The configuration and type of Tool.
    AgentId string
    The OCID of the agent.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    A description of the function.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the Tool.
    Metadata map[string]string
    Key-value pairs to allow additional configurations.
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    ToolConfigs []GetAgentToolsToolCollectionItemToolConfig
    The configuration and type of Tool.
    agentId String
    The OCID of the agent.
    compartmentId String
    The OCID of the compartment in which to list resources.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    A description of the function.
    displayName String
    A filter to return only resources that match the given display name exactly.
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the Tool.
    metadata Map<String,String>
    Key-value pairs to allow additional configurations.
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    toolConfigs List<GetAgentToolsToolCollectionItemToolConfig>
    The configuration and type of Tool.
    agentId string
    The OCID of the agent.
    compartmentId string
    The OCID of the compartment in which to list resources.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    A description of the function.
    displayName string
    A filter to return only resources that match the given display name exactly.
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the Tool.
    metadata {[key: string]: string}
    Key-value pairs to allow additional configurations.
    state string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    toolConfigs GetAgentToolsToolCollectionItemToolConfig[]
    The configuration and type of Tool.
    agent_id str
    The OCID of the agent.
    compartment_id str
    The OCID of the compartment in which to list resources.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    A description of the function.
    display_name str
    A filter to return only resources that match the given display name exactly.
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the Tool.
    metadata Mapping[str, str]
    Key-value pairs to allow additional configurations.
    state str
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    tool_configs Sequence[GetAgentToolsToolCollectionItemToolConfig]
    The configuration and type of Tool.
    agentId String
    The OCID of the agent.
    compartmentId String
    The OCID of the compartment in which to list resources.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    A description of the function.
    displayName String
    A filter to return only resources that match the given display name exactly.
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the Tool.
    metadata Map<String>
    Key-value pairs to allow additional configurations.
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the Tool was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the Tool was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    toolConfigs List<Property Map>
    The configuration and type of Tool.

    GetAgentToolsToolCollectionItemToolConfig

    AgentEndpointId string
    The AgentEndpoint OCID to be used as a tool in this agent.
    ApiSchemas List<GetAgentToolsToolCollectionItemToolConfigApiSchema>
    The input location definition for Api schema.
    DatabaseConnections List<GetAgentToolsToolCollectionItemToolConfigDatabaseConnection>
    The connection type for Databases.
    DatabaseSchemas List<GetAgentToolsToolCollectionItemToolConfigDatabaseSchema>
    The input location definition.
    Dialect string
    Dialect to be used for SQL generation.
    Functions List<GetAgentToolsToolCollectionItemToolConfigFunction>
    Details of Function for Function calling tool.
    GenerationLlmCustomizations List<GetAgentToolsToolCollectionItemToolConfigGenerationLlmCustomization>
    Configuration to customize LLM.
    HttpEndpointAuthConfigs List<GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfig>
    Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials.
    IclExamples List<GetAgentToolsToolCollectionItemToolConfigIclExample>
    The input location definition.
    KnowledgeBaseConfigs List<GetAgentToolsToolCollectionItemToolConfigKnowledgeBaseConfig>
    The KnowledgeBase configurations that this RAG Tool uses
    ModelSize string
    Size of the model.
    ShouldEnableSelfCorrection bool
    To enable/disable self correction.
    ShouldEnableSqlExecution bool
    To enable/disable SQL execution.
    SubnetId string
    The subnet ID from agent developer tenancy through which the egress is going to be routed.
    TableAndColumnDescriptions List<GetAgentToolsToolCollectionItemToolConfigTableAndColumnDescription>
    The input location definition.
    ToolConfigType string
    The type of the Tool config. The allowed values are:

    • SQL_TOOL_CONFIG: The config for sql Tool.
    • RAG_TOOL_CONFIG: The config for rag Tool.
    • FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.
    AgentEndpointId string
    The AgentEndpoint OCID to be used as a tool in this agent.
    ApiSchemas []GetAgentToolsToolCollectionItemToolConfigApiSchema
    The input location definition for Api schema.
    DatabaseConnections []GetAgentToolsToolCollectionItemToolConfigDatabaseConnection
    The connection type for Databases.
    DatabaseSchemas []GetAgentToolsToolCollectionItemToolConfigDatabaseSchema
    The input location definition.
    Dialect string
    Dialect to be used for SQL generation.
    Functions []GetAgentToolsToolCollectionItemToolConfigFunction
    Details of Function for Function calling tool.
    GenerationLlmCustomizations []GetAgentToolsToolCollectionItemToolConfigGenerationLlmCustomization
    Configuration to customize LLM.
    HttpEndpointAuthConfigs []GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfig
    Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials.
    IclExamples []GetAgentToolsToolCollectionItemToolConfigIclExample
    The input location definition.
    KnowledgeBaseConfigs []GetAgentToolsToolCollectionItemToolConfigKnowledgeBaseConfig
    The KnowledgeBase configurations that this RAG Tool uses
    ModelSize string
    Size of the model.
    ShouldEnableSelfCorrection bool
    To enable/disable self correction.
    ShouldEnableSqlExecution bool
    To enable/disable SQL execution.
    SubnetId string
    The subnet ID from agent developer tenancy through which the egress is going to be routed.
    TableAndColumnDescriptions []GetAgentToolsToolCollectionItemToolConfigTableAndColumnDescription
    The input location definition.
    ToolConfigType string
    The type of the Tool config. The allowed values are:

    • SQL_TOOL_CONFIG: The config for sql Tool.
    • RAG_TOOL_CONFIG: The config for rag Tool.
    • FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.
    agentEndpointId String
    The AgentEndpoint OCID to be used as a tool in this agent.
    apiSchemas List<GetAgentToolsToolCollectionItemToolConfigApiSchema>
    The input location definition for Api schema.
    databaseConnections List<GetAgentToolsToolCollectionItemToolConfigDatabaseConnection>
    The connection type for Databases.
    databaseSchemas List<GetAgentToolsToolCollectionItemToolConfigDatabaseSchema>
    The input location definition.
    dialect String
    Dialect to be used for SQL generation.
    functions List<GetAgentToolsToolCollectionItemToolConfigFunction>
    Details of Function for Function calling tool.
    generationLlmCustomizations List<GetAgentToolsToolCollectionItemToolConfigGenerationLlmCustomization>
    Configuration to customize LLM.
    httpEndpointAuthConfigs List<GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfig>
    Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials.
    iclExamples List<GetAgentToolsToolCollectionItemToolConfigIclExample>
    The input location definition.
    knowledgeBaseConfigs List<GetAgentToolsToolCollectionItemToolConfigKnowledgeBaseConfig>
    The KnowledgeBase configurations that this RAG Tool uses
    modelSize String
    Size of the model.
    shouldEnableSelfCorrection Boolean
    To enable/disable self correction.
    shouldEnableSqlExecution Boolean
    To enable/disable SQL execution.
    subnetId String
    The subnet ID from agent developer tenancy through which the egress is going to be routed.
    tableAndColumnDescriptions List<GetAgentToolsToolCollectionItemToolConfigTableAndColumnDescription>
    The input location definition.
    toolConfigType String
    The type of the Tool config. The allowed values are:

    • SQL_TOOL_CONFIG: The config for sql Tool.
    • RAG_TOOL_CONFIG: The config for rag Tool.
    • FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.
    agentEndpointId string
    The AgentEndpoint OCID to be used as a tool in this agent.
    apiSchemas GetAgentToolsToolCollectionItemToolConfigApiSchema[]
    The input location definition for Api schema.
    databaseConnections GetAgentToolsToolCollectionItemToolConfigDatabaseConnection[]
    The connection type for Databases.
    databaseSchemas GetAgentToolsToolCollectionItemToolConfigDatabaseSchema[]
    The input location definition.
    dialect string
    Dialect to be used for SQL generation.
    functions GetAgentToolsToolCollectionItemToolConfigFunction[]
    Details of Function for Function calling tool.
    generationLlmCustomizations GetAgentToolsToolCollectionItemToolConfigGenerationLlmCustomization[]
    Configuration to customize LLM.
    httpEndpointAuthConfigs GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfig[]
    Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials.
    iclExamples GetAgentToolsToolCollectionItemToolConfigIclExample[]
    The input location definition.
    knowledgeBaseConfigs GetAgentToolsToolCollectionItemToolConfigKnowledgeBaseConfig[]
    The KnowledgeBase configurations that this RAG Tool uses
    modelSize string
    Size of the model.
    shouldEnableSelfCorrection boolean
    To enable/disable self correction.
    shouldEnableSqlExecution boolean
    To enable/disable SQL execution.
    subnetId string
    The subnet ID from agent developer tenancy through which the egress is going to be routed.
    tableAndColumnDescriptions GetAgentToolsToolCollectionItemToolConfigTableAndColumnDescription[]
    The input location definition.
    toolConfigType string
    The type of the Tool config. The allowed values are:

    • SQL_TOOL_CONFIG: The config for sql Tool.
    • RAG_TOOL_CONFIG: The config for rag Tool.
    • FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.
    agent_endpoint_id str
    The AgentEndpoint OCID to be used as a tool in this agent.
    api_schemas Sequence[GetAgentToolsToolCollectionItemToolConfigApiSchema]
    The input location definition for Api schema.
    database_connections Sequence[GetAgentToolsToolCollectionItemToolConfigDatabaseConnection]
    The connection type for Databases.
    database_schemas Sequence[GetAgentToolsToolCollectionItemToolConfigDatabaseSchema]
    The input location definition.
    dialect str
    Dialect to be used for SQL generation.
    functions Sequence[GetAgentToolsToolCollectionItemToolConfigFunction]
    Details of Function for Function calling tool.
    generation_llm_customizations Sequence[GetAgentToolsToolCollectionItemToolConfigGenerationLlmCustomization]
    Configuration to customize LLM.
    http_endpoint_auth_configs Sequence[GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfig]
    Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials.
    icl_examples Sequence[GetAgentToolsToolCollectionItemToolConfigIclExample]
    The input location definition.
    knowledge_base_configs Sequence[GetAgentToolsToolCollectionItemToolConfigKnowledgeBaseConfig]
    The KnowledgeBase configurations that this RAG Tool uses
    model_size str
    Size of the model.
    should_enable_self_correction bool
    To enable/disable self correction.
    should_enable_sql_execution bool
    To enable/disable SQL execution.
    subnet_id str
    The subnet ID from agent developer tenancy through which the egress is going to be routed.
    table_and_column_descriptions Sequence[GetAgentToolsToolCollectionItemToolConfigTableAndColumnDescription]
    The input location definition.
    tool_config_type str
    The type of the Tool config. The allowed values are:

    • SQL_TOOL_CONFIG: The config for sql Tool.
    • RAG_TOOL_CONFIG: The config for rag Tool.
    • FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.
    agentEndpointId String
    The AgentEndpoint OCID to be used as a tool in this agent.
    apiSchemas List<Property Map>
    The input location definition for Api schema.
    databaseConnections List<Property Map>
    The connection type for Databases.
    databaseSchemas List<Property Map>
    The input location definition.
    dialect String
    Dialect to be used for SQL generation.
    functions List<Property Map>
    Details of Function for Function calling tool.
    generationLlmCustomizations List<Property Map>
    Configuration to customize LLM.
    httpEndpointAuthConfigs List<Property Map>
    Authentication configuration used for HTTP Endpoint tools. Defines the type of authentication and the source of credentials.
    iclExamples List<Property Map>
    The input location definition.
    knowledgeBaseConfigs List<Property Map>
    The KnowledgeBase configurations that this RAG Tool uses
    modelSize String
    Size of the model.
    shouldEnableSelfCorrection Boolean
    To enable/disable self correction.
    shouldEnableSqlExecution Boolean
    To enable/disable SQL execution.
    subnetId String
    The subnet ID from agent developer tenancy through which the egress is going to be routed.
    tableAndColumnDescriptions List<Property Map>
    The input location definition.
    toolConfigType String
    The type of the Tool config. The allowed values are:

    • SQL_TOOL_CONFIG: The config for sql Tool.
    • RAG_TOOL_CONFIG: The config for rag Tool.
    • FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool.

    GetAgentToolsToolCollectionItemToolConfigApiSchema

    ApiSchemaInputLocationType string
    Type of Api Schema InputLocation. The allowed values are:

    • INLINE: The Api schema input location is inline.
    • OBJECT_STORAGE_LOCATION: The Api schema input location is object storage.
    Bucket string
    The bucket name of an object.
    Content string
    Inline content as input.
    Namespace string
    The namespace name of an object.
    Object string
    The location/name of object.
    ApiSchemaInputLocationType string
    Type of Api Schema InputLocation. The allowed values are:

    • INLINE: The Api schema input location is inline.
    • OBJECT_STORAGE_LOCATION: The Api schema input location is object storage.
    Bucket string
    The bucket name of an object.
    Content string
    Inline content as input.
    Namespace string
    The namespace name of an object.
    Object string
    The location/name of object.
    apiSchemaInputLocationType String
    Type of Api Schema InputLocation. The allowed values are:

    • INLINE: The Api schema input location is inline.
    • OBJECT_STORAGE_LOCATION: The Api schema input location is object storage.
    bucket String
    The bucket name of an object.
    content String
    Inline content as input.
    namespace String
    The namespace name of an object.
    object String
    The location/name of object.
    apiSchemaInputLocationType string
    Type of Api Schema InputLocation. The allowed values are:

    • INLINE: The Api schema input location is inline.
    • OBJECT_STORAGE_LOCATION: The Api schema input location is object storage.
    bucket string
    The bucket name of an object.
    content string
    Inline content as input.
    namespace string
    The namespace name of an object.
    object string
    The location/name of object.
    api_schema_input_location_type str
    Type of Api Schema InputLocation. The allowed values are:

    • INLINE: The Api schema input location is inline.
    • OBJECT_STORAGE_LOCATION: The Api schema input location is object storage.
    bucket str
    The bucket name of an object.
    content str
    Inline content as input.
    namespace str
    The namespace name of an object.
    object str
    The location/name of object.
    apiSchemaInputLocationType String
    Type of Api Schema InputLocation. The allowed values are:

    • INLINE: The Api schema input location is inline.
    • OBJECT_STORAGE_LOCATION: The Api schema input location is object storage.
    bucket String
    The bucket name of an object.
    content String
    Inline content as input.
    namespace String
    The namespace name of an object.
    object String
    The location/name of object.

    GetAgentToolsToolCollectionItemToolConfigDatabaseConnection

    ConnectionId string
    The OCID of the Database Tools Connection.
    ConnectionType string
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    ConnectionId string
    The OCID of the Database Tools Connection.
    ConnectionType string
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    connectionId String
    The OCID of the Database Tools Connection.
    connectionType String
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    connectionId string
    The OCID of the Database Tools Connection.
    connectionType string
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    connection_id str
    The OCID of the Database Tools Connection.
    connection_type str
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    connectionId String
    The OCID of the Database Tools Connection.
    connectionType String
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.

    GetAgentToolsToolCollectionItemToolConfigDatabaseSchema

    Bucket string
    The bucket name of an object.
    Content string
    Inline content as input.
    InputLocationType string
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    Namespace string
    The namespace name of an object.
    Prefix string
    The prefix of file object(s) or folder prefix.
    Bucket string
    The bucket name of an object.
    Content string
    Inline content as input.
    InputLocationType string
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    Namespace string
    The namespace name of an object.
    Prefix string
    The prefix of file object(s) or folder prefix.
    bucket String
    The bucket name of an object.
    content String
    Inline content as input.
    inputLocationType String
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    namespace String
    The namespace name of an object.
    prefix String
    The prefix of file object(s) or folder prefix.
    bucket string
    The bucket name of an object.
    content string
    Inline content as input.
    inputLocationType string
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    namespace string
    The namespace name of an object.
    prefix string
    The prefix of file object(s) or folder prefix.
    bucket str
    The bucket name of an object.
    content str
    Inline content as input.
    input_location_type str
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    namespace str
    The namespace name of an object.
    prefix str
    The prefix of file object(s) or folder prefix.
    bucket String
    The bucket name of an object.
    content String
    Inline content as input.
    inputLocationType String
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    namespace String
    The namespace name of an object.
    prefix String
    The prefix of file object(s) or folder prefix.

    GetAgentToolsToolCollectionItemToolConfigFunction

    Description string
    A description of the function.
    Name string
    The name of the function to invoke.
    Parameters Dictionary<string, string>
    The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format.
    Description string
    A description of the function.
    Name string
    The name of the function to invoke.
    Parameters map[string]string
    The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format.
    description String
    A description of the function.
    name String
    The name of the function to invoke.
    parameters Map<String,String>
    The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format.
    description string
    A description of the function.
    name string
    The name of the function to invoke.
    parameters {[key: string]: string}
    The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format.
    description str
    A description of the function.
    name str
    The name of the function to invoke.
    parameters Mapping[str, str]
    The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format.
    description String
    A description of the function.
    name String
    The name of the function to invoke.
    parameters Map<String>
    The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format.

    GetAgentToolsToolCollectionItemToolConfigGenerationLlmCustomization

    Instruction string
    If specified, the default instruction is replaced with provided instruction.
    Instruction string
    If specified, the default instruction is replaced with provided instruction.
    instruction String
    If specified, the default instruction is replaced with provided instruction.
    instruction string
    If specified, the default instruction is replaced with provided instruction.
    instruction str
    If specified, the default instruction is replaced with provided instruction.
    instruction String
    If specified, the default instruction is replaced with provided instruction.

    GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfig

    HttpEndpointAuthSources List<GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSource>
    A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool.
    HttpEndpointAuthSources []GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSource
    A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool.
    httpEndpointAuthSources List<GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSource>
    A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool.
    httpEndpointAuthSources GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSource[]
    A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool.
    http_endpoint_auth_sources Sequence[GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSource]
    A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool.
    httpEndpointAuthSources List<Property Map>
    A list of credential sources from which authentication credentials can be resolved. Only AGENT is supported for HTTP Endpoint Tool.

    GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSource

    HttpEndpointAuthScope string
    Specifies the level from which credentials should be resolved.
    HttpEndpointAuthScopeConfigs List<GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfig>
    Subset of AuthScopeConfig allowed for HTTP Endpoint Tool.
    HttpEndpointAuthScope string
    Specifies the level from which credentials should be resolved.
    HttpEndpointAuthScopeConfigs []GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfig
    Subset of AuthScopeConfig allowed for HTTP Endpoint Tool.
    httpEndpointAuthScope String
    Specifies the level from which credentials should be resolved.
    httpEndpointAuthScopeConfigs List<GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfig>
    Subset of AuthScopeConfig allowed for HTTP Endpoint Tool.
    httpEndpointAuthScope string
    Specifies the level from which credentials should be resolved.
    httpEndpointAuthScopeConfigs GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfig[]
    Subset of AuthScopeConfig allowed for HTTP Endpoint Tool.
    http_endpoint_auth_scope str
    Specifies the level from which credentials should be resolved.
    http_endpoint_auth_scope_configs Sequence[GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfig]
    Subset of AuthScopeConfig allowed for HTTP Endpoint Tool.
    httpEndpointAuthScope String
    Specifies the level from which credentials should be resolved.
    httpEndpointAuthScopeConfigs List<Property Map>
    Subset of AuthScopeConfig allowed for HTTP Endpoint Tool.

    GetAgentToolsToolCollectionItemToolConfigHttpEndpointAuthConfigHttpEndpointAuthSourceHttpEndpointAuthScopeConfig

    ClientId string
    IDCS client ID.
    HttpEndpointAuthScopeConfigType string
    The type of authentication to be applied for this HTTP Endpoint.
    IdcsUrl string
    IDCS OpenID discovery endpoint.
    KeyLocation string
    The location of the API key in the request.
    KeyName string
    The name of the key parameter in the location.
    ScopeUrl string
    OAuth2 scopes for token generation.
    VaultSecretId string
    The OCID of the vault secret with username:password. Required when authScope is AGENT.
    ClientId string
    IDCS client ID.
    HttpEndpointAuthScopeConfigType string
    The type of authentication to be applied for this HTTP Endpoint.
    IdcsUrl string
    IDCS OpenID discovery endpoint.
    KeyLocation string
    The location of the API key in the request.
    KeyName string
    The name of the key parameter in the location.
    ScopeUrl string
    OAuth2 scopes for token generation.
    VaultSecretId string
    The OCID of the vault secret with username:password. Required when authScope is AGENT.
    clientId String
    IDCS client ID.
    httpEndpointAuthScopeConfigType String
    The type of authentication to be applied for this HTTP Endpoint.
    idcsUrl String
    IDCS OpenID discovery endpoint.
    keyLocation String
    The location of the API key in the request.
    keyName String
    The name of the key parameter in the location.
    scopeUrl String
    OAuth2 scopes for token generation.
    vaultSecretId String
    The OCID of the vault secret with username:password. Required when authScope is AGENT.
    clientId string
    IDCS client ID.
    httpEndpointAuthScopeConfigType string
    The type of authentication to be applied for this HTTP Endpoint.
    idcsUrl string
    IDCS OpenID discovery endpoint.
    keyLocation string
    The location of the API key in the request.
    keyName string
    The name of the key parameter in the location.
    scopeUrl string
    OAuth2 scopes for token generation.
    vaultSecretId string
    The OCID of the vault secret with username:password. Required when authScope is AGENT.
    client_id str
    IDCS client ID.
    http_endpoint_auth_scope_config_type str
    The type of authentication to be applied for this HTTP Endpoint.
    idcs_url str
    IDCS OpenID discovery endpoint.
    key_location str
    The location of the API key in the request.
    key_name str
    The name of the key parameter in the location.
    scope_url str
    OAuth2 scopes for token generation.
    vault_secret_id str
    The OCID of the vault secret with username:password. Required when authScope is AGENT.
    clientId String
    IDCS client ID.
    httpEndpointAuthScopeConfigType String
    The type of authentication to be applied for this HTTP Endpoint.
    idcsUrl String
    IDCS OpenID discovery endpoint.
    keyLocation String
    The location of the API key in the request.
    keyName String
    The name of the key parameter in the location.
    scopeUrl String
    OAuth2 scopes for token generation.
    vaultSecretId String
    The OCID of the vault secret with username:password. Required when authScope is AGENT.

    GetAgentToolsToolCollectionItemToolConfigIclExample

    Bucket string
    The bucket name of an object.
    Content string
    Inline content as input.
    InputLocationType string
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    Namespace string
    The namespace name of an object.
    Prefix string
    The prefix of file object(s) or folder prefix.
    Bucket string
    The bucket name of an object.
    Content string
    Inline content as input.
    InputLocationType string
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    Namespace string
    The namespace name of an object.
    Prefix string
    The prefix of file object(s) or folder prefix.
    bucket String
    The bucket name of an object.
    content String
    Inline content as input.
    inputLocationType String
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    namespace String
    The namespace name of an object.
    prefix String
    The prefix of file object(s) or folder prefix.
    bucket string
    The bucket name of an object.
    content string
    Inline content as input.
    inputLocationType string
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    namespace string
    The namespace name of an object.
    prefix string
    The prefix of file object(s) or folder prefix.
    bucket str
    The bucket name of an object.
    content str
    Inline content as input.
    input_location_type str
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    namespace str
    The namespace name of an object.
    prefix str
    The prefix of file object(s) or folder prefix.
    bucket String
    The bucket name of an object.
    content String
    Inline content as input.
    inputLocationType String
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    namespace String
    The namespace name of an object.
    prefix String
    The prefix of file object(s) or folder prefix.

    GetAgentToolsToolCollectionItemToolConfigKnowledgeBaseConfig

    KnowledgeBaseId string
    The OCID of the knowledgeBase this RAG Tool uses
    KnowledgeBaseId string
    The OCID of the knowledgeBase this RAG Tool uses
    knowledgeBaseId String
    The OCID of the knowledgeBase this RAG Tool uses
    knowledgeBaseId string
    The OCID of the knowledgeBase this RAG Tool uses
    knowledge_base_id str
    The OCID of the knowledgeBase this RAG Tool uses
    knowledgeBaseId String
    The OCID of the knowledgeBase this RAG Tool uses

    GetAgentToolsToolCollectionItemToolConfigTableAndColumnDescription

    Bucket string
    The bucket name of an object.
    Content string
    Inline content as input.
    InputLocationType string
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    Namespace string
    The namespace name of an object.
    Prefix string
    The prefix of file object(s) or folder prefix.
    Bucket string
    The bucket name of an object.
    Content string
    Inline content as input.
    InputLocationType string
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    Namespace string
    The namespace name of an object.
    Prefix string
    The prefix of file object(s) or folder prefix.
    bucket String
    The bucket name of an object.
    content String
    Inline content as input.
    inputLocationType String
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    namespace String
    The namespace name of an object.
    prefix String
    The prefix of file object(s) or folder prefix.
    bucket string
    The bucket name of an object.
    content string
    Inline content as input.
    inputLocationType string
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    namespace string
    The namespace name of an object.
    prefix string
    The prefix of file object(s) or folder prefix.
    bucket str
    The bucket name of an object.
    content str
    Inline content as input.
    input_location_type str
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    namespace str
    The namespace name of an object.
    prefix str
    The prefix of file object(s) or folder prefix.
    bucket String
    The bucket name of an object.
    content String
    Inline content as input.
    inputLocationType String
    Type of InputLocation. The allowed values are:

    • INLINE: The input location is inline.
    • OBJECT_STORAGE_PREFIX: The input location is object storage.
    namespace String
    The namespace name of an object.
    prefix String
    The prefix of file object(s) or folder prefix.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
    pulumi/pulumi-oci
      Meet Neo: Your AI Platform Teammate