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 感谢核心幻灯片生成功能。
• 模型上下文协议 感谢服务器集成的支持。