Built LMS Help Center
MCP ServerTool Reference

List Groups

List Groups MCP tool.

List Groups

List user groups with manager_id and member_count (counts archived members too). search matches name or description.

Contract

FieldValue
Tool namelist_groups
Domaingroups
Required scopespeople:read
TitleList groups
Read only hinttrue
Destructive hintfalse
Idempotent hintfalse
Open world hintfalse
Bulk limitnone
Timeout10000ms
Kill switch keygroups.list
REST siblingGET /api/public/v1/groups

Input Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "cursor": {
      "type": "string",
      "pattern": "^mcp_[a-z0-9]+$"
    },
    "search": {
      "type": "string",
      "minLength": 1
    },
    "sort_by": {
      "type": "string",
      "enum": [
        "created_at",
        "name",
        "member_count"
      ]
    },
    "sort_order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "additionalProperties": false
}

Output Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "content": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "const": "text"
          },
          "text": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "text"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "content"
  ],
  "additionalProperties": false
}

On this page