set_group_properties
Configure group settings in LimeSurvey by updating properties like visibility, permissions, or display options for survey question groups.
Instructions
Set LimeSurvey group properties.
Args:
gid: The group ID.
properties: The properties to set.Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| gid | Yes | ||
| properties | Yes |
Implementation Reference
- main.py:461-471 (handler)The core handler function for the 'set_group_properties' MCP tool. It is decorated with @mcp.tool() which serves as its registration in the FastMCP framework. The function uses type hints and docstring to define input/output schema implicitly, and delegates to the LimeSurvey client library.
@mcp.tool() def set_group_properties(gid: int, properties: dict[str, Any]) -> bool: """Set LimeSurvey group properties. Args: gid: The group ID. properties: The properties to set. """ with get_client() as client: return client.set_group_properties(gid, properties) - main.py:15-21 (helper)Helper function used by the tool to create an authenticated LimeSurvey Client instance from environment variables.
def get_client() -> Client: return Client( url=os.getenv("LIMESURVEY_URL"), username=os.getenv("LIMESURVEY_USERNAME"), password=os.getenv("LIMESURVEY_PASSWORD"), ) - main.py:461-461 (registration)The @mcp.tool() decorator registers the set_group_properties function as an MCP tool.
@mcp.tool()