FoundryToolboxResource

Handle

📦 Aspire.Hosting.Foundry v13.6.0-preview.1.26478.8

interface FoundryToolboxResource
  extends IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithConnectionString,
    IValueProvider,
    IValueWithReferences {
  asExisting(): FoundryToolboxResource;
  publishAsExisting(): FoundryToolboxResource;
  runAsExisting(): FoundryToolboxResource;
  withAISearchTool(
      name: string,
      search: AzureSearchResource,
      indexName: string,
      description?: string): FoundryToolboxResource;
  withDescription(description: string): FoundryToolboxResource;
  withMcpTool(
      name: string,
      endpoint: string | EndpointReference | ReferenceExpression,
      options?: FoundryToolboxMcpToolOptions): FoundryToolboxResource;
  withWebSearchTool(
      name?: string,
      description?: string): FoundryToolboxResource;
}

7 members

Methods

methodasExistingbuilder

Uses an existing Microsoft Foundry Toolbox during local runs and deployment.

asExisting(): FoundryToolboxResource

Returns

FoundryToolboxResource

methodpublishAsExistingbuilder

Reconciles a Microsoft Foundry Toolbox during local runs and uses an existing Toolbox during deployment.

publishAsExisting(): FoundryToolboxResource

Returns

FoundryToolboxResource

methodrunAsExistingbuilder

Uses an existing Microsoft Foundry Toolbox during local runs and reconciles it during deployment.

runAsExisting(): FoundryToolboxResource

Returns

FoundryToolboxResource

methodwithAISearchToolbuilder

Adds an Azure AI Search tool definition to the Toolbox.

withAISearchTool(
    name: string,
    search: AzureSearchResource,
    indexName: string,
    description?: string): FoundryToolboxResource

Parameters

namestring

searchAzureSearchResource

indexNamestring

descriptionstringoptional

Returns

FoundryToolboxResource

methodwithDescriptionbuilder

Sets the description persisted with each Toolbox version.

withDescription(description: string): FoundryToolboxResource

Parameters

descriptionstring

Returns

FoundryToolboxResource

methodwithMcpToolbuilder

Adds an MCP tool definition to the Toolbox.

withMcpTool(
    name: string,
    endpoint: string | EndpointReference | ReferenceExpression,
    options?: FoundryToolboxMcpToolOptions): FoundryToolboxResource

Parameters

namestring

endpointstring | EndpointReference | ReferenceExpression

optionsFoundryToolboxMcpToolOptionsoptional

Returns

FoundryToolboxResource

methodwithWebSearchToolbuilder

Adds a web search tool definition to the Toolbox.

withWebSearchTool(
    name?: string,
    description?: string): FoundryToolboxResource

Parameters

namestringoptional= web-search

descriptionstringoptional

Returns

FoundryToolboxResource