Matrix MCP Server

🚀 matrix-mcp

matrix-mcp 是一個用 TypeScript 實現的 MCP 服務器，提供了與 Matrix 家域服交互的工具。它具備連接到 Matrix 服務器、列出已加入的房間、獲取房間消息等功能，能幫助開發者更便捷地與 Matrix 服務進行交互。

🚀 快速開始

matrix-mcp 是一款強大的 MCP 服務器，藉助它可以輕鬆實現與 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 發送 POST 請求，攜帶以下 JSON 有效負載：

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

添加到 VSCode

將以下內容添加到 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 許可證發佈。