getEvents
Retrieve events from a specific Spline 3D scene by providing the scene ID to access animation triggers and interactive elements.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sceneId | Yes | Scene ID |
Implementation Reference
- src/tools/state-event-tools.js:154-183 (handler)MCP tool handler for 'getEvents': registers the tool, validates input with Zod schema (sceneId), fetches events using apiClient.getEvents(sceneId), returns JSON stringified events or error message.
// Get all events in a scene server.tool( 'getEvents', { sceneId: z.string().min(1).describe('Scene ID'), }, async ({ sceneId }) => { try { const events = await apiClient.getEvents(sceneId); return { content: [ { type: 'text', text: JSON.stringify(events, null, 2) } ] }; } catch (error) { return { content: [ { type: 'text', text: `Error retrieving events: ${error.message}` } ], isError: true }; } } ); - src/index.js:90-90 (registration)Top-level registration of state event tools (including getEvents) by calling registerStateEventTools(server).
registerStateEventTools(server); - src/utils/api-client.js:177-184 (helper)Helper method apiClient.getEvents(sceneId) that performs a GET request to the Spline API endpoint `/scenes/${sceneId}/events` to retrieve all events in the scene.
/** * List events in a scene * @param {string} sceneId - ID of the scene * @returns {Promise<Array>} - List of events */ async getEvents(sceneId) { return this.request('GET', `/scenes/${sceneId}/events`); }