Skip to main content
Glama
edgarrmondragon

LimeSurvey MCP Server

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
NameRequiredDescriptionDefault
sidYes
tokensNo

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)
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden for behavioral disclosure. It states the action 'invite' but doesn't clarify whether this sends emails, requires survey activation, has rate limits, or what happens on failure. For a mutation tool with zero annotation coverage, this leaves significant behavioral aspects undocumented.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is perfectly structured with a clear purpose statement followed by parameter explanations. Every sentence earns its place, with no redundant information. The two-sentence format is front-loaded and efficiently communicates essential information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations, no output schema, and multiple sibling tools, the description is incomplete. It doesn't address prerequisites (e.g., survey must be active), side effects, error conditions, or return values. The parameter explanations help but don't compensate for the missing behavioral context needed for reliable tool use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description compensates well by explaining both parameters: 'sid' as survey ID and 'tokens' as participant tokens with the clarification that 'None' means invite all participants. This adds meaningful context beyond the bare schema types, though it doesn't specify token format or survey ID validation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'invite' and resource 'participants to a LimeSurvey survey', making the purpose immediately understandable. It distinguishes itself from siblings like 'add_participants' by focusing on invitation rather than creation. However, it doesn't explicitly contrast with other invitation-related tools that might exist in the broader context.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'add_participants' or 'set_participant_properties'. It mentions that tokens can be 'None' to invite all participants, which is a usage detail but doesn't address broader context or prerequisites for successful invocation.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/edgarrmondragon/limesurvey-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server