Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Matrix.org (BYOK) — connector documentation

  • MCP endpoint: https://byok-matrix-org.connectorbay.com/mcp
  • REST API: POST https://byok-matrix-org.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-matrix-org.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Matrix.org Matrix access token of a matrix.org account, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-matrix-org.connectorbay.com/health · Tool schemas: https://byok-matrix-org.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-matrix-org · agent@connectorbay.com

What Matrix.org (BYOK) is for

Matrix.org (BYOK) lets an AI assistant read your own Matrix.org data through the Matrix.org API with a key you supply (Matrix access token of a matrix.org account). Read-only: 11 tools (whoami, get_server_capabilities, get_profile, list_joined_rooms, get_room_name, get_room_topic, list_room_joined_members, list_room_aliases, resolve_room_alias, list_public_rooms, search_public_rooms). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to matrix-client.matrix.org. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Matrix.org. Matrix.org and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which Matrix account is this token for?"
  • "What room versions does the matrix.org server support?"
  • "What is the display name of @alice:matrix.org?"
  • "Which Matrix rooms am I in?"
  • "What is the name of Matrix room !abcdefg:matrix.org?"
  • "What is the topic of Matrix room !abcdefg:matrix.org?"

What it does

  • whoami: Show the Matrix user ID and device ID the access token belongs to, and whether it is a guest account.
  • get_server_capabilities: Show what the matrix.org homeserver lets this account do: password changes, supported room versions and other capabilities.
  • get_profile: Get a Matrix user's public profile: display name and avatar URL.
  • list_joined_rooms: List the IDs of every room the account has joined (IDs only; use the room tools for names and topics).
  • get_room_name: Get the name of a room the account is in (the m.room.name state event).
  • get_room_topic: Get the topic of a room the account is in (the m.room.topic state event).
  • list_room_joined_members: List the users currently joined to a room with their display names and avatar URLs (no messages).
  • list_room_aliases: List the local room aliases (like #name:matrix.org) that point to a room.
  • resolve_room_alias: Resolve a room alias to its room ID and the servers that know the room.
  • list_public_rooms: List rooms published in the public room directory with name, topic, member count and join rule. Paged with the since token.
  • search_public_rooms: Search the public room directory for a word in room names, topics or aliases (a read-only query).

BYOK key

You bring your own Matrix.org Matrix access token of a matrix.org account (https://app.element.io/#/user-settings/help). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to matrix-client.matrix.org over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Matrix.org API (matrix-client.matrix.org) with a BYOK key; documentation: https://spec.matrix.org/latest/client-server-api/. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Matrix.org. Matrix.org and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Matrix.org account.

Built for: Worldwide. Languages: English.