Matrix MCP Server

🚀 matrix - mcp

matrix - mcp は TypeScript で実装された MCP サーバーで、Matrix ホームサーバーとのインタラクションを可能にするツールを提供します。Matrix サーバーへの接続、参加しているルームの一覧表示、ルームメッセージの取得などの機能が含まれています。

🚀 クイックスタート

✨ 主な機能

matrix - mcp は、TypeScript で実装された MCP サーバーで、Matrix ホームサーバーとのインタラクションを可能にするツールを提供します。主な機能は以下の通りです。

• Matrix サーバーへの接続
• 参加しているルームの一覧表示
• ルームメッセージの取得

📦 インストール

前提条件

• Node.js 20 以上
• npm（Node パッケージマネージャー）

セットアップ手順

1. リポジトリをクローンする

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

2. 依存関係をインストールする

   npm install
   

3. サーバーを起動する 開発モードで MCP サーバーを起動するには：

   npm run dev
   

   サーバーをビルドして本番モードで実行するには：

   npm run build
   npm start
   

   デフォルトでは、サーバーは http://localhost:3000 で実行されます。

💻 使用例

基本的な使用法

サーバーのテストには、Postman や curl などのツールを使用できます。例えば、Matrix ホームサーバーに接続するには、/connect - matrix に以下の JSON ペイロードを含む POST リクエストを送信します。

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

高度な使用法

VSCode の設定ファイルに以下の内容を追加することができます。

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

🔧 注意事項

⚠️ 重要提示

このプロジェクトは開発目的で使用されます。本番環境で使用する場合は、適切なセキュリティ対策とセッション管理を実装することを確認してください。

💡 使用建议

より多くの設定オプションについては、src/server.ts ファイルを参照してください。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。