Skip to main content
Glama

List survey participants

limesurvey_list_participants
Read-onlyIdempotent

List and filter survey participants with server-side pagination.

Instructions

List and filter survey participants with server-side pagination.

Calls LimeSurvey RemoteControl method list_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_list_participants"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum participants to return.
startNoLower bound for the participant row ID (tid): LimeSurvey returns rows with tid >= start, ordered by tid. It is not a row offset; page with the last tid + 1.
unusedNoReturn only unused participants.
survey_idYesNumeric LimeSurvey survey ID.
attributesNoFields to return, or false for defaults.
conditionsNoParticipant filter conditions as an object or positional condition list.
response_formatNoOutput format. JSON preserves the complete structured result; Markdown is optimized for reading.json

Output Schema

NameRequiredDescriptionDefault
methodYes
resultYes
warningsNo
truncatedNo
truncation_messageNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.6.0
    • changedInput schema / properties / start / description
      Previous value: -"Zero-based result offset."New value: +"Lower bound for the participant row ID (tid): LimeSurvey returns rows with tid >= start, ordered by tid. It is not a row offset; page with the last tid + 1."
    • addedOutput schema / properties / warnings
      Added value: +{
      +  "items": {
      +    "$ref": "#/definitions/__schema0"
      +  },
      +  "type": "array"
      +}
  2. First observedv1.3.1

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already cover the read-only/idempotent/non-destructive profile, but the description adds genuinely new behavior: server-side pagination, that auth uses the configured service account, and that no session key should be supplied. It also identifies the underlying RemoteControl method, which helps agents reason about semantics. It stops short of any guidance on volume, rate limits, or partial-result behavior.

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?

Two short sentences, zero filler, with the action and scope front-loaded ahead of the implementation and auth notes. Every sentence carries distinct information.

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

Completeness4/5

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

For a 7-parameter list tool with full schema coverage and an output schema (so return values need not be explained), the description covers the essentials: pagination model, auth expectation, and backing API. The one meaningful omission is disambiguation from limesurvey_list_filtered_participants.

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

Parameters3/5

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

Schema description coverage is 100% and the schema itself carefully documents the non-obvious `start` tid semantics, `conditions` shapes, and `response_format`. The description adds no parameter-level meaning beyond that, so the baseline 3 applies.

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?

Names a specific verb and resource (list/filter survey participants) and adds the pagination scope, which is clear on its own. However, it does not differentiate itself from the very similarly named sibling limesurvey_list_filtered_participants, leaving an agent unable to tell the two apart from the description alone.

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?

There is no when-to-use guidance and no mention of alternatives, despite siblings like limesurvey_list_filtered_participants, limesurvey_get_participant_properties and limesurvey_get_participant_table_status that overlap in purpose. The only invocation guidance is the auth note (no session key), which does not help selection.

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

Deploy Server

Other Tools