Function getCopilotToolDescription

apps/sim/lib/copilot/tools/descriptions.ts:8–36

(
  tool: Pick<ToolConfig, 'description' | 'hosting' | 'id' | 'name'>,
  options?: {
    isHosted?: boolean
    fallbackName?: string
    appendEmailTagline?: boolean
  }
)

const EMAIL_TAGLINE_TOOL_IDS = new Set(['gmail_send', 'gmail_send_v2', 'outlook_send'])

export function getCopilotToolDescription(
  tool: Pick<ToolConfig, 'description' | 'hosting' | 'id' | 'name'>,
  options?: {
    isHosted?: boolean
    fallbackName?: string
    appendEmailTagline?: boolean
  }
): string {
  const baseDescription = tool.description || tool.name || options?.fallbackName || ''
  const notes: string[] = []

  if (options?.isHosted && tool.hosting && !baseDescription.includes(HOSTED_API_KEY_NOTE)) {
    notes.push(HOSTED_API_KEY_NOTE)
  }

  if (
    options?.appendEmailTagline &&
    EMAIL_TAGLINE_TOOL_IDS.has(tool.id) &&
    !baseDescription.includes(EMAIL_TAGLINE_NOTE)
  ) {
    notes.push(EMAIL_TAGLINE_NOTE)
  }

  if (notes.length === 0) {
    return baseDescription
  }

  return [baseDescription, ...notes].filter(Boolean).join(' ')
}