matrix-mcp-server

matrix-mcp-server

1
communication

matrix-mcp is a TypeScript-based MCP server designed to interact with Matrix homeservers. It facilitates tasks such as connecting to Matrix servers, listing joined rooms, and fetching messages.

matrix-mcp-server

Overview

matrix-mcp is an MCP server implemented in TypeScript that provides tools for interacting with a Matrix homeserver. It includes features such as connecting to a Matrix server, listing joined rooms, fetching room messages, and more.

Prerequisites

  • Node.js 20 or higher
  • npm (Node package manager)

Setup Instructions

  1. Clone the Repository

    git clone <repository-url>
cd matrix-mcp-server

  2. Install Dependencies

    npm install

  3. Build the Server

    npm run build

  4. Test the Server

Run Inspector to test the server. Make sure you get an access token via the connect-matrix tool first.

npm run dev
npx @modelcontextprotocol/inspector

Add to VSCode

In mcp.json:

{
  "servers": {
    "matrix-mcp": {
      "url": "http://localhost:3000/mcp"
    }
  }
}

Notes

  • This project is for development purposes. For production use, ensure proper session management and security measures are implemented.
  • Refer to the src/server.ts file for additional configuration options.

License

This project is licensed under the MIT License.