Skip to main content
Glama

Get group properties

limesurvey_get_group_properties
Read-onlyIdempotent

Read selected question-group properties. LimeSurvey identifies the group by group_id alone, so a wrong ID reads another survey's group.

Instructions

Read selected question-group properties. LimeSurvey identifies the group by group_id alone, so a wrong ID reads another survey's group. Pass the optional survey_id to cross-check: the result's sid must match, otherwise the call fails with GROUP_SURVEY_MISMATCH (survey_id is never sent to LimeSurvey).

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

Input Schema

NameRequiredDescriptionDefault
group_idYesNumeric question-group ID.
languageNoLimeSurvey language code; null uses the survey default.
survey_idNoOptional survey ID the group is expected to belong to. MCP-only: it is never sent to LimeSurvey; the server compares it with the sid of the result (reading sid with one extra request when the result has none) and fails with a *_SURVEY_MISMATCH error when they differ.
propertiesNoProperties to return for the question group; 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. Changed2 schema fields changedv1.6.0
    • addedInput schema / properties / survey_id
      Added value: +{
      +  "description": "Optional survey ID the group is expected to belong to. MCP-only: it is never sent to LimeSurvey; the server compares it with the sid of the result (reading sid with one extra request when the result has none) and fails with a *_SURVEY_MISMATCH error when they differ.",
      +  "exclusiveMinimum": 0,
      +  "maximum": 9007199254740991,
      +  "type": "integer"
      +}
    • 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?

Beyond the readOnly/idempotent/non-destructive annotations, the description discloses the failure mode (GROUP_SURVEY_MISMATCH), that survey_id is never transmitted to LimeSurvey, that verifying sid may trigger one extra request, and that auth uses a configured service account with no session key. That is substantial behavior an agent could not infer.

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?

Front-loaded with the core action, then the ID/survey_id caveat, then auth. Dense but well organized; the nested parenthetical about reading sid adds length that could be trimmed, though each clause carries information.

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, return values need no explanation. The description covers the read semantics, the ID ambiguity, the survey_id safeguard, the error contract, and authentication — everything needed to call it 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 coverage is 100%, so baseline is 3, but the description adds meaning beyond the schema: the cross-check purpose of survey_id, its MCP-only nature, the resulting error name, and the extra-request cost. group_id's ambiguity risk is also stated in prose.

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?

States a specific verb ('Read') and resource ('question-group properties'), clearly distinct from get_question_properties, set_group_properties, and list_groups in the sibling set. An agent can identify the right tool without opening the schema.

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?

Gives clear contextual guidance: it explains that LimeSurvey resolves the group by group_id alone and that passing survey_id cross-checks ownership. It does not explicitly name alternative tools (e.g. get_question_properties) or when not to use this tool, but the selection context is clear.

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