whoop-get-sleep-collection
Retrieve paginated sleep records from WHOOP with date filtering options to analyze sleep patterns and duration data.
Instructions
Get all sleep records for a user, paginated
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Limit on the number of sleep records returned (max 25) | |
| start | No | Return sleep records that occurred after or during this time (ISO 8601) | |
| end | No | Return sleep records that intersect this time or ended before this time (ISO 8601) | |
| nextToken | No | Next token from the previous response to get the next page |
Implementation Reference
- src/whoop-api.ts:107-118 (handler)Core handler function in WhoopApiClient that fetches the paginated sleep collection from the Whoop API endpoint '/activity/sleep' using axios with query parameters.async getSleepCollection(params?: PaginationParams): Promise<WhoopSleepCollection> { const queryParams = new URLSearchParams(); if (params?.limit) queryParams.append('limit', params.limit.toString()); if (params?.start) queryParams.append('start', params.start); if (params?.end) queryParams.append('end', params.end); if (params?.nextToken) queryParams.append('nextToken', params.nextToken); const url = `/activity/sleep${queryParams.toString() ? `?${queryParams.toString()}` : ''}`; const response = await this.client.get(url); return response.data; }
- src/mcp-server.ts:172-196 (registration)Tool registration in the ListTools handler, defining name, description, and input schema for 'whoop-get-sleep-collection'.{ name: 'whoop-get-sleep-collection', description: 'Get all sleep records for a user, paginated', inputSchema: { type: 'object', properties: { limit: { type: 'number', description: 'Limit on the number of sleep records returned (max 25)', }, start: { type: 'string', description: 'Return sleep records that occurred after or during this time (ISO 8601)', }, end: { type: 'string', description: 'Return sleep records that intersect this time or ended before this time (ISO 8601)', }, nextToken: { type: 'string', description: 'Next token from the previous response to get the next page', }, }, required: [], },
- src/mcp-server.ts:434-448 (handler)MCP server CallToolRequest handler case that validates arguments and delegates to WhoopApiClient.getSleepCollection, returning JSON stringified result.case 'whoop-get-sleep-collection': { const result = await this.whoopClient.getSleepCollection({ limit: args?.limit as number | undefined, start: args?.start as string | undefined, end: args?.end as string | undefined, nextToken: args?.nextToken as string | undefined, }); return { content: [ { type: 'text', text: JSON.stringify(result, null, 2), }, ], };