内容
# mdslides-mcp-server
一个 MCP (Model Context Protocol) 服务器,用于使用 [mkslides](https://github.com/saoudrizwan/mkslides) 库从 Markdown 内容生成 HTML 幻灯片。
## What it Does
该服务器提供了一个简单的界面来访问 `mkslides` 命令行工具,允许您通过 Model Context Protocol 直接从 Markdown 输入生成演示文稿幻灯片。这使得可以与 VSCode 中的 Claude 等工具集成,以轻松创建和管理演示文稿。
## Demo
[mcp-demo.webm](https://github.com/user-attachments/assets/7a541e5e-2509-4a16-a007-f423dc65df05)
## Features
* 从 Markdown 生成 HTML 幻灯片。
* 支持各种 mkslides 配置选项(主题、高亮主题、Reveal.js 选项)。
* 干净地处理临时文件。
* 使用 Docker 的容器化部署选项。
## Installation
### Prerequisites
* Python 3.12 或更高版本
* [mkslides](https://github.com/saoudrizwan/mkslides) 已安装并在您的 PATH 中可用。
* [Model Context Protocol (MCP)](https://github.com/modelcontextprotocol/mcp) 客户端(例如,VSCode 中的 Claude)。
* Docker(如果使用 Docker 安装方法)。
### Installation Methods
#### Using pip
1. 克隆存储库:
```bash
git clone https://github.com/your-repo/mdslides-mcp-server.git
cd mdslides-mcp-server
```
2. 使用 pip 和 uv 安装(推荐):
```bash
uv sync
```
或者使用 pip:
```bash
pip install .
```
#### Using Docker
1. 确保 Docker 已安装并正在运行。
2. 从存储库根目录,运行部署脚本:
```bash
./deploy_mdslides_docker.sh
```
此脚本将构建 Docker 镜像(如果尚未构建),并启动一个名为 `mdslides-mcp-instance` 的容器实例。容器内的服务器将运行并准备好通过 MCP 接受连接。该脚本还处理在主机上创建必要的输出目录 (`./mkslides_output`)。
### Configuration in MCP Settings
要将服务器与您的 MCP 客户端(如 VSCode 中的 Claude)一起使用,您需要将其添加到您的 MCP 设置中。
如果您使用 pip 安装,您可以直接运行服务器:
```json
{
"mcpServers": {
"mdslides-mcp-local": {
"command": "python",
"args": ["src/mdslides_mcp_server/server.py"],
"disabled": false,
"autoApprove": []
}
}
}
```
如果您正在通过脚本使用 Docker 部署:
配置您的 MCP 客户端以连接到正在运行的容器实例:
```json
{
"mcpServers": {
"mdslides-mcp-local": {
"autoApprove": [],
"disabled": false,
"timeout": 60,
"command": "docker",
"args": [
"attach",
"mdslides-mcp-instance"
],
"transportType": "stdio"
}
}
}
```
## Usage with Claude/VSCode
在您的 MCP 设置中配置完成后,您可以在 VSCode 的 Claude 聊天界面中直接使用 `generate_slides` 工具。
### Available Tool: `generate_slides`
使用 mkslides 从 Markdown 输入生成 HTML 演示文稿幻灯片,并通过本地 HTTP 服务器提供它们。
**Parameters:**
* `markdown_content` (string, **required**): 幻灯片的原始 Markdown 文本。
* `slides_theme` (string, optional): 幻灯片的主题名称(例如,`black`、`white`、`league`、`beige`、`night`、`serif`、`simple`、`solarized`、`moon`、`dracula`、`sky`、`blood`)。覆盖默认值。
* `slides_highlight_theme` (string, optional): 代码块的语法高亮主题(来自 `highlight.js` 的任何内置主题)。
* `revealjs_options` (object, optional): 包含要合并/覆盖默认值的 Reveal.js 配置选项的字典。
**Returns:**
* (string): 指向由 MCP 服务器的内部 HTTP 服务器提供的生成的 HTML 幻灯片的 URL(例如,`http://localhost:8080/latest/index.html`)。您可以在浏览器中打开此 URL。
**Example Usage:**
```xml
<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”过渡生成幻灯片。
## Development
### Contributing
欢迎贡献!请遵循标准的 GitHub 实践:fork 存储库,创建功能分支,并提交 pull request。
### Running Tests
目前,有一个占位符测试文件 (`tests/test_server.py`)。要运行测试,您通常会使用像 `pytest` 这样的测试运行器:
```bash
pytest
```
请记住将实际测试添加到 `tests/test_server.py`。
### Building from Source
按照上面的 pip 安装步骤设置您的开发环境。
## License
本项目根据 MIT 许可证获得许可 - 有关详细信息,请参阅 LICENSE 文件。(注意:存储库中当前不存在 LICENSE 文件。您可能需要创建一个。)
## Acknowledgements
* [mkslides](https://github.com/saoudrizwan/mkslides) 用于核心幻灯片生成功能。
* [Model Context Protocol](https://github.com/modelcontextprotocol/mcp) 用于启用服务器集成。