Invite survey participants
limesurvey_invite_participantsSend survey invitation emails to selected or eligible participants. Preview first with dry_run=true: it sends nothing and never calls invite_participants, it simulates the selection from the participant list and reports would_receive and…
Instructions
Send survey invitation emails to selected or eligible participants. Preview first with dry_run=true: it sends nothing and never calls invite_participants, it simulates the selection from the participant list and reports would_receive and would_not_receive with a reason for every participant who is skipped (completed, already_invited, emailstatus_not_ok, invalid_email_address, not_valid_yet, expired, ...). Without continue_on_error LimeSurvey stops at the first participant whose validity window fails; the preview names that participant as stops_at_tid. The report stays within LIMESURVEY_MAX_RESPONSE_CHARS regardless of the table size: unselected participants (token_ids) are only counted as not_selected, and would_receive, would_not_receive and not_reached list at most 100 entries each (truncated_lists says which were cut, counts hold the full numbers). send_email=false is NOT a dry run: it resends the invitation to those who were already invited. Verified against the LimeSurvey 6.17.11 source; older releases may differ. Requires confirm_send_email=true unless dry_run=true.
Calls LimeSurvey RemoteControl method invite_participants. Authentication uses the configured service account; do not provide a session key.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"survey_id": "<survey_id>"
},
"name": "limesurvey_invite_participants"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | MCP-only, never sent to LimeSurvey. true: send nothing and do not call invite_participants; read the participants (list_participants) and report who would receive an invitation and why the others would not. Allowed under every write scope; confirm_send_email is not needed. | |
| survey_id | Yes | Numeric LimeSurvey survey ID. | |
| token_ids | No | Optional participant row IDs; null (or an empty list) selects eligible participants. | |
| send_email | No | Which participants get an email. true (default): invite only participants who were not invited yet (sent = N or empty). false: resend the invitation ONLY to participants who are already invited (sent holds a date) - it does not turn the sending off. Emails are sent in both cases. To see who would be mailed without sending, use dry_run=true. | |
| response_format | No | Output format. JSON preserves the complete structured result; Markdown is optimized for reading. | json |
| continue_on_error | No | Continue after a participant whose validity window (validfrom/validuntil) fails; by default LimeSurvey stops at the first one. | |
| confirm_send_email | No | Required acknowledgement that email may be sent to participants; not needed with dry_run=true. | |
| server_utc_offset_minutes | No | MCP-only, never sent to LimeSurvey. UTC offset of the LimeSurvey server's local time in minutes (for example 120 for UTC+2). validfrom and validuntil are stored without a zone in that local time; without this value the timezone of the MCP host is assumed (reported as time_basis.offset_source). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| method | Yes | ||
| result | Yes | ||
| warnings | No | ||
| truncated | No | ||
| truncation_message | No |