Function enrichTableToolDescription

apps/sim/lib/table/llm/enrichment.ts:32–121

(
  originalDescription: string,
  table: TableSummary,
  toolId: string
)

 * Enriches a table tool description with table information based on the operation type.
 */
export function enrichTableToolDescription(
  originalDescription: string,
  table: TableSummary,
  toolId: string
): string {
  if (!table.columns || table.columns.length === 0) {
    return originalDescription
  }

  const columnList = table.columns.map((col) => `  - ${col.name} (${col.type})`).join('\n')

  if (FILTER_OPERATIONS.has(toolId)) {
    const stringCols = table.columns.filter((c) => c.type === 'string')
    const numberCols = table.columns.filter((c) => c.type === 'number')

    let filterExample = ''
    if (stringCols.length > 0 && numberCols.length > 0) {
      filterExample = `

Example filter: {"${stringCols[0].name}": {"$eq": "value"}, "${numberCols[0].name}": {"$lt": 50}}`
    } else if (stringCols.length > 0) {
      filterExample = `

Example filter: {"${stringCols[0].name}": {"$eq": "value"}}`
    }

    let sortExample = ''
    if (toolId === 'table_query_rows' && numberCols.length > 0) {
      sortExample = `
Example sort: {"${numberCols[0].name}": "desc"} for highest first, {"${numberCols[0].name}": "asc"} for lowest first`
    }

    const queryInstructions =
      toolId === 'table_query_rows'
        ? `
INSTRUCTIONS:
1. ALWAYS include a filter based on the user's question - queries without filters will fail
2. Construct the filter yourself from the user's question - do NOT ask for confirmation
3. Use exact match ($eq) by default unless the user specifies otherwise
4. For ranking queries (highest, lowest, Nth, top N):
   - ALWAYS use sort with the relevant column (e.g., {"salary": "desc"} for highest salary)
   - Use limit to get only the needed rows (e.g., limit=1 for highest, limit=2 for second highest)
   - For "second highest X", use sort: {"X": "desc"} with limit: 2, then take the second result
5. Only use limit=1000 when you need ALL matching rows`
        : `
INSTRUCTIONS:
1. ALWAYS include a filter based on the user's question - queries without filters will fail
2. Construct the filter yourself from the user's question - do NOT ask for confirmation
3. Use exact match ($eq) by default unless the user specifies otherwise`

    return `${originalDescription}
${queryInstructions}

Table "${table.name}" columns:
${columnList}
${filterExample}${sortExample}`
  }