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 git+https://github.com/mindroom-ai/matrix-mcp

For local development:

uv sync --extra dev

Login

Matrix SSO:

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

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

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_send_message: send a text message, optionally as a Matrix thread reply.

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.1.0.tar.gz (126.4 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.1.0-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: matrix_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 126.4 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.1.0.tar.gz
Algorithm Hash digest
SHA256 27252825577f0251c1758a53124c6fbf7f533a21b99b8c50a854c2614dd2a25d
MD5 aba94638866cd8095f383290dbd60a94
BLAKE2b-256 88ae999f2e655dde0e23dbde2b844b9d91d97737c4dd5c64454164708de1228b

See more details on using hashes here.

Provenance

The following attestation bundles were made for matrix_mcp-0.1.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.1.0-py3-none-any.whl.

File metadata

  • Download URL: matrix_mcp-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.0 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 130a604f343b53d9251ba61f34976bf62c7d635daeb5cf0c6781dc50278ad024
MD5 ed7c8182c366fe94ba789f989fa36a1f
BLAKE2b-256 b5b27d196d07c8bbc546bcecbc3a77c44dec0e8606e8063d5f309f17f324b1b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for matrix_mcp-0.1.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