xmtplabs/xmtp-agent-examples/managing-groups

XMTP groups

Manage group conversations, permissions, and members.

When to apply

Reference these guidelines when:

• Creating new group conversations
• Managing group members (add/remove)
• Setting group permissions
• Sending welcome messages
• Gating group access

Rule categories by priority

Quick reference

Create (CRITICAL)

• create-group - Create new group conversations
• create-dm - Create direct messages

Members (HIGH)

• members-add - Add members to groups
• members-remove - Remove members from groups
• members-get-address - Get member Ethereum addresses

Permissions (HIGH)

• permissions-roles - Understand member, admin, super admin roles
• permissions-custom - Set custom permission policies

Welcome (MEDIUM)

• welcome-on-install - Send welcome on agent installation
• welcome-new-members - Welcome new group members

Quick start

// Create a group
const group = await agent.createGroupWithAddresses(addresses, {
  groupName: "My Group",
  groupDescription: "A cool group",
});
// Welcome on new conversations
agent.on("group", async (ctx) => {
  await ctx.conversation.sendText("Hello group!");
});
agent.on("dm", async (ctx) => {
  await ctx.conversation.sendText("Hello! How can I help?");
});

How to use

Read individual rule files for detailed explanations:

rules/create-group.md
rules/members-add.md
rules/permissions-roles.md
rules/welcome-on-install.md