simstudioai--sim/apps/sim/tools/crowdstrike/get_sensor_details.ts

import type {
  CrowdStrikeGetSensorDetailsParams,
  CrowdStrikeGetSensorDetailsResponse,
} from '@/tools/crowdstrike/types'
import type { ToolConfig } from '@/tools/types'

export const crowdstrikeGetSensorDetailsTool: ToolConfig<
  CrowdStrikeGetSensorDetailsParams,
  CrowdStrikeGetSensorDetailsResponse
> = {
  id: 'crowdstrike_get_sensor_details',
  name: 'CrowdStrike Get Sensor Details',
  description:
    'Get documented CrowdStrike Identity Protection sensor details for one or more device IDs',
  version: '1.0.0',

  params: {
    clientId: {
      type: 'string',
      required: true,
      visibility: 'user-only',
      description: 'CrowdStrike Falcon API client ID',
    },
    clientSecret: {
      type: 'string',
      required: true,
      visibility: 'user-only',
      description: 'CrowdStrike Falcon API client secret',
    },
    cloud: {
      type: 'string',
      required: true,
      visibility: 'user-only',
      description: 'CrowdStrike Falcon cloud region',
    },
    ids: {
      type: 'json',
      required: true,
      visibility: 'user-or-llm',
      description: 'JSON array of CrowdStrike sensor device IDs',
    },
  },

  request: {
    url: '/api/tools/crowdstrike/query',
    method: 'POST',
    headers: () => ({
      'Content-Type': 'application/json',
    }),
    body: (params) => ({
      cloud: params.cloud,
      clientId: params.clientId,
      clientSecret: params.clientSecret,
      ids: params.ids,
      operation: 'crowdstrike_get_sensor_details',
    }),
  },

  transformResponse: async (response) => {
    const data = await response.json()

    if (!response.ok || data.success === false) {
      throw new Error(data.error || 'Failed to fetch CrowdStrike sensor details')
    }

    return {
      success: true,
      output: data.output,
    }
  },

  outputs: {
    sensors: {
      type: 'array',
      description: 'CrowdStrike identity sensor detail records',
      items: {
        type: 'object',
        properties: {
          agentVersion: {
            type: 'string',
            description: 'Sensor agent version',
            optional: true,
          },
          cid: {
            type: 'string',
            description: 'CrowdStrike customer identifier',
          },
          deviceId: {
            type: 'string',
            description: 'Sensor device identifier',
          },
          heartbeatTime: {
            type: 'number',
            description: 'Last heartbeat timestamp',
            optional: true,
          },
          hostname: {
            type: 'string',
            description: 'Sensor hostname',
            optional: true,
          },
          idpPolicyId: {
            type: 'string',
            description: 'Assigned Identity Protection policy ID',
            optional: true,
          },
          idpPolicyName: {
            type: 'string',
            description: 'Assigned Identity Protection policy name',
            optional: true,
          },
          ipAddress: {
            type: 'string',
            description: 'Sensor local IP address',
            optional: true,
          },
          kerberosConfig: {
            type: 'string',
            description: 'Kerberos configuration status',
            optional: true,
          },
          ldapConfig: {
            type: 'string',
            description: 'LDAP configuration status',
            optional: true,
          },
          ldapsConfig: {
            type: 'string',
            description: 'LDAPS configuration status',
            optional: true,
          },
          machineDomain: {
            type: 'string',
            description: 'Machine domain',
            optional: true,
          },
          ntlmConfig: {
            type: 'string',
            description: 'NTLM configuration status',
            optional: true,
          },
          osVersion: {
            type: 'string',
            description: 'Operating system version',
            optional: true,
          },
          rdpToDcConfig: {
            type: 'string',
            description: 'RDP to domain controller configuration status',
            optional: true,
          },
          smbToDcConfig: {
            type: 'string',
            description: 'SMB to domain controller configuration status',
            optional: true,
          },
          status: {
            type: 'string',
            description: 'Sensor protection status',
            optional: true,
          },
          statusCauses: {
            type: 'array',
            description: 'Documented causes behind the current status',
            optional: true,
            items: {
              type: 'string',
            },
          },
          tiEnabled: {
            type: 'string',
            description: 'Threat intelligence enablement status',
            optional: true,
          },
        },
      },
    },
    count: {
      type: 'number',
      description: 'Number of sensors returned',
    },
    pagination: {
      type: 'json',
      description: 'Pagination metadata when returned by the underlying API',
      optional: true,
      properties: {
        limit: { type: 'number', description: 'Page size used for the query', optional: true },
        offset: { type: 'number', description: 'Offset returned by CrowdStrike', optional: true },
        total: { type: 'number', description: 'Total records available', optional: true },
      },
    },
  },
}