mdslides-mcp-server

mdslides-mcp-server

一个 MCP（Model Context Protocol）服务，使用 mkslides 库从 Markdown 内容生成 HTML 幻灯片。

功能介绍

此服务为 mkslides 命令行工具提供了一个简单的接口，让你可以通过 Model Context Protocol 直接从 Markdown 输入生成演示文稿幻灯片。这使其能够与 Claude in VSCode 等工具集成，轻松创建和管理演示文稿。

演示

mcp-demo.webm

功能特性

• 从 Markdown 生成 HTML 幻灯片。
• 支持各种 mkslides 配置选项（主题、代码高亮主题、Reveal.js 选项）。
• 妥善处理临时文件。
• 提供使用 Docker 的容器化部署选项。

安装

先决条件

• Python 3.12 或更高版本
• 已安装 mkslides，且可通过 PATH 访问。
• Model Context Protocol（MCP） 客户端（例如，Claude in VSCode）。
• Docker（如果使用 Docker 安装方式）。

安装方式

使用 pip

1. 克隆代码库：

   git clone https://github.com/your-repo/mdslides-mcp-server.git
   cd mdslides-mcp-server
   

2. 使用 pip 和 uv 安装（推荐）：

   uv sync
   

   或使用 pip：

   pip install .
   

使用 Docker

1. 确保已安装并运行 Docker。
2. 在代码库根目录中运行部署脚本：

./deploy_mdslides_docker.sh

This script will build the Docker image (if not already built) and start a container instance named `mdslides-mcp-instance`. The server inside the container will be running and ready to accept connections via MCP. The script also handles creating the necessary output directory (`./mkslides_output`) on the host.

### Configuration in MCP Settings

To use the server with your MCP client (like Claude in VSCode), you need to add it to your MCP settings.

If you installed using pip, you can run the server directly:

```json
{
  "mcpServers": {
    "mdslides-mcp-local": {
      "command": "python",
      "args": ["src/mdslides_mcp_server/server.py"],
      "disabled": false,
      "autoApprove": []
    }
  }
}

如果你通过脚本使用 Docker 部署：

配置 MCP 客户端，使其连接到正在运行的容器实例：

{
  "mcpServers": {
    "mdslides-mcp-local": {
      "autoApprove": [],
      "disabled": false,
      "timeout": 60,
      "command": "docker",
      "args": [
        "attach",
        "mdslides-mcp-instance"
      ],
      "transportType": "stdio"
    }
  }
}

在 Claude/VSCode 中使用

在 MCP 设置中完成配置后，你就可以直接在 VSCode 的 Claude 聊天界面中使用 generate_slides 工具。

可用工具：generate_slides

使用 mkslides 从 Markdown 输入生成 HTML 演示文稿幻灯片，并通过本地 HTTP 服务提供访问。

参数：

• markdown_content（字符串，必需）：幻灯片的原始 Markdown 文本。
• slides_theme（字符串，可选）：幻灯片主题名称（例如，black、white、league、beige、night、serif、simple、solarized、moon、dracula、sky、blood）。覆盖默认主题。
• slides_highlight_theme（字符串，可选）：代码块的语法高亮主题（highlight.js 内置的任意主题）。
• revealjs_options（对象，可选）：包含 Reveal.js 配置选项的字典，用于合并或覆盖默认设置。

返回值：

• （字符串）：一个 URL（例如，http://localhost:8080/latest/index.html），指向由 MCP 服务的内部 HTTP 服务提供的已生成 HTML 幻灯片。你可以在浏览器中打开此 URL。

使用示例：

<use_mcp_tool>
<server_name>mdslides-mcp-local</server_name>
<tool_name>generate_slides</tool_name>
<arguments>
{
  "markdown_content": "# My Presentation\n\n---\n\n## Slide 2\n\n- Bullet 1\n- Bullet 2",
  "slides_theme": "black",
  "revealjs_options": {
    "transition": "slide"
  }
}
</arguments>
</use_mcp_tool>

这将在默认输出目录（./mkslides_output）中使用 'black' 主题和 'slide' 切换效果生成幻灯片。

开发

贡献

欢迎贡献！请遵循标准的 GitHub 实践：复刻代码库、创建功能分支并提交拉取请求。

运行测试

目前有一个占位测试文件（tests/test_server.py）。要运行测试，通常可以使用 pytest 等测试运行器：

pytest

请记得在 tests/test_server.py 中添加实际测试。

从源代码构建

按照上面的 pip 安装步骤设置开发环境。

许可证

本项目采用 MIT 许可证授权，详情请参阅 LICENSE 文件。（注意：代码库中目前没有 LICENSE 文件。你可能需要创建一个。）

致谢

• 感谢 mkslides 提供核心幻灯片生成功能。
• 感谢 Model Context Protocol 支持服务集成。