Configuration settings for the tool, stored as JSON. Applies to all tool types.

JSON schema, defining expected input parameters. Tool-specific behavior:

GENERAL tools:

• contactCenter, dialogflow, dummyTool: Must be null/empty, no custom args.
• webSearch: If null or empty, defaults to standard 'query' parameter (required).
• userProfileMemory: required custom argsSchema.

RETRIEVAL tools: If null or empty, defaults to standard 'query' parameter (required).

API tools: Can be null/empty or customized.
NOTE: For API tools, 'params' and 'argsSchema' must match (they represent the same data).

MCP tools: Can be null/empty or customized. NOTE: For MCP tools, 'params' and 'argsSchema' must match (they represent the same data).

HTTP headers. Applies to API and MCP tools.

URL query parameters. Applies to API and MCP tools.

Request body for methods like POST, PUT. Applies to API tools only.

Custom retrieval settings for the tool, including RBAC configuration.

RBAC Fields:

• enforceDocumentFilters (boolean): When true, applies RBAC filtering to retrieval results based on user permissions.
• filtersContextKey (string): JSON path in the context object to extract user access filters (e.g., "profile.allowedFilters", "docAccess").

Other Common Fields:

• strategy (string): Retrieval strategy. Values: "semantic", "keyword", "hybrid".
• similarityThreshold (number): Minimum similarity score for semantic matches (0-1).
• totalMatches (integer): Maximum number of documents to retrieve.
• similarityMatches (integer): Number of semantic similarity matches (used with hybrid strategy).
• keywordMatches (integer): Number of keyword matches (used with hybrid strategy).
• includeMetadata (boolean): Whether to include document metadata in results.

Example:

{
  "strategy": "hybrid",
  "similarityMatches": 8,
  "keywordMatches": 4,
  "similarityThreshold": 0.6,
  "totalMatches": 15,
  "includeMetadata": true,
  "enforceDocumentFilters": true,
  "filtersContextKey": "profile.allowedFilters"
}

RBAC Behavior:

• When enforceDocumentFilters is false or not set, all documents are retrieved (no RBAC filtering).
• When enforceDocumentFilters is true:
  • Retrieves user filters from the path specified in filtersContextKey in the context object.
  • Only returns chunks from documents where:
    • visibilityMode is "public", OR
    • visibilityMode is "restricted" AND at least one of the document's accessFilters matches the user's filters.
  • If user has no filters or the context key doesn't exist, only "public" documents are returned.

List of Ingestion Source IDs to associate for creation/replacement. Applies to RETRIEVAL tools only.

Configuration settings for the tool selection. Applies to MCP tools only.