Mkslides MCP

🚀 mdslides-mcp-server

mdslides-mcp-server 是一個藉助 mkslides 庫，從 Markdown 內容生成 HTML 幻燈片的 MCP（模型上下文協議）服務器。它為開發者和演示文稿創作者提供了便捷的途徑，能夠輕鬆地將 Markdown 內容轉換為專業的演示文稿。

🚀 快速開始

此服務器為 mkslides 命令行工具提供了一個簡單的接口，允許直接從 Markdown 輸入通過模型上下文協議生成演示文稿。這使得與諸如 Claude 在 VSCode 中的集成變得容易，從而輕鬆創建和管理演示文稿。

演示

mcp-demo.webm

✨ 主要特性

• 從 Markdown 生成 HTML 幻燈片。
• 支持多種 mkslides 配置選項（主題、語法高亮主題、Reveal.js 選項）。
• 清晰處理臨時文件。
• 使用 Docker 的容器化部署選項。

📦 安裝指南

先決條件

• Python 3.12 或更高版本
• mkslides 已安裝並添加到系統 PATH 中
• 模型上下文協議（MCP） 客戶端（例如，Claude 在 VSCode）
• Docker（如果使用 Docker 安裝方法）

安裝方式

使用 pip

1. 克隆倉庫：

   git clone https://github.com/your-repo/mdslides-mcp-server.git # 請替換為實際倉庫 URL
   cd mdslides-mcp-server
   

2. 使用 pip 和 uv（推薦）安裝：

   uv sync && uv run
   

使用 Docker

1. 構建鏡像：

   docker build -t mdslides .
   

2. 運行容器：

   docker run --rm -it -v $(pwd):/app mdslides
   

📚 詳細文檔

服務器配置示例

# config.py
class MCPConfig:
    def __init__(self):
        self.server_port = 8000  # 設置服務器端口
        self.output_dir = "mkslides_output"  # 設置輸出目錄
        self.default_theme = "white"  # 默認主題設置

💻 使用示例

基礎用法

<!-- use_mcp_tool.xml -->
<use_mcp_tool>
    <tool_name>generate_slides</tool_name>
    <parameters>
        <markdown_content>## 標題\n- 列點1\n- 列點2</markdown_content>
        <slides_theme>black</slides_theme>
        <revealjs_options>
            <transition>slide</transition>
        </revealjs_options>
    </parameters>
</use_mcp_tool>

這將使用“黑色”主題和“幻燈片”過渡效果生成演示文稿，輸出到默認目錄 ./mkslides_output。

🔧 技術細節

貢獻指南

歡迎貢獻！請按照常規 GitHub 流程：fork 倉庫，創建功能分支，並提交 pull request。

測試方法

目前有一個佔位符測試文件（tests/test_server.py）。使用測試運行器如 pytest 執行測試：

pytest

記得向 tests/test_server.py 添加實際的測試用例。

從源碼構建

按照 pip 安裝步驟設置開發環境。

📄 許可證

本項目 licensed under the MIT License - 請查看 LICENSE 文件獲取詳細信息。（注意：當前倉庫中沒有 LICENSE 文件，建議創建一個。）

致謝

• mkslides 感謝核心幻燈片生成功能。
• 模型上下文協議 感謝服務器集成的支持。