Skip to content

Commit fab4781

Browse files
Update llms-full.txt (#467)
Co-authored-by: humanagent <humanagent@users.noreply.github.com>
1 parent f65aa8c commit fab4781

File tree

1 file changed

+50
-37
lines changed

1 file changed

+50
-37
lines changed

llms/llms-full.txt

Lines changed: 50 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# XMTP Full Documentation
22

3-
Generated at 02:16 AM UTC / November 05, 2025
3+
Generated at 04:58 PM UTC / November 05, 2025
44

55
## Instructions for AI Tools
66

@@ -9990,13 +9990,15 @@ Group chats can have metadata like names, descriptions, and images to help users
99909990
To learn more, see the [Gated group example](https://github.com/ephemeraHQ/xmtp-agent-examples/tree/main/examples/xmtp-gated-group) in the xmtp-agents-examples repo.
99919991
:::
99929992

9993-
## Available metadata fields
9993+
## Group metadata
9994+
9995+
### Available metadata fields
99949996

99959997
- `group_name`: The name of the group chat
99969998
- `description`: A description of the group chat
99979999
- `image_url`: A URL pointing to an image for the group chat
999810000

9999-
## Get and update metadata
10001+
### Get and update metadata
1000010002

1000110003
```js [Node]
1000210004
// Get metadata
@@ -10010,23 +10012,18 @@ await group.updateDescription('New Group Description');
1001010012
await group.updateImageUrl('newurl.com');
1001110013
```
1001210014

10013-
## Manage group chat membership
10014-
10015-
:::tip[Quickstart]
10016-
To learn more, see the [Gated group example](https://github.com/ephemeraHQ/xmtp-agent-examples/tree/main/examples/xmtp-gated-group) in the xmtp-agents-examples repo.
10017-
:::
10015+
## Group membership
1001810016

1001910017
The maximum group chat size is 250 members.
1002010018

1002110019
### Add members
1002210020

10023-
You can add members directly by their Ethereum addresses or by their inbox IDs
10021+
Add members directly by their Ethereum addresses or by their inbox IDs:
1002410022

1002510023
```js [Node]
1002610024
// Add members by Ethereum address
1002710025
await ctx.addMembersWithAddresses(group, [ address1, address2 ]);
1002810026

10029-
1003010027
// Add members using inbox IDs
1003110028
await group.addMembers([inboxId]);
1003210029
```
@@ -10037,7 +10034,6 @@ Remove members from the group by their Ethereum addresses or by their inbox IDs:
1003710034

1003810035
```js [Node]
1003910036
// Remove members by address
10040-
//needs to send the group to the context
1004110037
await ctx.removeMembersWithAddresses(group, [ address1, address2 ]);
1004210038

1004310039
// Remove members by inbox ID
@@ -10056,26 +10052,6 @@ await group.sync();
1005610052
const members = await group.members();
1005710053
```
1005810054

10059-
## Manage group chat admins
10060-
10061-
```js [Node]
10062-
// Check admin status
10063-
const isAdmin = group.isAdmin(inboxId);
10064-
const isSuperAdmin = group.isSuperAdmin(inboxId);
10065-
10066-
// List admins
10067-
const admins = group.admins;
10068-
const superAdmins = group.superAdmins;
10069-
10070-
// Add/remove admin status
10071-
await group.addAdmin(inboxId);
10072-
await group.addSuperAdmin(inboxId);
10073-
await group.removeAdmin(inboxId);
10074-
await group.removeSuperAdmin(inboxId);
10075-
```
10076-
10077-
## Example usage
10078-
1007910055
Get detailed information about group members:
1008010056

1008110057
```typescript
@@ -10099,6 +10075,35 @@ agent.on('text', async (ctx) => {
1009910075
});
1010010076
```
1010110077

10078+
## Group roles
10079+
10080+
Members can be assigned different roles with varying permission levels. To learn more about how the permission system works, see [Understand group permissions](/agents/build-agents/group-permissions).
10081+
10082+
### Available roles
10083+
10084+
- **Member** - Default role for all group participants
10085+
- **Admin** - Members with elevated permissions
10086+
- **Super admin** - Highest permission level (creator starts as super admin)
10087+
10088+
### Manage roles
10089+
10090+
Check and assign roles to group members:
10091+
10092+
```js [Node]
10093+
// Check admin status
10094+
const isAdmin = group.isAdmin(inboxId);
10095+
const isSuperAdmin = group.isSuperAdmin(inboxId);
10096+
10097+
// List admins
10098+
const admins = group.admins;
10099+
const superAdmins = group.superAdmins;
10100+
10101+
// Add/remove admin status
10102+
await group.addAdmin(inboxId);
10103+
await group.addSuperAdmin(inboxId);
10104+
await group.removeAdmin(inboxId);
10105+
await group.removeSuperAdmin(inboxId);
10106+
```
1010210107

1010310108
## pages/agents/build-agents/create-conversations.mdx
1010410109
# Create conversations
@@ -10457,16 +10462,17 @@ Revoking an installation is permanent. You cannot recover access to a revoked in
1045710462

1045810463

1045910464
## pages/agents/build-agents/group-permissions.mdx
10460-
# Understand the group permissions system
10465+
# Understand group permissions
10466+
10467+
The group permissions system controls what actions different members can take in a group chat. This guide explains how the system works conceptually. For practical code examples of managing roles and permissions, see [Manage group chats](/agents/build-agents/groups).
1046110468

1046210469
## Member statuses
1046310470

10464-
Member statuses are the roles that can be assigned to each participant (inbox ID) in a group chat. These are the available member statuses:
10471+
Member statuses are the roles that can be assigned to each participant (inbox ID) in a group chat:
1046510472

10466-
- Member
10467-
- Everyone in a group chat is a member. A member can be granted admin or super admin status. If a member's admin or super admin status is removed, they are still a member of the group.
10468-
- Admin
10469-
- Super admin
10473+
- **Member** - Everyone in a group chat is a member. A member can be granted admin or super admin status. If a member's admin or super admin status is removed, they are still a member of the group.
10474+
- **Admin** - Members with elevated permissions
10475+
- **Super admin** - Highest permission level with full control over the group
1047010476

1047110477
## Options
1047210478

@@ -10539,6 +10545,13 @@ If you aren't opinionated and don't set any permissions and options, groups will
1053910545

1054010546
To learn more about the `All_Members` and `Admin_Only` policy sets, see [group_permissions.rs](https://github.com/xmtp/libxmtp/blob/85dd6d36f46db1ed74fe98273eea6871fea2e078/xmtp_mls/src/groups/group_permissions.rs#L1192-L1226) in the LibXMTP repo.
1054110547

10548+
## Next steps
10549+
10550+
Now that you understand how the permission system works, see [Manage group chats](/agents/build-agents/groups) for practical code examples of:
10551+
- Adding and removing members
10552+
- Assigning roles
10553+
- Managing group metadata
10554+
1054210555

1054310556
## pages/agents/get-started/faq.mdx
1054410557
# FAQ about XMTP agents

0 commit comments

Comments
 (0)