mkslides - MCP Protocol Markdown to HTML Slideshow Service, Supporting Theme Configuration and Docker Deployment

Mkslides MCP

A Markdown-to-HTML slide generation service based on the MCP protocol, implemented through the mkslides library, supporting theme configuration and Docker deployment.

Education and learning tools Developer tools #Slide generation #MCP service #Markdown conversion #Docker deployment .Python

rating : 2 points

downloads : 10.2K

update time : 2025-04-28

Open Site

What is mdslides-mcp-server?

This is a server based on the Model Context Protocol that can automatically convert Markdown documents into professional presentations. It uses the mkslides tool library and supports directly generating slides through AI assistants such as Claude, which is particularly suitable for scenarios such as technical sharing and product demonstrations.

How to use mdslides-mcp-server?

Simply install and configure it in an editor that supports the MCP protocol (such as VSCode), and you can create slides using simple Markdown syntax. The system will automatically handle format conversion and style configuration.

Applicable scenarios

Occasions that require quickly creating professional slides, such as preparing technical speeches, making teaching courseware, demonstrating product features, and generating meeting reports.

Main features

Markdown to slides

Generate professional HTML slides using simple Markdown syntax

Theme customization

Support 12 built-in themes (such as black, white, starry sky, etc.) and code highlighting styles

Reveal.js integration

Based on the popular Reveal.js framework, support rich transition animations and presentation effects

Containerized deployment

Provide Docker support to simplify the environment configuration and deployment process

Advantages

No need to learn complex tools, use familiar Markdown syntax

Deeply integrate with tools such as VSCode and Claude to improve work efficiency

Support multiple theme and style customizations to meet different scenario requirements

The containerized deployment option simplifies the environment configuration

Limitations

Basic knowledge of Markdown syntax is required

Support for advanced animation effects is limited

Currently only supports the HTML output format

How to use

Installation preparation

Ensure that Python 3.12+ and the mkslides tool are installed

Server installation

Choose the pip or Docker method to install the server

Configure the MCP client

Add server configuration in an editor such as VSCode

Generate slides

Use the generate_slides tool in the chat interface that supports MCP

Usage examples

Basic presentation creation

Create a simple two-page slide using the default theme

Customized theme presentation

Create a technical presentation with a black theme and use specific code highlighting

Frequently Asked Questions

Do I need an internet connection to use it?

Does it support Chinese content?

How to change the output directory?

Can I export to PDF?

Related resources

mkslides project homepage

Technical documentation for the core conversion tool

Model Context Protocol

Official documentation for the MCP protocol

Demonstration video

Function demonstration video

Markdown syntax guide

Reference for basic Markdown syntax

🚀 mdslides-mcp-server

An MCP (Model Context Protocol) server for generating HTML slides from Markdown content, using the mkslides library.

🚀 Quick Start

This server provides a simple interface for the mkslides command-line tool, allowing the generation of presentations directly from Markdown input via the Model Context Protocol. This makes it easy to integrate with tools like Claude in VSCode, facilitating the creation and management of presentations.

🎥 Demo

mcp-demo.webm

✨ Features

Generate HTML slides from Markdown.
Support various mkslides configuration options (themes, syntax highlighting themes, Reveal.js options).
Handle temporary files cleanly.
Offer containerized deployment options using Docker.

📦 Installation

Prerequisites

Python 3.12 or higher.
mkslides installed and added to the system PATH.
Model Context Protocol (MCP) client (e.g., Claude in VSCode).
Docker (if using the Docker installation method).

Installation Methods

Using pip

Clone the repository:

git clone https://github.com/your-repo/mdslides-mcp-server.git # Replace with the actual repository URL
cd mdslides-mcp-server

Install using pip and uv (recommended):

uv sync && uv run

Using Docker

Build the image:

docker build -t mdslides .

Run the container:

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

📚 Documentation

Server Configuration Example

# config.py
class MCPConfig:
    def __init__(self):
        self.server_port = 8000  # Set the server port
        self.output_dir = "mkslides_output"  # Set the output directory
        self.default_theme = "white"  # Set the default theme

💻 Usage Examples

Basic Usage

<!-- 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>

This will generate a presentation using the "black" theme and "slide" transition effect, outputting to the default directory ./mkslides_output.

🔧 Technical Details

Contribution Guidelines

Contributions are welcome! Please follow the standard GitHub workflow: fork the repository, create a feature branch, and submit a pull request.

Testing

There is currently a placeholder test file (tests/test_server.py). Use a test runner like pytest to execute tests:

pytest

Remember to add actual test cases to tests/test_server.py.

Building from Source

Set up the development environment following the pip installation steps.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details. (Note: There is currently no LICENSE file in the repository. It is recommended to create one.)