invite_participants
Send survey invitations to participants in LimeSurvey. Specify survey ID and participant tokens to distribute invitations for data collection.
Instructions
Invite participants to a LimeSurvey survey.
Args:
sid: The survey ID.
tokens: The participant tokens. If None, invite all participants.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sid | Yes | ||
| tokens | No |
Implementation Reference
- main.py:584-593 (handler)The main handler function for the 'invite_participants' tool. It is decorated with @mcp.tool(), which registers the tool in the FastMCP framework. The function invites specified or all participants to the survey by delegating to the LimeSurvey client's invite_participants method.@mcp.tool() def invite_participants(sid: int, tokens: list[str] = None) -> dict[str, Any]: """Invite participants to a LimeSurvey survey. Args: sid: The survey ID. tokens: The participant tokens. If None, invite all participants. """ with get_client() as client: return client.invite_participants(sid, tokens)