elizaos-plugin-matrix 2.0.0a5

Matrix messaging integration plugin for elizaOS agents

@elizaos/plugin-matrix

Matrix messaging integration plugin for elizaOS agents.

Features

• Decentralized Messaging: Connect to any Matrix homeserver
• End-to-End Encryption: Optional E2EE support for secure communications
• Room Support: Join, leave, and manage Matrix rooms
• Reactions: React to messages with emoji
• Threading: Support for Matrix threads
• Direct Messages: Handle DMs and group rooms
• Typing Indicators: Send typing notifications
• Read Receipts: Mark messages as read

Installation

npm install @elizaos/plugin-matrix

Prerequisites

1. Matrix Account: A Matrix account on any homeserver
2. Access Token: Generate an access token for your account

Getting an Access Token

You can get an access token by:

1. Element/Web Client: Settings -> Help & About -> Access Token
2. API Login: Use the Matrix login API with your password
3. Command Line: Use curl or a tool like matrix-commander

Configuration

Set the following environment variables:

Required

Variable	Description
MATRIX_HOMESERVER	Homeserver URL (e.g., https://matrix.org)
MATRIX_USER_ID	Full Matrix user ID (@user:homeserver.org)
MATRIX_ACCESS_TOKEN	Access token for authentication

Optional

Variable	Description	Default
MATRIX_DEVICE_ID	Device ID for this session	Auto-generated
MATRIX_ROOMS	Comma-separated room IDs/aliases to auto-join	-
MATRIX_AUTO_JOIN	Auto-accept room invites	false
MATRIX_ENCRYPTION	Enable E2EE support	false
MATRIX_REQUIRE_MENTION	Only respond when mentioned in rooms	false

Usage

Basic Setup

import matrixPlugin from "@elizaos/plugin-matrix";

const agent = new Agent({
  plugins: [matrixPlugin],
});

Actions

MATRIX_SEND_MESSAGE

Send a message to a Matrix room.

// User: "Send a message saying 'Hello everyone!'"
// Agent will send to the current room

MATRIX_SEND_REACTION

React to a message with an emoji.

// User: "React to the last message with 👍"
// Agent will add the reaction

MATRIX_LIST_ROOMS

List all rooms the bot has joined.

// User: "What rooms are you in?"
// Agent will list all joined rooms

MATRIX_JOIN_ROOM

Join a Matrix room by ID or alias.

// User: "Join #general:matrix.org"
// Agent will join the room

Providers

matrixRoomState

Provides context about the current Matrix room:

• Room ID and name
• Member count
• Encryption status
• Whether it's a DM

matrixUserContext

Provides context about the user in the conversation:

• User ID
• Display name
• Avatar URL

Events

The plugin emits the following events:

Event	Description
MATRIX_MESSAGE_RECEIVED	A message was received
MATRIX_MESSAGE_SENT	A message was sent
MATRIX_ROOM_JOINED	Joined a room
MATRIX_ROOM_LEFT	Left a room
MATRIX_INVITE_RECEIVED	Received a room invite
MATRIX_REACTION_RECEIVED	Received a reaction
MATRIX_SYNC_COMPLETE	Initial sync completed
MATRIX_CONNECTION_READY	Client connected
MATRIX_CONNECTION_LOST	Connection lost

Message Limits

• Maximum message length: 4000 characters
• Longer messages are split automatically

Matrix ID Formats

• User ID: @localpart:homeserver.org
• Room ID: !opaque_id:homeserver.org
• Room Alias: #human_readable:homeserver.org

Security Considerations

1. Token Security: Never expose your access token
2. Homeserver Trust: Only connect to trusted homeservers
3. E2EE: Enable encryption for sensitive communications
4. Room Verification: Verify room members when using E2EE

Troubleshooting

Connection Issues

1. Verify your homeserver URL is correct
2. Check that your access token is valid
3. Ensure your homeserver is reachable

Sync Issues

1. The initial sync may take time for accounts with many rooms
2. Check homeserver rate limits
3. Verify network connectivity

Encryption Issues

1. Ensure E2EE is enabled on both ends
2. Verify device is properly set up
3. Check for key verification requirements

Multi-language Support

This plugin supports:

• TypeScript - Full implementation with matrix-js-sdk
• Python - Full implementation with matrix-nio
• Rust - Full implementation with matrix-sdk

License

MIT