Function buildCopilotFileParameterSchema

apps/sim/tools/params.ts:463–501

(param: ToolParamDefinition)

}

function buildCopilotFileParameterSchema(param: ToolParamDefinition): SchemaProperty {
  const baseDescription =
    param.description ||
    (param.type === 'file'
      ? 'A file object for tool execution.'
      : 'An array of file objects for tool execution.')
  const resolutionDescription =
    'For copilot and mothership tool calls, prefer passing canonical workspace file IDs such as "wf_123". The runtime will resolve them into full file objects before tool execution.'

  const fileObjectSchema: SchemaProperty = {
    type: 'object',
    description: `${baseDescription} ${resolutionDescription}`,
    properties: {
      id: { type: 'string', description: 'Canonical workspace file ID.' },
      name: { type: 'string', description: 'File name.' },
      url: { type: 'string', description: 'File URL or serve path.' },
      size: { type: 'number', description: 'File size in bytes.' },
      type: { type: 'string', description: 'MIME type.' },
      key: { type: 'string', description: 'Internal storage key.' },
      context: { type: 'string', description: 'Optional file context.' },
      base64: { type: 'string', description: 'Optional base64-encoded file contents.' },
    },
    required: ['id', 'name', 'url', 'size', 'type', 'key'],
  }

  if (param.type === 'file') {
    return fileObjectSchema
  }

  return {
    type: 'array',
    description: `${baseDescription} ${resolutionDescription}`,
    items: {
      type: 'object',
      description: 'A file object.',
      properties: fileObjectSchema.properties,
    },
  }
}

export function createUserToolSchema(
  toolConfig: ToolConfig,