createComprehensiveEvent

Implementation Reference

• src/tools/complete-event-tools.js:44-76 (handler)

  The handler function that implements the core logic of the createComprehensiveEvent tool. It constructs the event data object from the provided parameters and uses the apiClient to POST it to the `/scenes/{sceneId}/events` endpoint, returning a success message with the new event ID or an error message.

    async ({ sceneId, name, type, objectId, parameters, actions }) => {
      try {
        const eventData = {
          name,
          type,
          ...(objectId && { objectId }),
          ...(parameters && { parameters }),
          actions,
        };
        
        const result = await apiClient.request('POST', `/scenes/${sceneId}/events`, eventData);
        
        return {
          content: [
            { 
              type: 'text', 
              text: `Event "${name}" created successfully with ID: ${result.id}` 
            }
          ]
        };
      } catch (error) {
        return {
          content: [
            { 
              type: 'text', 
              text: `Error creating event: ${error.message}` 
            }
          ],
          isError: true
        };
      }
    }
  );

• src/tools/complete-event-tools.js:13-43 (schema)

  Zod validation schema defining the input structure for the createComprehensiveEvent tool, including required sceneId, name, type (comprehensive enum of all supported Spline event types), optional objectId and parameters, and required actions array.

  {
    sceneId: z.string().min(1).describe('Scene ID'),
    name: z.string().min(1).describe('Event name'),
    type: z.enum([
      // Mouse events
      'mouseUp', 'mouseDown', 'mousePress', 'mouseHover', 
      // Keyboard events
      'keyUp', 'keyDown', 'keyPress',
      // Scroll and movement events
      'scroll', 'lookAt', 'follow',
      // Game control events
      'gameControls',
      // Physics and spatial events
      'distance', 'collision', 'triggerArea',
      // UI and state events
      'stateChange', 'variableChange', 'screenResize',
      // External integration events
      'apiUpdated', 'webhookCalled',
      // AI assistant events
      'aiAssistantListener', 'aiAssistantTrigger',
      // Scene events
      'sceneStart', 'sceneLoad', 'sceneUnload'
    ]).describe('Event type'),
    objectId: z.string().optional().describe('Object ID (if object-specific event)'),
    parameters: z.record(z.any()).optional().describe('Event specific parameters (e.g., key codes, trigger distances)'),
    actions: z.array(z.object({
      type: z.string().describe('Action type'),
      target: z.string().optional().describe('Target ID (object, state, etc.)'),
      params: z.record(z.any()).optional().describe('Action parameters'),
    })).min(1).describe('Actions to perform when event is triggered'),
  },

• src/tools/complete-event-tools.js:11-76 (registration)

  The server.tool call that registers the createComprehensiveEvent tool with the MCP server, providing the tool name, input schema, and handler function.

  server.tool(
    'createComprehensiveEvent',
    {
      sceneId: z.string().min(1).describe('Scene ID'),
      name: z.string().min(1).describe('Event name'),
      type: z.enum([
        // Mouse events
        'mouseUp', 'mouseDown', 'mousePress', 'mouseHover', 
        // Keyboard events
        'keyUp', 'keyDown', 'keyPress',
        // Scroll and movement events
        'scroll', 'lookAt', 'follow',
        // Game control events
        'gameControls',
        // Physics and spatial events
        'distance', 'collision', 'triggerArea',
        // UI and state events
        'stateChange', 'variableChange', 'screenResize',
        // External integration events
        'apiUpdated', 'webhookCalled',
        // AI assistant events
        'aiAssistantListener', 'aiAssistantTrigger',
        // Scene events
        'sceneStart', 'sceneLoad', 'sceneUnload'
      ]).describe('Event type'),
      objectId: z.string().optional().describe('Object ID (if object-specific event)'),
      parameters: z.record(z.any()).optional().describe('Event specific parameters (e.g., key codes, trigger distances)'),
      actions: z.array(z.object({
        type: z.string().describe('Action type'),
        target: z.string().optional().describe('Target ID (object, state, etc.)'),
        params: z.record(z.any()).optional().describe('Action parameters'),
      })).min(1).describe('Actions to perform when event is triggered'),
    },
    async ({ sceneId, name, type, objectId, parameters, actions }) => {
      try {
        const eventData = {
          name,
          type,
          ...(objectId && { objectId }),
          ...(parameters && { parameters }),
          actions,
        };
        
        const result = await apiClient.request('POST', `/scenes/${sceneId}/events`, eventData);
        
        return {
          content: [
            { 
              type: 'text', 
              text: `Event "${name}" created successfully with ID: ${result.id}` 
            }
          ]
        };
      } catch (error) {
        return {
          content: [
            { 
              type: 'text', 
              text: `Error creating event: ${error.message}` 
            }
          ],
          isError: true
        };
      }
    }
  );

• src/index.js:96-96 (registration)

  Top-level call in the main server setup that invokes the registration of complete event tools, including createComprehensiveEvent, by calling registerCompleteEventTools(server).

  registerCompleteEventTools(server);

• src/index.js:21-21 (registration)

  Import statement for the complete-event-tools module that defines and registers the createComprehensiveEvent tool.

  import { registerCompleteEventTools } from './tools/complete-event-tools.js';