Skip to main content

A Matrix MCP server for connecting coding agents to Matrix and MindRoom conversations.

Project description

Matrix MCP

License CI PyPI Python Versions Docs MCP

MindRoom Logo

Local-first Matrix access for MCP clients.

Matrix MCP lets Claude Code and other MCP clients read and write Matrix rooms. It is intended to make MindRoom conversations available to local coding agents without giving hosted agents access to the local filesystem.

Install

uv tool install matrix-mcp

For local development:

uv sync --extra dev

Login

Matrix SSO:

matrix-mcp auth sso https://matrix.example.com

If the homeserver advertises multiple SSO providers, list their provider IDs:

matrix-mcp auth providers https://matrix.example.com

Then pass the provider ID explicitly:

matrix-mcp auth sso https://matrix.example.com --idp-id github

Existing Matrix access token:

matrix-mcp auth token https://matrix.example.com @alice:example.com "$MATRIX_ACCESS_TOKEN" --device-id DEVICEID

Password auth, when enabled by the homeserver:

matrix-mcp auth password https://matrix.example.com @alice:example.com

Credentials are stored in the user config directory reported by:

matrix-mcp config-path

Remove stored credentials:

matrix-mcp auth logout

Claude Code

Add the local MCP server:

claude mcp add matrix -- matrix-mcp serve

The server runs over stdio. It does not expose a local HTTP port during normal MCP operation.

Tools

  • matrix_whoami: show the configured Matrix user/device.
  • matrix_list_rooms: list rooms joined by the authenticated user.
  • matrix_read_room_recent: read recent text events from a room.
  • matrix_read_thread: read a Matrix thread root and its recent text replies.
  • matrix_send_message: send a text message, optionally as a Matrix thread reply.
  • matrix_reply_thread: reply to an existing Matrix thread.

The tool instructions tell clients to prefer read tools first and only send messages when the user explicitly asks.

Development

uv run --extra dev pytest
uv run --extra dev ruff check .
uv run --extra dev ruff format --check .
uv run --extra dev mypy src tests
uv run --extra dev ty check
uv build

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

matrix_mcp-0.2.0.tar.gz (128.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

matrix_mcp-0.2.0-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file matrix_mcp-0.2.0.tar.gz.

File metadata

  • Download URL: matrix_mcp-0.2.0.tar.gz
  • Upload date:
  • Size: 128.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for matrix_mcp-0.2.0.tar.gz
Algorithm Hash digest
SHA256 74a291ed8da7fb52edc776a81fe4d81cdcd9911125e4aa12c7d074812f2a6b18
MD5 baa4c9f53694c9cf9430c56a8926979c
BLAKE2b-256 cb51488329f0e699b92b19dd787a82402409e4406e3c08cf6f5f720b863d16e2

See more details on using hashes here.

Provenance

The following attestation bundles were made for matrix_mcp-0.2.0.tar.gz:

Publisher: release.yml on mindroom-ai/matrix-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file matrix_mcp-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: matrix_mcp-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 10.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for matrix_mcp-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7edc6fb7e603c827149c13fdc81e113191147052b9c24ad3a603ba7cd2bfda33
MD5 09dfb51391d4309f281a77aa306d1907
BLAKE2b-256 72628aa308519f157b26b54a4b1f6c1b2d8131dc6e8eeb144ec83085f6909dff

See more details on using hashes here.

Provenance

The following attestation bundles were made for matrix_mcp-0.2.0-py3-none-any.whl:

Publisher: release.yml on mindroom-ai/matrix-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page