Function createUserToolSchema

apps/sim/tools/params.ts:503–539

(
  toolConfig: ToolConfig,
  options: UserToolSchemaOptions = {}
)

}

export function createUserToolSchema(
  toolConfig: ToolConfig,
  options: UserToolSchemaOptions = {}
): ToolSchema {
  const surface = options.surface ?? 'default'
  const schema: ToolSchema = {
    type: 'object',
    properties: {},
    required: [],
  }

  for (const [paramId, param] of Object.entries(toolConfig.params)) {
    if (!param) continue
    const visibility = param.visibility ?? 'user-or-llm'
    if (visibility === 'hidden') {
      continue
    }

    const propertySchema = buildParameterSchema(toolConfig.id, paramId, param, options)
    schema.properties[paramId] = propertySchema

    if (param.required) {
      schema.required.push(paramId)
    }
  }

  if (toolConfig.oauth?.required && surface === 'copilot') {
    schema.properties.credentialId = {
      type: 'string',
      description:
        'Credential ID to use for this OAuth tool call. Required for Copilot/Superagent execution. Get valid IDs from environment/credentials.json.',
    }
    schema.required.push('credentialId')
  }

  return schema
}

export async function createLLMToolSchema(
  toolConfig: ToolConfig,