Design Settings History

{{ agentToolTypeUiData.blueBoxDescription || agentToolTypeUiData.description}}.

Dataset

Lookup columns

Columns that the Agent can use to search for the record of interest. Leave empty to use all columns of the dataset

Data columns

Columns that will be returned to the Agent. Leave empty to use all columns of the dataset

Retrieval mode

This should usually be kept to a very low number (< 10)

LLM / Agent

System prompt

<span class="help-inline">
                                                System prompt that will be prepended to the LLM / Agent invocation
                                            </span>
                                        </div>
                                    </div>

<agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form>

<div ng-if="activeLLM">
                                        <form class="dkuform-horizontal">
                                            <h4 class="settings-section-title">Completion settings</h4>
                                            <prompt-llm-completion-settings completion-settings="agentTool.params.completionSettings" active-llm="activeLLM"></prompt-llm-completion-settings>
                                        </form>
                                    </div>
                                </form>
                            </div>

<div ng-if="agentTool.type == 'DatasetRowAppend'">
                                <form class="dkuform-horizontal">
                                    <div class="control-group">
                                        <label class="control-label">
                                            Dataset
                                        </label>
                                        <div class="controls">
                                            <div class="tool-agent--dataset-selector"
                                                 dataset-selector="agentTool.params.datasetRef"
                                                 on-dataset-selector-change="updateInputDatasetColumns()"
                                                 popover-placement="right"
                                                 available-datasets="availableDatasets"></div>
                                        </div>
                                    </div>
                                    <div class="control-group">
                                        <label class="control-label">
                                            Restrict to columns
                                        </label>
                                        <div class="controls">
                                            <basic-select
                                                    items="datasetColumns"
                                                    searchable="true"
                                                    actions-box="true"
                                                    placeholder="Select columns"
                                                    ng-model="agentTool.params.restrictColumns"
                                                    multiple="true" />
                                            <span class="help-inline">
                                            Columns that the Agent can write. Leave empty to allow all columns of the dataset
                                        </span>
                                        </div>
                                    </div>

<agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form>
                                </form>
                            </div>

<div ng-if="agentTool.type == 'VectorStoreSearch'">
                                <form class="dkuform-horizontal mbot24">
                                    <div class="control-group">
                                        <label class="control-label">
                                            Knowledge Bank
                                        </label>
                                        <div class="controls">
                                            <div object-picker="agentTool.params.knowledgeBankRef" type="RETRIEVABLE_KNOWLEDGE" class="tool-agent-kb--object-picker"></div>
                                        </div>
                                    </div>

<agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form>

<div class="control-group">
                                        <label for="kbDocumentLevelSecurity" class="control-label">
                                            Enforce document-level security
                                        </label>
                                        <div class="controls">
                                            <input id="kbDocumentLevelSecurity" type="checkbox" ng-model="agentTool.params.enforceDocumentLevelSecurity" ng-disabled="knowledgeBank && knowledgeBank.vectorStoreType == 'VERTEX_AI_GCS_BASED'" />
                                            <span class="help-inline" ng-if="knowledgeBank && knowledgeBank.vectorStoreType == 'VERTEX_AI_GCS_BASED'">
                                                The VertexAI vector store doesn't support document-level security.
                                            </span>
                                        </div>
                                    </div>
                                    <div class="alert alert-warning horizontal-flex" ng-if="embeddingRecipeDesc && !embeddingRecipeDesc.securityTokensColumn && agentTool.params.enforceDocumentLevelSecurity">
                                        <div class="padright16"><i class="icon-dku-warning" /></div>
                                        <div>To use this property, please select a Security tokens column in the Embedding Recipe <a ng-if="getParentRecipeHref()" href="{{getParentRecipeHref()}}" target="_blank"> {{rkFullInfo.creatingRecipe.name}}</a> advanced properties.</div>
                                    </div>

<h2 class="settings-section-title">Retrieval</h2>
                                    <div class="mtop24">
                                        <retrieval-params-settings ng-if="knowledgeBank" llm-exposed-with="agentTool.params" retrievable-knowledge="knowledgeBank"
                                                                   embedding-recipe-desc="embeddingRecipeDesc"/>
                                    </div>
                                    <div class="control-group">
                                        <label for="kbRetrieveAllMetadata" class="control-label">
                                            Retrieve all metadata
                                        </label>
                                        <div class="controls">
                                            <input id="kbRetrieveAllMetadata" type="checkbox" ng-model="agentTool.params.allMetadataInContext" />
                                            <span class="help-inline">
                                                If enabled, all metadata items of the document are retrieved and sent to the Agent
                                            </span>
                                        </div>
                                    </div>
                                    <div class="control-group" ng-if="!agentTool.params.allMetadataInContext">
                                        <label class="control-label">
                                            Metadata to retrieve
                                        </label>
                                        <div class="controls">
                                            <basic-select
                                                    items="knowledgeBankSchemaColumnNames"
                                                    searchable="true"
                                                    placeholder="Select columns"
                                                    ng-model="agentTool.params.metadataInContext"
                                                    multiple="true" />
                                        </div>
                                    </div>

<h2 ng-if="agentTool.params && agentTool.params.sourcesSettings && knowledgeBankSchemaColumnNames.length" class="settings-section-title">Sources</h2>
                                    <additional-info-sources-formatting-config
                                            ng-if="agentTool.params && agentTool.params.sourcesSettings && knowledgeBankSchemaColumnNames.length"
                                            model="agentTool.params.sourcesSettings"
                                            metadata-columns="knowledgeBankSchemaColumnNames">
                                    </additional-info-sources-formatting-config>

<h2 class="settings-section-title">Filtering</h2>
                                    <vector-store-filter ng-if="knowledgeBank && agentTool" knowledge-bank="knowledgeBank" filter="agentTool.params.filter" perform-filtering="agentTool.params.performFiltering"></vector-store-filter>

<div class="control-group">
                                        <label for="allowDynamicFiltering" class="control-label">
                                            Allow dynamic filtering
                                        </label>
                                        <div class="controls">
                                            <input id="allowDynamicFiltering" type="checkbox" ng-model="agentTool.params.allowDynamicFiltering" />
                                            <span class="help-inline">
                                                    If enabled, query level filtering will be supported
                                                </span>
                                        </div>
                                    </div>
                                </form>
                            </div>

<div ng-if="agentTool.type == 'ClassicalPredictionModelPredict'">
                                <form class="dkuform-horizontal">
                                    <div class="control-group">
                                        <label class="control-label">
                                            Saved model
                                        </label>
                                        <div class="controls">
                                            <basic-select ng-if="availableSavedModels"
                                            items="availableSavedModels"
                                            ng-model="agentTool.params.smRef"
                                            bind-value="ref"
                                            bind-label="name"
                                            searchable="true"
                                            invalidate-on-ghosts="true"
                                            ghost-items-tooltip="Saved Model not available. It has been disabled, retired, or is not supported for this feature. Choose another Saved Model or contact your administrator."></basic-select>
                                            <div class="mbot0 mtop8 alert alert-warning" ng-if="agentTool.params.smRef && (availableSavedModels | filter:{ref: agentTool.params.smRef}:true).length === 0">
                                                Saved Model not available. It has been disabled, retired, or is not supported for this feature. Choose another Saved Model or contact your administrator.
                                            </div>
                                        </div>
                                    </div>

<div ng-if="agentTool.type == 'DataikuReporter'">
                                <h3 class="settings-section-title">Channel settings</h3>
                                <form class="dkuform-horizontal">
                                    <div class="control-group">
                                        <label class="control-label">
                                            Integration type
                                        </label>
                                        <div class="controls">
                                            <select ng-model="agentTool.params.integration.type" ng-options="type.id as type.label for type in integrationTypes" />
                                        </div>
                                    </div>
                                    <div ng-if="agentTool.params.integration.type" tool-integration-params hook="agentTool.params.integration" />
                                </form>

<h3 class="settings-section-title">Variables</h3>
                                <div class="alert alert-warning mbot0" ng-if="undefinedTemplateVariables.length || hasUnusedVariable()">
                                    <div ng-if="undefinedTemplateVariables.length == 1">Variable <em>{{ undefinedTemplateVariables[0] }}</em> is used but not defined below. <a ng-click="addUndefinedVariables()">Add it to the list</a>.</div>
                                    <div ng-if="undefinedTemplateVariables.length > 1">{{ undefinedTemplateVariables.length }} variables are used but not defined below. <a ng-click="addUndefinedVariables()">Add them to the list</a>.</div>
                                    <div ng-if="unusedToolVariables.length == 1">Variable <em>{{ unusedToolVariables[0] }}</em> is not used. <a ng-click="removeUnusedVariables()">Remove it from the list</a>.</div>
                                    <div ng-if="unusedToolVariables.length > 1">{{ unusedToolVariables.length }} variables are not used. <a ng-click="removeUnusedVariables()">Remove them from the list</a>.</div>
                                </div>
                                <p>Available variables to customize the message to be sent (content, recipients etc.). Can be used in the template with <em>${variable}</em> syntax.</p>
                                <div add-remove ng-model="agentTool.params.variables">
                                    <editable-list ng-model="agentTool.params.variables" sortable="true" template="{sourceType: 'TOOL_INPUT'}"
                                                   add-label="Add a variable" on-change="variableChanged" class="tool-agent--variable-list"
                                                   transcope="{editFormula: editFormula, dssVariablesOptions: dssVariablesOptions, variableTypes: variableTypes, isUnused: isUnusedVariable, hasUnusedVariable: hasUnusedVariable}">
                                        <span style="width:16px" ng-if="hasUnusedVariable()">
                                            <span ng-if="isUnused(it.id)">
                                                <i class="dku-icon-warning-outline-16 text-warning" toggle="tooltip-right" title="This variable is not used in any template field."></i>
                                            </span>
                                        </span>
                                        <editable-list-input type="text" ng-model="it.id" unique="true" placeholder="E.g. productName, recipient" required="true"/>
                                        <div>
                                            <basic-select items="variableTypes" ng-model="it.sourceType"
                                                          bind-value="id" bind-label="label"
                                                          bind-annotation="description" annotation-layout="description"
                                                          placeholder="Select type">
                                            </basic-select>
                                        </div>
                                        <editable-list-input ng-if="it.sourceType=='TOOL_INPUT'" type="text" ng-model="it.toolInputDescription" placeholder="Input description for the LLM" required="true"/>
                                        <editable-list-input ng-if="it.sourceType=='QUERY_CONTEXT'" type="text" ng-model="it.contextPath" placeholder="JSONPath: e.g. dssUser.email" required="true"/>
                                        <input class="editable-list__input" ng-if="it.sourceType=='DSS_VARIABLE'" type="text" placeholder="DSS Variable name" ng-model="it.dssVariableName" bs-typeahead="dssVariablesOptions" />
                                        <span ng-if="it.sourceType=='FORMULA'" style="width: 165px;display: inline-block;overflow: hidden;white-space: nowrap;text-overflow: ellipsis;">{{it.expression}}</span>
                                        <a ng-if="it.sourceType=='FORMULA'" ng-click="editFormula(it, $index)">Editor</a>
                                    </editable-list>
                                </div>

<h3 class="settings-section-title">Tool description</h3>
                                <form class="dkuform-horizontal">
                                    <agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form>
                                </form>
                            </div>

<div ng-if="agentTool.type == 'ApiEndpoint'">
                                <form class="dkuform-horizontal">
                                    <div class="control-group required">
                                        <label class="control-label">Endpoint</label>
                                        <div class="controls">
                                            <select ng-model="uiState.apiEndpoint"
                                                    dku-bs-select="{'liveSearch': true, 'showContent': false}"
                                                    data-width="100%"
                                                    style="min-width: 400px;">
                                                <option ng-repeat="c in availableApiEndpoints"
                                                        value="{{c.id}}"
                                                        title="{{c.id}}"
                                                        ng-disabled="c.disabled"
                                                        ng-attr-data-content="{{c.html}}">
                                                    {{c.name}}
                                                </option>
                                            </select>
                                            <div class="alert alert-warning mbot0 mtop8" ng-if="uiState.hasError">
                                                The endpoint <span style="font-weight: bold;">{{uiState.persistedApiEndpointName}}</span> has been deleted, or you don’t have the required permissions to access or query it through the deployer.
                                            </div>
                                            <span class="help-inline">Only endpoints with an OpenAPI documentation are available</span>
                                            <div class="doctor-explanation mbot8" style="padding-bottom: 8px;" ng-if="!uiState.hasError">
                                                <p>You can define the <strong>authorization</strong> to <strong>query an endpoint through the deployer</strong> in the settings of its deployment.</p>
                                            </div>
                                        </div>
                                    </div>
                                    <div class="control-group" ng-if="uiState.apiEndpoint">
                                        <label for="description" class="control-label">Description</label>
                                        <div class="controls">
                                            <textarea id="description" style="width:400px; height: 60px" ng-model="agentTool.params.$description" disabled/>
                                            <span class="help-inline">Parsed from the description of the operation defined in the OpenAPI documentation</span>
                                            <div class="doctor-explanation mtop8 mbot8">
                                                <p>The resulting description must clearly state <strong>the role</strong> of the endpoint. It should also specify the <strong>expected input</strong>, as well as <strong>how to interpret the output</strong>. Indicating the exact format of both input and output is helpful for correct integration and usage.</p>
                                                <em>Example: The "Customer Success > Predict Churn" endpoint predicts the probability that a customer will churn, based on several criteria such as account age, recent activity level, number of support tickets, and subscription type. The output is a number between 0 (unlikely to churn) and 1 (very likely to churn).</em>
                                            </div>
                                        </div>
                                    </div>

<div ng-if="agentTool.type == 'GenericStdioMCPClient'">
                                <form class="dkuform-horizontal" name="mcpToolEditor">
                                    <div class="control-group">
                                        <label class="control-label" for="command">
                                            Configure settings below or
                                        </label>
                                        <div class="controls">
                                            <a class="btn btn--outline btn--primary" ng-click="showMCPJsonConfigModal()" title="Fill server settings from an MCP JSON configuration">
                                                Paste JSON config
                                            </a>
                                        </div>
                                    </div>

<div class="control-group">
                                        <label class="control-label" for="command">
                                            Command
                                        </label>
                                        <div class="controls">
                                            <input type="text" id="command" ng-model="agentTool.params.command" ng-disabled="agentTool.params.useCodeEnvPythonAsCommand"/>
                                            <div class="help-inline">
                                                <label class="di" for="use-code-env-python-as-command">
                                                    <input type="checkbox" id="use-code-env-python-as-command" ng-model="agentTool.params.useCodeEnvPythonAsCommand" />
                                                    Use the Code Env's Python as command, useful for Python MCP servers
                                                </label>
                                            </div>
                                        </div>
                                    </div>

<div class="control-group">
                                        <label class="control-label">
                                            Arguments
                                        </label>
                                        <div class="controls">
                                            <ng2-values-list [(items)]="agentTool.params.args" add-label="Add" value-placeholder="Argument"/>
                                            <span class="help-inline">
                                                Add each argument separately. For example, <code>--some-key somevalue</code> is 2 arguments
                                            </span>
                                        </div>
                                    </div>

<div class="control-group mcp-environment-variables">
                                        <label class="control-label">
                                            Environment variables
                                        </label>
                                        <div class="controls">
                                            <ng2-connection-properties-list [(items)]="agentTool.params.env"></ng2-connection-properties-list>
                                        </div>
                                    </div>

<agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form>

<h4 class="settings-section-title">
                                        MCP tools
                                    </h4>

<div class="control-group" ng-if="!subtools">
                                        <label for="global-enable-all-subtools" class="control-label" title="Enable all tools from this server (including new ones if the server is updated)">
                                            Enable all (incl. future)
                                        </label>
                                        <div class="controls">
                                            <label class="dku-toggle mleft0">
                                                <input type="checkbox" id="global-enable-all-subtools" ng-model="agentTool.params.subtoolsEnabledByDefault" ng-change="subtoolsEnabledByDefaultChanged(agentTool.params.subtoolsEnabledByDefault)" />
                                                <span style="display: inline-block; position: relative;" ></span>
                                            </label>
                                        </div>
                                    </div>

<div ng-if="subtoolsError" class="alert alert-warning">
                                        Note that the selected code environment must use Python 3.10 to 3.13. It must include the <code>fastmcp</code> package.<br/>
                                        Use the <i>Agent tool MCP servers support</i> container runtime addition to add <code>uvx</code> and <code>npx</code> to the code env container image.<br/>
                                        Use the Test feature to get more debug info.
                                    </div>

<div ng-show="!subtools">
                                        <div class="empty-list-cta empty-list-cta__mcp-subtools mtop0">
                                            <h4 class="settings-section-title mtop0" ng-show="!loadingSubtools">MCP tools have not been loaded yet</h4>
                                            <h4 class="settings-section-title mtop0" ng-show="loadingSubtools">Loading MCP tools...</h4>

<a class="btn btn--primary btn--dku-icon" ng-click="loadSubtools()" ng-disabled="loadingSubtools">
                                                <i class="dku-icon-arrow-circular-16"></i>
                                                <span>Load tools</span>
                                            </a>
                                        </div>
                                    </div>

<div filtered-multi-select-rows ng-if="subtools != undefined" ng-model="subtools">
                                        <div ng-show="subtools.length > 0" class="mcp-subtools-actions-row horizontal-flex">
                                            <div class="noflex dropdown mass-action-btn">
                                                <input type="checkbox" class="select-cb" ng-model="selection.all" ng-disabled="agentTool.params.subtoolsEnabledByDefault" dku-indeterminate="selection.some" ng-change="updateMassSelectionCheckbox()">
                                                <a data-toggle="dropdown"
                                                   class="dropdown-toggle unselectable"
                                                   ng-class="{disabled: selection.selectedObjects.length == 0, collapsed: selection.none}">
                                                    <span>ACTIONS</span>
                                                    <b class="caret"></b>
                                                </a>
                                                <ul data-block="mass-action-dropdrop-menu" class="dropdown-menu dropdown-menu--dku-icon">
                                                    <li ng-show="!areAllSelectedSubtoolsActive()" title="{{agentTool.params.subtoolsEnabledByDefault ? 'Toggle "Enable all (incl. future)" off in order to enable individual tools' : ''}}">
                                                        <a ng-disabled="agentTool.params.subtoolsEnabledByDefault" ng-click="enableSelectedSubtools()"><i class="dku-icon-power-16"></i>Enable</a>
                                                    </li>
                                                    <li ng-show="areAllSelectedSubtoolsActive()" title="{{agentTool.params.subtoolsEnabledByDefault ? 'Toggle "Enable all (incl. future)" off in order to disable individual tools' : ''}}">
                                                        <a ng-disabled="agentTool.params.subtoolsEnabledByDefault" ng-click="disableSelectedSubtools()"><i class="dku-icon-power-16"></i>Disable</a>
                                                    </li>
                                                </ul>
                                            </div>

<div class="horizontal-flex aie">
                                                <div class="mright8">
                                                    <label for="enable-all-subtools" class="control-label control-label__mcp-subtools" title="Enable all tools from this server (including new ones if the server is updated)">Enable all (incl. future)</label>
                                                    <label class="dku-toggle">
                                                        <input type="checkbox" id="enable-all-subtools" ng-model="agentTool.params.subtoolsEnabledByDefault" ng-change="subtoolsEnabledByDefaultChanged(agentTool.params.subtoolsEnabledByDefault)" />
                                                        <span style="display: inline-block; position: relative;" ></span>
                                                    </label>
                                                </div>
                                                <a class="btn btn--secondary btn--dku-icon" ng-click="loadSubtools()">
                                                    <i class="dku-icon-arrow-circular-16"></i>
                                                    <span>Reload</span>
                                                </a>
                                            </div>
                                        </div>

<table class="table table-hover table-striped mcp-subtools">
                                            <thead>
                                                <tr>
                                                    <th></th>
                                                    <th>Name</th>
                                                    <th>Description</th>
                                                    <th>Enabled</th>
                                                    <th>Test</th>
                                                </tr>
                                            </thead>
                                            <tbody>
                                                <tr ng-repeat="subtool in selection.filteredObjects | orderBy:'name' track by subtool.name">
                                                    <td class="checkbox-column" title="{{agentTool.params.subtoolsEnabledByDefault ? 'Toggle "Enable all (incl. future)" off in order to toggle individual tools' : ''}}">
                                                        <input type="checkbox" id="checkbox-{{ subtool.name }}" class="mright4" ng-model="subtool.$selected" ng-disabled="agentTool.params.subtoolsEnabledByDefault" ng-click="subtool.$selected = !subtool.$selected; checkBoxChanged(subtool, $event);"/>
                                                    </td>
                                                    <td>
                                                        <label for="checkbox-{{ subtool.name }}">{{ subtool.name }}</label>
                                                    </td>
                                                    <td>{{ subtool.description }}</td>
                                                    <td>
                                                        <label class="dku-toggle list-item__toggle mleft0" title="{{agentTool.params.subtoolsEnabledByDefault ? 'Toggle "Enable all (incl. future)" off in order to disable individual tools' : ''}}">
                                                            <input type="checkbox" ng-checked="getSubtoolToggleState(subtool)" ng-disabled="agentTool.params.subtoolsEnabledByDefault" ng-click="toggleSubtool(subtool)"/>
                                                            <span style="display: inline-block; position: relative;" ></span>
                                                        </label>
                                                    </td>
                                                    <td>
                                                        <input type="button" class="btn btn--text btn--primary" ng-click="prefillTestQuery(subtool)" ng-disabled="!getSubtoolToggleState(subtool)" value="Fill query"/>
                                                    </td>
                                                </tr>
                                            </tbody>
                                        </table>
                                    </div>
                                </form>
                            </div>
                        </div>
                    </div>
                    <div class="span6 offset0 mbot16" style="margin-left: 1%;">
                        <div class="generic-white-box">
                            <agent-tool-quicktest
                                    project-key="$stateParams.projectKey"
                                    agent-tool-id="$stateParams.agentToolId"
                                    agent-tool-type="agentTool.type"
                                    quick-test-query="agentTool.quickTestQuery"
                                    save-tool="saveIgnoringQuickTestQuery()"
                                    dataset-schema="datasetSchema"></agent-tool-quicktest>
                        </div>
                    </div>
                </div>

<div ng-if="agentTool.type === 'InlinePython'" class="resizable-code-editor tool-agent__resizable-code-editor pad16">
                    <div class="left-pane fh oa">
                        <div class="generic-white-box tool-agent__generic-white-box">
                            <div ng-if="agentToolTypeUiData.label" class="settings-section-title mtop0">
                                {{agentToolTypeUiData.label}}
                            </div>
                            <div ng-if="agentToolTypeUiData.description" class="alert alert-info">
                                <span>{{agentToolTypeUiData.description}}.</span>
                                <doclink ng-if="agentToolTypeUiData.documentationLink" page="{{agentToolTypeUiData.documentationLink}}" title="Read the documentation to learn more."/>
                            </div>

<h2 class="settings-section-title" ng-class="{mtop0: agentTool.type != 'VectorStoreSearch' && !agentToolTypeUiData.codeEnvSelectionSupported && !agentToolTypeUiData.containerExecutionSupported}">Advanced</h2>
                                <div class="alert alert-info">
                                    Configure advanced Dataiku-specific properties for this tool. Usually used at the direction of Dataiku Support.
                                </div>
                                <div class="control-group">
                                    <label class="control-label">Properties</label>
                                    <div class="controls">
                                        <ng2-connection-properties-list [(items)]="agentTool.dkuProperties"></ng2-connection-properties-list>
                                    </div>
                                </div>
                            </form>
                        </div>
                    </div>
                </div>
            </div>
            <div class="pad16" ng-if="topNav.tab == 'history'">
                <div class="container-fluid page-top-padding fh oa">
                    <div object-git-history object-type="AGENT_TOOL" object-id="$stateParams.agentToolId" project-key="$stateParams.projectKey" object-revertable="true" />
                </div>
            </div>
        </div>
    </div>
</div>
<standardized-side-panel page="object" object-type="AGENT_TOOL" toggle-tab="{{ standardizedSidePanel.tabToToggle }}" close-on-click-outside="true">
</standardized-side-panel>