Propresenter MCP

🚀 propresenter-mcp

這是一個全面的模型上下文協議（MCP）服務器，可通過 ProPresenter API 對 ProPresenter 演示文稿進行完全控制。該服務器實現了完整的 ProPresenter API 規範，擁有 231 個端點，這些端點被組織成 27 個 API 組，並通過模塊化的客戶端類進行公開。

🚀 快速開始

🔍 官方 MCP 註冊表

• https://registry.modelcontextprotocol.io/?q=alxpark%2Fpropresenter-mcp

📋 前提條件

• Node.js 18 或更高版本
• 啟用 API 的 ProPresenter 7
• ProPresenter 正在運行且可在您的網絡中訪問

📦 安裝指南

1. 克隆此倉庫或下載源代碼。
2. 安裝依賴項：

npm install

3. 構建項目：

npm run build

⚙️ 配置

服務器使用環境變量連接到 ProPresenter：

• PROPRESENTER_URL - 您的 ProPresenter 實例的 URL（默認值：http://localhost:50000）
• PROPRESENTER_PASSWORD - API 密碼（如果在 ProPresenter 中配置）

ProPresenter 設置

1. 打開 ProPresenter 偏好設置。
2. 轉到“網絡”選項卡。
3. 啟用“網絡”並記錄端口號（默認值：50000）。
4. 可選擇為 API 訪問設置密碼。

💻 使用示例

與 Claude Desktop 配合使用

將以下內容添加到您的 Claude Desktop 配置文件中：

• macOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "propresenter": {
      "command": "node",
      "args": ["/absolute/path/to/propresenter-mcp/build/index.js"],
      "env": {
        "PROPRESENTER_URL": "http://localhost:50000",
        "PROPRESENTER_PASSWORD": "your-password-if-needed"
      }
    }
  }
}

將 /absolute/path/to/propresenter-mcp 替換為該項目的實際路徑。

與 VS Code 配合使用

可以使用包含的 MCP 配置在 VS Code 中直接調試此服務器。

1. 在 VS Code 中打開此項目。
2. 服務器通過 .vscode/mcp.json 自動配置為可調試。
3. 使用 MCP 擴展來測試和調試服務器。

示例命令

連接後，您可以要求 Claude 控制 ProPresenter：

• 狀態與信息：
  • "當前運行的 ProPresenter 版本是什麼？"
  • "顯示所有屏幕的狀態"
  • "觀眾屏幕的狀態如何？"
  • "獲取當前幻燈片信息"
• 演示文稿：
  • "當前活動的演示文稿是哪個？"
  • "觸發 UUID 為 [uuid] 的演示文稿"
  • "轉到下一張幻燈片"
  • "轉到第 5 張幻燈片"
  • "播放演示文稿時間線"
  • "顯示和絃圖表"
  • "獲取第 3 張幻燈片的縮略圖"
• 公告：
  • "當前活動的公告是哪個？"
  • "觸發下一個公告提示"
  • "顯示公告時間線狀態"
  • "轉到公告提示 2"
• 音頻與媒體：
  • "列出所有音頻播放列表"
  • "顯示音頻播放列表 [id] 的內容"
  • "播放活動播放列表中的下一首歌曲"
  • "觸發聚焦的音頻播放列表"
  • "列出所有媒體播放列表"
  • "觸發播放列表 [playlist_id] 中的媒體項 [id]"
• 播放列表：
  • "列出所有演示文稿播放列表"
  • "顯示活動播放列表"
  • "聚焦下一個播放列表"
  • "觸發聚焦播放列表中的第一個項目"
  • "創建一個名為 'Sunday Service' 的新播放列表"
• 捕獲：
  • "當前的捕獲狀態如何？"
  • "開始錄製"
  • "停止捕獲"
  • "顯示可用的 RTMP 捕獲編碼"
• 清除：
  • "清除公告層"
  • "顯示所有清除組"
  • "觸發清除組 [id]"
  • "創建一個新的清除組"
• 庫：
  • "列出我所有的庫"
  • "顯示庫 [id] 中的演示文稿"
  • "從庫 [library_id] 中觸發演示文稿 [id]"
• 外觀：
  • "顯示所有配置的外觀"
  • "當前活動的外觀是哪個？"
  • "切換到外觀 [id]"
  • "創建一個新的外觀"
• 宏：
  • "列出所有宏"
  • "觸發宏 [id]"
  • "顯示所有宏集合"
  • "創建一個新的宏"
• 道具：
  • "列出所有道具"
  • "觸發道具 [id]"
  • "清除道具 [id]"
  • "暫停道具 [id] 的自動清除"
  • "列出所有道具集合"
• 舞臺：
  • "顯示當前的舞臺消息"
  • "顯示舞臺消息 [message]"
  • "隱藏舞臺消息"
  • "列出所有舞臺佈局"
  • "為屏幕 [screen_id] 設置舞臺佈局 [layout_id]"
• 消息：
  • "顯示所有消息"
  • "顯示消息 [id]"
  • "隱藏消息 [id]"
  • "創建一個新的消息"
• 計時器：
  • "列出所有計時器"
  • "啟動計時器 [id]"
  • "停止計時器 [id]"
  • "重置佈道計時器"
  • "創建一個倒計時計時器"
  • "獲取當前系統時間"
• 主題：
  • "列出所有主題"
  • "顯示主題 [id] 的詳細信息"
  • "從主題 [theme_id] 中獲取主題幻燈片 [slide_id]"
• 傳輸：
  • "播放演示文稿層"
  • "暫停音頻層"
  • "在公告層上快進 30 秒"
  • "轉到演示文稿的結尾"
  • "獲取當前播放時間"
• 遮罩：
  • "列出所有遮罩"
  • "顯示遮罩 [id] 的詳細信息"
• 觸發器：
  • "觸發下一個提示"
  • "觸發上一個媒體項"

🛠️ 開發

構建

npm run build

監聽模式

npm run watch

📚 詳細文檔

此服務器實現了完整的 ProPresenter API，文檔位於 https://openapi.propresenter.com/ 。

API 覆蓋範圍

• 總端點：231 個 REST API 端點
• API 組：27 個功能組
• 客戶端模塊：18 個 TypeScript 客戶端類
• 工具定義：18 個 MCP 工具模塊
• 處理程序模塊：18 個請求處理程序模塊
• HTTP 方法：完全支持 GET、POST、PUT、DELETE 操作
• 架構：完整的三層實現（客戶端 → 工具 → 處理程序）

完整的 API 文檔，包含按組組織的所有 231 個端點，請參閱 api/api.md。

🔧 故障排除

連接問題

• 驗證 ProPresenter 是否正在運行且 API 已啟用。
• 檢查 URL 和端口是否正確。
• 確保沒有防火牆阻止連接。
• 如果啟用了身份驗證，請驗證密碼。

服務器無法啟動

• 確保您已使用 npm run build 構建項目。
• 檢查是否安裝了 Node.js 18 或更高版本。
• 驗證是否已使用 npm install 安裝所有依賴項。