Cursor rule

1---
2description: Description: Steps to add or update parameters passed into a function
3globs: 
4alwaysApply: false
5---
6 
7Always follow these steps in order:
8 
91. Parameter Schema Update:
10   - Locate the parameters file (usually `typescript/src/shared/(namespace)/parameters.ts`)
11   - Add new parameters to the Zod schema
12   - For each parameter:
13     - Define the correct type (e.g., z.number(), z.array(z.string()))
14     - Add appropriate validations (e.g., .min(), .max())
15     - Mark as .optional() if not required
16     - Add .describe() with clear documentation
17     - Include examples in the description for complex types
18 
192. Function Implementation Update:
20   - Locate the function file (usually `typescript/src/shared/(namespace)/functions.ts`)
21   - Add new parameters to the queryArgs object
22   - Use spread operator with null checks for optional params
23   - Format: `...(params.newParam && {newParam: params.newParam})`
24   - Remove any outdated comments
25 
263. Documentation Update:
27   - Locate the prompts file (usually named `typescript/src/shared/(namespace)/prompts.ts`)
28   - Update the function's prompt string
29   - For each parameter add:
30     - Parameter name
31     - Type information
32     - Optional/required status
33     - Default value if any
34     - Valid range if applicable
35     - Example usage for complex types
36 
374. Test Coverage Update:
38   - Locate the test file (usually `typescript/src/shared/(namespace)/test/functions.test.ts`)
39   - Add/update test cases:
40     - Test with default parameters
41     - Test with all new parameters
42     - Test error scenarios
43   - Verify all parameters are correctly passed to the API
44   - Ensure proper mock setup and assertions
45 
465. Verification:
47   - Ensure all files are consistent with each other
48   - Parameter types match between schema and tests
49   - Examples in prompts match test cases
50   - All optional parameters handle undefined cases
51   - Error handling is properly tested
52 
53Example:
54When adding 'offset' parameter:
551. In parameters.ts:
56```typescript
57   offset: z
58     .number()
59     .int()
60     .min(0)
61     .optional()
62     .describe('The number of items to skip before starting to collect the result set.')
63```
64 
652. In functions.ts:
66```typescript
67   queryArgs: {
68     ...(params.offset && {offset: params.offset}),
69   }
70```
71 
723. In prompts.ts:
73```typescript
74   - offset (int, optional): The number of items to skip before starting to collect the result set.
75```
76 
774. In functions.test.ts:
78```typescript
79   it('should list products with all query parameters', async () => {
80     const params = {
81       offset: 40,
82       // other params...
83     };
84     // test implementation
85   });
86```
87