read_deploy
Read Deploy tab settings: theme, runner structure, personalized links, GitHub Sync status, field mode, recruitment-provider integration (Prolific, CloudResearch, Cint, SONA, YouGov, Rep Data), the saved power-analysis plan, your own notifications for the survey (milestones, quality flags, quota alerts), or workspace theme presets. power_analysis returns the versioned Deploy → Power assumptions, including estimator family, alpha/power/effect, attrition, clustering, multiplicity, Flow comparison cells, simulation seed, and costs. The app's Compiled Design panel is a live, unsaved audit rather than a second configuration object: combine power_analysis with read_question and read_flow to reproduce its checks for outcome scale and requiredness, Flow reach and randomized subsets, assignment, repeated tasks or loops, quotas, quality rules, and linked panel data. Preregistration links and instrument locking are app-only because OSF drafts may require a saved credential and locking uses the app's canonical instrument fingerprint; use Deploy → Preregistration in Domandata.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "read_deploy"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max distribution recipients per batch (default: 100) | |
| token | No | When set, resolves one personalized recipient URL (with that recipient's contact; refused on a connection restricted from participant data in Settings → Integrations) | |
| confirm | No | Required (true) for participant-level data: includes prolific_submissions, prolific_messages, cloudresearch_assignments, cloudresearch_messages, and distribution with batch_id. Confirm with the researcher before reading identifiable participant data. | |
| include | No | Defaults to theme, structure, distribution, github_sync, field_mode, recruitment, my_notifications, and power_analysis when survey_id is set. my_notifications is the signed-in person's own fieldwork notifications for this survey (first response, milestones, quality flags, quota nearly full, quota reached): each event's override, the account-wide defaults it falls back to, and an effective plain-language summary. recruitment returns the connected provider's study link (with the provider's macros), what to set in the provider's dashboard, each outcome's end screen and redirect, a test link, and setup issues — or, when nothing is connected, every provider and its settings. recruitment_activity (not in the defaults) is the linked Prolific study's or Connect project's activity log, newest first (latest 50): each entry's time, kind (approved, rejected, bonus_paid, launched, published, paused, places_added, auto_approved, auto_paused, unscheduled, messaged, blocked, error, …), a plain-language summary, count, amount and currency, and who did it (actor "automatic" for Domandata's background job). Use it to tell the researcher what was paid and what happened automatically. prolific_submissions (not in the defaults: it calls Prolific) lists the linked Prolific study's submissions matched to responses — status, times, timeTakenSeconds, the completion code entered (studyCode), paymentStatus, and when a return was requested (returnRequestedAt) — each with an approve/review recommendation (approving pays participants, so it happens in the app). cloudresearch_project, cloudresearch_assignments, and cloudresearch_targeting (not in the defaults: they call CloudResearch Connect) return the linked Connect project's status, size, cost, progress, account balance, and settings (days_to_auto_approve, max_minutes, instructions, system_requirements, sensitive_content, languages; Connect's auto-pay window is read-only here because it pays participants, so set it in the app); its assignments matched to responses (response_id), each with Pending/Approved/Rejected status, start and finish times, pay, bonus paid, completion code, how they finished (finished_through: CompletionCode, or Redirect, which carries no code), every Connect profile answer the participant shared (connect_profile), and an approve/review recommendation; and what a new project can target: demographic criteria, the account's past projects (same_survey marks this survey's), participant groups, quota_suggestions mirroring the survey's quotas, and suggested_settings (requirements from the survey's questions, its languages Connect supports, a 3× time limit). cloudresearch_messages lists participants of the linked project with unread replies, or — with participant_id — that participant's conversations and messages (reply with edit_deploy recruitment.cloudresearch_message). prolific_study, prolific_targeting, and prolific_messages (not in the defaults: they call Prolific) are the same for Prolific: the linked study's status, places, progress counts, cost, and balance, whether Prolific's events reach Domandata live (live_updates; otherwise it checks every 15 minutes), and when Prolific last reported a high return rate (high_return_rate_at); what a new study can target (screeners, past studies with same_survey, participant groups, quota_suggestions, the pay floor, pay_history: the account's median pay per hour as estimated and as approved participants really took, in minor units, and block_list: the "Domandata block list" group every new study leaves out, with its size); and unread replies or one participant's conversations. | |
| team_id | No | Workspace UUID for workspace_presets (default: personal workspace) | |
| batch_id | No | With include distribution: list this batch's recipients (participant contact data, so confirm is required, and a connection restricted from participant data in Settings → Integrations is refused). | |
| survey_id | No | Survey UUID (required for survey-scoped sections) | |
| participant_id | No | With include cloudresearch_messages or prolific_messages: read this participant's conversations. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |