codemap_group_list

List all code groups with pagination. If name provided, shows detailed view with members and notations.

groupslistview

Parameters

Name	Type	Required	Description
`name`	`string`	❌ Optional	Optional: specific group name for detailed view
`includeMembers`	`boolean`	❌ Optional	Include member details (default: false)
`includeNotations`	`boolean`	❌ Optional	Include notation details (default: false)
`page`	`number`	❌ Optional	Page number for pagination (default: 1)
`pageSize`	`number`	❌ Optional	Results per page (default: 20, max: 100)

Usage Examples

MCP Usage (for AI Agents like Claude)

json

{
  "name": "codemap_group_list",
  "arguments": {}
}

Example Output

JSON Response

json

{
  "success": true,
  "groups": [
    {
      "name": "auth-system",
      "description": "Authentication and authorization module",
      "memberCount": 5,
      "notationCount": 3
    },
    {
      "name": "payment-gateway",
      "description": "Stripe and PayPal integration for payment processing",
      "memberCount": 8,
      "notationCount": 2
    },
    {
      "name": "api-layer",
      "description": "REST API routes and controllers",
      "memberCount": 12,
      "notationCount": 5
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "totalGroups": 3,
    "totalPages": 1,
    "hasMore": false
  }
}

ℹ️When to Use This Tool

codemap_group_list

Get an overview of all code groups in the project
Review group organization and structure
Find groups by viewing summaries before detailed search
Check group counts (members, notations) across the project
Discover existing groups before creating new ones
Audit group organization during code reviews

💡Common Patterns

Quick Overview Workflow

Get high-level view of all groups:
1. Call codemap_group_list()
2. Review group names and descriptions
3. Note member/notation counts
4. Identify groups for detailed inspection

Detailed Group Inspection

View specific group with all details:
1. codemap_group_list({ name: "auth-system" })
2. Review full member list and notations
3. Understand group composition and history

Pagination for Large Projects

Navigate through many groups:
1. Page 1: codemap_group_list({ page: 1, pageSize: 10 })
2. Page 2: codemap_group_list({ page: 2, pageSize: 10 })
3. Continue until hasMore: false

💡Pro Tips

Default pageSize is 20: Good balance between overview and performance
Max pageSize is 100: Use for comprehensive single-page view
includeMembers/includeNotations optional: Set to true when you need full details in list view
Specific name bypasses pagination: When name is provided, returns detailed single-group view
Check totalGroups in response: Indicates scale of group organization in project

✅Best Practices

Start with list overview to understand project organization
Use pagination for projects with many groups (>20)
Enable includeMembers only when needed - keeps response sizes manageable
Review group counts regularly to ensure groups stay focused (5-15 members ideal)
Use list to discover naming patterns and conventions
Combine list with search for two-step group discovery

⚠️Common Mistakes

❌ Mistake: Requesting huge pageSize for all groups

codemap_group_list({ pageSize: 1000 })  // Massive response

✅ Instead: Use reasonable page sizes

codemap_group_list({ pageSize: 20 })  // Default, good for most cases
codemap_group_list({ pageSize: 50 })  // If you need more per page

---

❌ Mistake: Always including members and notations

codemap_group_list({ includeMembers: true, includeNotations: true })
// Large response with data you may not need

✅ Instead: Include details only when needed

// List view: summaries only
codemap_group_list()

// When you need details, use specific name
codemap_group_list({ 
  name: "auth-system",
  includeMembers: true,
  includeNotations: true 
})

---

❌ Mistake: Not checking hasMore flag

const result = codemap_group_list({ page: 1 });
// Assumes all groups are on page 1

✅ Instead: Check pagination status

const result = codemap_group_list({ page: 1 });
if (result.pagination.hasMore) {
  console.log(More groups on pages 2-${result.pagination.totalPages});
}

---

❌ Mistake: Using list when search would be better

// Get all groups then filter client-side
const all = codemap_group_list({ pageSize: 100 });
const authGroups = all.groups.filter(g => g.name.includes('auth'));

✅ Instead: Use search for filtering

// Let server filter
codemap_group_search({ name: "auth" })

---

❌ Mistake: Confusing name parameter behavior

// Thinking this lists groups matching "api"
codemap_group_list({ name: "api" })

✅ Instead: Understand name shows one specific group

// This shows detailed view of group named exactly "api"
codemap_group_list({ name: "api" })

// To find groups matching "api", use search instead
codemap_group_search({ name: "api" })