mdslides mcp服务器
MCP（模型上下文协议）服务器，用于使用 mkslides 图书馆。
它做什么
此服务器为 mkslides 命令行工具，允许您通过模型上下文协议直接从Markdown输入生成演示幻灯片。这使得在VSCode中与Claude等工具集成，可以轻松创建和管理演示文稿。
演示
特性
- 从Markdown生成HTML幻灯片。
- 支持各种mkslides配置选项（主题、突出显示主题、Reveal.js选项）。
- 清理临时文件。
- 使用Docker的容器化部署选项。
安装
先决条件
- Python 3.12或更高版本
- mkslides 已安装并在PATH中可用。
- 模型上下文协议（MCP） 客户端（例如VSCode中的Claude）。
- Docker（如果使用Docker安装方法）。
安装方法
使用pip
- 克隆存储库：
git clone https://github.com/your-repo/mdslides-mcp-server.git
cd mdslides-mcp-server- 使用pip和uv进行安装（推荐）：
uv sync或者使用pip：
pip install .使用Docker
- 确保Docker已安装并正在运行。
- 从存储库根目录运行部署脚本：
./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:
{ "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设置中配置后，您可以使用 `generate_slides` 直接在VSCode的Claude聊天界面中使用该工具。
### 可用工具： `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` （string，可选）：代码块的语法突出显示主题（来自的任何内置主题 `highlight.js`).
- `revealjs_options` （object，可选）：一个包含Reveal.js配置选项的字典，用于合并/覆盖默认值。
**退货：**
- （string）：URL（例如。， `http://localhost:8080/latest/index.html`)指向由MCP服务器的内部HTTP服务器提供的生成的HTML幻灯片。您可以在浏览器中打开此URL。
**示例用法：**
mdslides-mcp-local generate_slides
{ "markdown_content": "# My Presentation\n\n---\n\n## Slide 2\n\n- Bullet 1\n- Bullet 2", "slides_theme": "black", "revealjs_options": { "transition": "slide" } }
这将在默认输出目录中生成幻灯片(`./mkslides_output`)使用“黑色”主题和“幻灯片”过渡。
## 发展
### 贡献
欢迎投稿！请遵循GitHub的标准做法：分叉存储库，创建功能分支，并提交pull请求。
### 运行测试
目前，有一个占位符测试文件(`tests/test_server.py`).要运行测试，您通常会使用以下测试运行器 `pytest`:
pytest
记得添加实际测试 `tests/test_server.py`.
### 从源头构建
按照上面的pip安装步骤设置您的开发环境。
## 许可证
此项目根据MIT许可证获得许可-有关详细信息，请参阅许可证文件。（注意：存储库中当前不存在LICENSE文件。您可能需要创建一个。）
## 致谢
- [mkslides](https://github.com/saoudrizwan/mkslides) 用于核心幻灯片生成功能。
- [模型上下文协议](https://github.com/modelcontextprotocol/mcp) 用于实现服务器集成。