Skip to main content
Glama

Get survey properties

limesurvey_get_survey_properties
Read-onlyIdempotent

Read selected survey properties (any column of the surveys table; unknown names are dropped silently). usetokens is only a stored column in LimeSurvey 6.17.11: the core never evaluates it, so it neither tells whether a participant table…

Instructions

Read selected survey properties (any column of the surveys table; unknown names are dropped silently). usetokens is only a stored column in LimeSurvey 6.17.11: the core never evaluates it, so it neither tells whether a participant table exists nor whether the survey is closed. Closed access follows access_mode ("C" closed, "O" open) and the participant table; use limesurvey_get_participant_table_status for a ready-made answer. Verified against the LimeSurvey 6.17.11 source; older releases may differ.

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

Input Schema

NameRequiredDescriptionDefault
survey_idYesNumeric LimeSurvey survey ID.
propertiesNoProperties to return for the survey; null returns all available properties.
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. Changed1 schema field changedv1.6.0
    • addedOutput schema / properties / warnings
      Added value: +{
      +  "items": {
      +    "$ref": "#/definitions/__schema0"
      +  },
      +  "type": "array"
      +}
  2. First observedv1.3.1

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already establish the safe read profile (readOnly, idempotent, non-destructive), and the description adds substantial context beyond them: unknown property names are silently dropped, `usetokens` is a stored-only column the core never evaluates, closed access actually follows `access_mode` ('C'/'O') plus the participant table, and auth uses the configured service account with no session key. The version-verification note ('Verified against LimeSurvey 6.17.11 source; older releases may differ') is also honest about applicability.

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?

The read purpose is front-loaded in the first clause, and the caveat/alternative routing follows. The `usetokens`/`access_mode` passage is dense and longer than a general reader strictly needs, but each sentence carries actionable information rather than filler.

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

Completeness5/5

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

With an output schema present the return shape need not be described, and annotations cover the safety profile. The description nonetheless supplies auth behavior, silent-drop semantics, version caveats, and a pointer to the right alternative, leaving nothing an agent needs in order to invoke the tool correctly.

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?

Schema description coverage is 100%, so the baseline is 3, but the description adds real meaning the schema lacks: the `properties` values are columns of the surveys table and unrecognized names are discarded silently rather than erroring. That changes how an agent should construct the argument, exceeding the schema's generic 'Properties to return for the survey'.

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

Purpose5/5

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

The description states a specific verb and resource ('Read selected survey properties') and pins down the scope ('any column of the surveys table'), which cleanly separates it from the sibling setter limesurvey_set_survey_properties and the property readers for other entities (questions, groups, quotas). It also flags the exact RemoteControl method it wraps, so an agent knows precisely what is being called.

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

Usage Guidelines4/5

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

It routes the agent away from a tempting misuse (reading `usetokens` to infer participant-table existence or closure) and names the correct alternative, limesurvey_get_participant_table_status, with the condition that selects it. It does not, however, give broader when-to-use guidance versus siblings such as limesurvey_get_survey_spec or limesurvey_list_surveys.

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