update_study
Modify an existing user interview study by adjusting participant slots, updating visual media, or revising the interview guide to refine research parameters.
Instructions
Updates an existing study. Use this to increase interview slots, add/update media, or modify the interview guide.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| study_id | Yes | ||
| target_interviews | No | Total number of interview slots for this study. | |
| is_link_disabled | No | ||
| study_media | No | Visual stimulus shown during all interview questions (web participants only) |
Implementation Reference
- src/index.ts:149-159 (handler)The handler function for 'update_study' which updates the study via a PATCH request to the API.
async (input) => { const { study_id, ...body } = input; const payload = await callUsercallApi( `/api/v1/agent/studies/${study_id}`, { method: "PATCH", body: JSON.stringify(body), }, ); return result(payload); }, - src/index.ts:121-148 (schema)Input schema definition for the 'update_study' tool.
{ study_id: z.string().uuid(), target_interviews: z .number() .int() .positive() .optional() .describe("Total number of interview slots for this study."), is_link_disabled: z.boolean().optional(), study_media: z .object({ type: z .enum(["image", "prototype"]) .describe( "Media type: 'image' for direct image URLs (.png, .jpg, .gif, .webp) or 'prototype' for Figma prototype URLs", ), url: z.string().url().describe("Public URL to the image or Figma prototype"), description: z .string() .max(500) .optional() .describe("Alt text / context shown to participants"), }) .optional() .describe( "Visual stimulus shown during all interview questions (web participants only)", ), }, - src/index.ts:118-120 (registration)Tool registration for 'update_study'.
server.tool( "update_study", "Updates an existing study. Use this to increase interview slots, add/update media, or modify the interview guide.",