Matrix MCP Server

🚀 Matrix MCP Server

Matrix MCP is a TypeScript-based MCP server that offers tools for interacting with Matrix home servers. It enables functions such as connecting to Matrix servers, listing joined rooms, and retrieving room messages.

🚀 Quick Start

✨ Features

• Connect to Matrix servers.
• List joined rooms.
• Retrieve room messages.

📦 Installation

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. Run the server To start the MCP server in development mode:

npm run dev

To build and run the server in production mode:

npm run build
npm start

By default, the server will run at http://localhost:3000.

💻 Usage Examples

Testing the Server

You can test the server using tools like Postman or curl. For example, to connect to a Matrix home server, send a POST request to /connect-matrix with the following JSON payload:

{
  "homeserverUrl": "https://matrix.org",
  "username": "your-username",
  "password": "your-password"
}

Adding to VSCode

Add the following content to your VSCode configuration file:

{
  "servers": {
    "matrix-mcp": {
      "type": "stdio",
      "command": "<full-path-to>/node",
      "args": [
        "<full-path-to>/matrix-mcp-server/dist/server.js"
      ]
    }
  }
}

⚠️ Important Note

• This project is intended for development purposes. When using it in a production environment, ensure that appropriate security measures and session management are implemented.
• Refer to the src/server.ts file for more configuration options.

📄 License

This project is licensed under the MIT License.