added description for inputs to workflow

Author: waleedlatif1

README.md

@@ -14,7 +14,7 @@
 </p>
 
 <p align="center">
-  <a href="https://deepwiki.com/simstudioai/sim" target="_blank" rel="noopener noreferrer"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>  <a href="https://cursor.com/link/prompt?text=Help%20me%20set%20up%20Sim%20Studio%20locally.%20Follow%20these%20steps%3A%0A%0A1.%20First%2C%20verify%20Docker%20is%20installed%20and%20running%3A%0A%20%20%20docker%20--version%0A%20%20%20docker%20info%0A%0A2.%20Clone%20the%20repository%3A%0A%20%20%20git%20clone%20https%3A%2F%2Fgithub.com%2Fsimstudioai%2Fsim.git%0A%20%20%20cd%20sim%0A%0A3.%20Start%20the%20services%20with%20Docker%20Compose%3A%0A%20%20%20docker%20compose%20-f%20docker-compose.prod.yml%20up%20-d%0A%0A4.%20Wait%20for%20all%20containers%20to%20be%20healthy%20(this%20may%20take%201-2%20minutes)%3A%0A%20%20%20docker%20compose%20-f%20docker-compose.prod.yml%20ps%0A%0A5.%20Verify%20the%20app%20is%20accessible%20at%20http%3A%2F%2Flocalhost%3A3000%0A%0AIf%20there%20are%20any%20errors%2C%20help%20me%20troubleshoot%20them.%20Common%20issues%3A%0A-%20Port%203000%2C%203002%2C%20or%205432%20already%20in%20use%0A-%20Docker%20not%20running%0A-%20Insufficient%20memory%20(needs%2012GB%2B%20RAM)%0A%0AFor%20local%20AI%20models%20with%20Ollama%2C%20use%20this%20instead%20of%20step%203%3A%0A%20%20%20docker%20compose%20-f%20docker-compose.ollama.yml%20--profile%20setup%20up%20-d"><img src="https://img.shields.io/badge/Set%20Up%20with-Cursor-000000?logo=cursor&logoColor=white" alt="Set Up with Cursor"></a>
+  <a href="https://deepwiki.com/simstudioai/sim" target="_blank" rel="noopener noreferrer"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>  <a href="https://cursor.com/link/prompt?text=Help%20me%20set%20up%20Sim%20locally.%20Follow%20these%20steps%3A%0A%0A1.%20First%2C%20verify%20Docker%20is%20installed%20and%20running%3A%0A%20%20%20docker%20--version%0A%20%20%20docker%20info%0A%0A2.%20Clone%20the%20repository%3A%0A%20%20%20git%20clone%20https%3A%2F%2Fgithub.com%2Fsimstudioai%2Fsim.git%0A%20%20%20cd%20sim%0A%0A3.%20Start%20the%20services%20with%20Docker%20Compose%3A%0A%20%20%20docker%20compose%20-f%20docker-compose.prod.yml%20up%20-d%0A%0A4.%20Wait%20for%20all%20containers%20to%20be%20healthy%20(this%20may%20take%201-2%20minutes)%3A%0A%20%20%20docker%20compose%20-f%20docker-compose.prod.yml%20ps%0A%0A5.%20Verify%20the%20app%20is%20accessible%20at%20http%3A%2F%2Flocalhost%3A3000%0A%0AIf%20there%20are%20any%20errors%2C%20help%20me%20troubleshoot%20them.%20Common%20issues%3A%0A-%20Port%203000%2C%203002%2C%20or%205432%20already%20in%20use%0A-%20Docker%20not%20running%0A-%20Insufficient%20memory%20(needs%2012GB%2B%20RAM)%0A%0AFor%20local%20AI%20models%20with%20Ollama%2C%20use%20this%20instead%20of%20step%203%3A%0A%20%20%20docker%20compose%20-f%20docker-compose.ollama.yml%20--profile%20setup%20up%20-d"><img src="https://img.shields.io/badge/Set%20Up%20with-Cursor-000000?logo=cursor&logoColor=white" alt="Set Up with Cursor"></a>
 </p>
 
 ### Build Workflows with Ease

apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/starter/input-format.tsx

@@ -28,6 +28,7 @@ interface Field {
   name: string
   type?: 'string' | 'number' | 'boolean' | 'object' | 'array' | 'files'
   value?: string
+  description?: string
   collapsed?: boolean
 }
 
@@ -41,7 +42,9 @@ interface FieldFormatProps {
   placeholder?: string
   showType?: boolean
   showValue?: boolean
+  showDescription?: boolean
   valuePlaceholder?: string
+  descriptionPlaceholder?: string
   config?: any
 }
 
@@ -73,6 +76,7 @@ const createDefaultField = (): Field => ({
   name: '',
   type: 'string',
   value: '',
+  description: '',
   collapsed: false,
 })
 
@@ -93,7 +97,9 @@ export function FieldFormat({
   placeholder = 'fieldName',
   showType = true,
   showValue = false,
+  showDescription = false,
   valuePlaceholder = 'Enter default value',
+  descriptionPlaceholder = 'Describe this field',
 }: FieldFormatProps) {
   const [storeValue, setStoreValue] = useSubBlockValue<Field[]>(blockId, subBlockId)
   const valueInputRefs = useRef<Record<string, HTMLInputElement | HTMLTextAreaElement>>({})
@@ -554,6 +560,18 @@ export function FieldFormat({
                 </div>
               )}
 
+              {showDescription && (
+                <div className='flex flex-col gap-[6px]'>
+                  <Label className='text-[13px]'>Description</Label>
+                  <Input
+                    value={field.description ?? ''}
+                    onChange={(e) => updateField(field.id, 'description', e.target.value)}
+                    placeholder={descriptionPlaceholder}
+                    disabled={isReadOnly}
+                  />
+                </div>
+              )}
+
               {showValue && (
                 <div className='flex flex-col gap-[6px]'>
                   <Label className='text-[13px]'>Value</Label>
@@ -568,8 +586,10 @@ export function FieldFormat({
   )
 }
 
-export function InputFormat(props: Omit<FieldFormatProps, 'title' | 'placeholder'>) {
-  return <FieldFormat {...props} title='Input' placeholder='firstName' />
+export function InputFormat(
+  props: Omit<FieldFormatProps, 'title' | 'placeholder' | 'showDescription'>
+) {
+  return <FieldFormat {...props} title='Input' placeholder='firstName' showDescription={true} />
 }
 
 export function ResponseFormat(

apps/sim/providers/utils.ts

@@ -34,6 +34,51 @@ import { mergeToolParameters } from '@/tools/params'
 
 const logger = createLogger('ProviderUtils')
 
+/**
+ * Checks if a workflow description is a default/placeholder description
+ */
+function isDefaultWorkflowDescription(
+  description: string | null | undefined,
+  name?: string
+): boolean {
+  if (!description) return true
+  const normalizedDesc = description.toLowerCase().trim()
+  return (
+    description === name ||
+    normalizedDesc === 'new workflow' ||
+    normalizedDesc === 'your first workflow - start building here!'
+  )
+}
+
+/**
+ * Fetches workflow metadata (name and description) from the API
+ */
+async function fetchWorkflowMetadata(
+  workflowId: string
+): Promise<{ name: string; description: string | null } | null> {
+  try {
+    const { buildAuthHeaders, buildAPIUrl } = await import('@/executor/utils/http')
+
+    const headers = await buildAuthHeaders()
+    const url = buildAPIUrl(`/api/workflows/${workflowId}`)
+
+    const response = await fetch(url.toString(), { headers })
+    if (!response.ok) {
+      logger.warn(`Failed to fetch workflow metadata for ${workflowId}`)
+      return null
+    }
+
+    const { data } = await response.json()
+    return {
+      name: data?.name || 'Workflow',
+      description: data?.description || null,
+    }
+  } catch (error) {
+    logger.error('Error fetching workflow metadata:', error)
+    return null
+  }
+}
+
 /**
  * Client-safe provider metadata.
  * This object contains only model lists and patterns - no executeRequest implementations.
@@ -479,16 +524,30 @@ export async function transformBlockTool(
   const llmSchema = await createLLMToolSchema(toolConfig, userProvidedParams)
 
   let uniqueToolId = toolConfig.id
+  let toolName = toolConfig.name
+  let toolDescription = toolConfig.description
+
   if (toolId === 'workflow_executor' && userProvidedParams.workflowId) {
     uniqueToolId = `${toolConfig.id}_${userProvidedParams.workflowId}`
+
+    const workflowMetadata = await fetchWorkflowMetadata(userProvidedParams.workflowId)
+    if (workflowMetadata) {
+      toolName = workflowMetadata.name || toolConfig.name
+      if (
+        workflowMetadata.description &&
+        !isDefaultWorkflowDescription(workflowMetadata.description, workflowMetadata.name)
+      ) {
+        toolDescription = workflowMetadata.description
+      }
+    }
   } else if (toolId.startsWith('knowledge_') && userProvidedParams.knowledgeBaseId) {
     uniqueToolId = `${toolConfig.id}_${userProvidedParams.knowledgeBaseId}`
   }
 
   return {
     id: uniqueToolId,
-    name: toolConfig.name,
-    description: toolConfig.description,
+    name: toolName,
+    description: toolDescription,
     params: userProvidedParams,
     parameters: llmSchema,
   }

apps/sim/tools/params.ts

@@ -518,7 +518,7 @@ async function applyDynamicSchemaForWorkflow(
       for (const field of workflowInputFields) {
         propertySchema.properties[field.name] = {
           type: field.type || 'string',
-          description: `Input field: ${field.name}`,
+          description: field.description || `Input field: ${field.name}`,
         }
         propertySchema.required.push(field.name)
       }
@@ -533,11 +533,10 @@ async function applyDynamicSchemaForWorkflow(
 
 /**
  * Fetches workflow input fields from the API.
- * No local caching - relies on React Query caching on the client side.
  */
 async function fetchWorkflowInputFields(
   workflowId: string
-): Promise<Array<{ name: string; type: string }>> {
+): Promise<Array<{ name: string; type: string; description?: string }>> {
   try {
     const { buildAuthHeaders, buildAPIUrl } = await import('@/executor/utils/http')