Skip to main content
Glama

Export responses by token

limesurvey_export_responses_by_token
Read-onlyIdempotent

Export responses for selected participant tokens as a base64-encoded document.

Instructions

Export responses for selected participant tokens as a base64-encoded document.

Calls LimeSurvey RemoteControl method export_responses_by_token. Authentication uses the configured service account; do not provide a session key.

Input Schema

NameRequiredDescriptionDefault
fieldsNoOptional response fields to export.
tokensYesOne participant token or a list of tokens to export.
survey_idYesNumeric LimeSurvey survey ID.
heading_typeNoColumn heading style.
document_typeYesExport type such as csv, html, pdf, xls, or json.
language_codeNoLimeSurvey language code; null uses the survey default.
response_typeNoAnswer text format.
response_formatNoOutput format. JSON preserves the complete structured result; Markdown is optimized for reading.json
completion_statusNoCompletion filter.

Output Schema

NameRequiredDescriptionDefault
methodYes
resultYes
warningsNo
truncatedNo
truncation_messageNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.6.0
    • addedOutput schema / properties / warnings
      Added value: +{
      +  "items": {
      +    "$ref": "#/definitions/__schema0"
      +  },
      +  "type": "array"
      +}
  2. First observedv1.3.1

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the burden is lower. The description adds real value beyond them: the result is a base64-encoded document, and authentication uses the configured service account with no session key required. It does not, however, note size or rate limits.

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

Conciseness4/5

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

Two short sentences, front-loaded with the purpose and followed by the auth constraint. Efficient with no filler, though the second sentence is slightly process-oriented rather than strictly necessary.

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?

With an output schema present, return-value explanation is not needed, and the auth note plus encoding note cover the key invocation concerns. Only the relationship to the _to_file and unfiltered siblings is left implicit.

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 all nine parameters, including enum options, are documented in the schema itself. The description adds no parameter-level meaning, so the baseline of 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?

States a specific verb (Export), resource (responses), and a scope qualifier (by participant token), plus the output encoding (base64-encoded document). This clearly differentiates it from the unfiltered limesurvey_export_responses, though it does not explicitly name the sibling it differs from.

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

Usage Guidelines3/5

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

It gives one actionable constraint ('do not provide a session key'), which is useful invocation guidance, but it never states when to choose this over limesurvey_export_responses or the sibling limesurvey_export_responses_by_token_to_file. Usage is implied by the 'by token' scoping rather than explained.

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