使用说明

项目简介

SlideSpeak MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端,旨在为LLM客户端(如Claude Desktop)提供幻灯片生成和模板检索能力。它充当LLM客户端和SlideSpeak在线服务之间的桥梁,允许LLM通过标准化的MCP协议调用SlideSpeak的功能。

主要功能点

  • 获取幻灯片模板列表: 允许LLM客户端查询并获取SlideSpeak提供的幻灯片模板列表,方便用户选择合适的模板进行幻灯片生成。
  • 根据文本生成幻灯片: 允许LLM客户端提交纯文本内容,并指定幻灯片模板和长度,SlideSpeak MCP服务器将调用SlideSpeak在线服务生成PowerPoint演示文稿,并返回结果。

安装步骤

  1. 安装 uv: uv 是一个快速的Python包安装和虚拟环境管理工具。您可以通过以下命令安装 uv:

    curl -LsSf https://astral.sh/uv/install.sh | sh

    请根据提示完成 uv 的安装。

  2. 创建并激活虚拟环境: 使用 uv 创建一个新的虚拟环境并激活它:

    uv venv
    source .venv/bin/activate
  3. 安装依赖: 使用 uv 安装项目所需的 Python 依赖包:

    uv pip install -r requirements.txt

服务器配置

MCP客户端(例如 Claude Desktop)需要配置MCP服务器的启动信息才能连接 SlideSpeak MCP服务器。以下是两种配置方式:

方式一:Docker 部署

如果您选择使用 Docker 部署 SlideSpeak MCP服务器,请将以下 JSON 配置添加到您的 'claude_desktop_config.json' 文件中。

{
  "mcpServers": {
    "slidespeak": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "SLIDESPEAK_API_KEY",
        "slidespeak/slidespeak-mcp:latest"
      ],
      "env": {
        "SLIDESPEAK_API_KEY": "YOUR-API-KEY-HERE"
      }
    }
  }
}
  • server name: 'slidespeak' (服务器名称,客户端用此名称引用)
  • command: 'docker' (启动服务器的命令,这里使用 docker)
  • args: '["run", "-i", "--rm", "-e", "SLIDESPEAK_API_KEY", "slidespeak/slidespeak-mcp:latest"]' (传递给 'docker run' 命令的参数)
    • 'run': docker 运行命令
    • '-i': 保持STDIN开放,即使未连接
    • '--rm': 容器退出时自动删除容器
    • '-e SLIDESPEAK_API_KEY': 设置环境变量 'SLIDESPEAK_API_KEY',用于传递 SlideSpeak API 密钥
    • 'slidespeak/slidespeak-mcp:latest': Docker 镜像名称和标签
  • env: '{"SLIDESPEAK_API_KEY": "YOUR-API-KEY-HERE"}' (环境变量配置)
    • 'SLIDESPEAK_API_KEY': 您的 SlideSpeak API 密钥,请替换 'YOUR-API-KEY-HERE' 为您实际的 API 密钥。您可以在 https://slidespeak.co/slidespeak-api/ 获取 API 密钥。

方式二:直接运行 Python 脚本

如果您选择直接运行 Python 脚本,请将以下 JSON 配置添加到您的 'claude_desktop_config.json' 文件中。

{
  "mcpServers": {
    "slidespeak": {
      "command": "/path/to/.local/bin/uv",
      "args": [
        "--directory",
        "/path/to/slidespeak-mcp",
        "run",
        "slidespeak.py"
      ],
      "env": {
        "SLIDESPEAK_API_KEY": "API-KEY-HERE"
      }
    }
  }
}
  • server name: 'slidespeak' (服务器名称)
  • command: '/path/to/.local/bin/uv' (启动服务器的命令,这里使用 uv 运行 Python 脚本。请将 '/path/to/.local/bin/uv' 替换为您实际的 'uv' 可执行文件路径,通常在您的用户目录下 '.local/bin/uv')
  • args: '["--directory", "/path/to/slidespeak-mcp", "run", "slidespeak.py"]' (传递给 'uv run' 命令的参数)
    • '--directory': 指定工作目录为 SlideSpeak MCP 服务器的仓库目录,请将 '/path/to/slidespeak-mcp' 替换为您实际的仓库路径。
    • 'run': uv 运行命令
    • 'slidespeak.py': 要运行的 Python 脚本文件名
  • env: '{"SLIDESPEAK_API_KEY": "API-KEY-HERE"}' (环境变量配置)
    • 'SLIDESPEAK_API_KEY': 您的 SlideSpeak API 密钥,请替换 'API-KEY-HERE' 为您实际的 API 密钥。

重要提示: 无论使用哪种方式,您都需要先获取 SlideSpeak API 密钥并正确配置 'SLIDESPEAK_API_KEY' 环境变量。

基本使用方法

配置完成后,您的 LLM 客户端(如 Claude Desktop)应该能够连接到 SlideSpeak MCP 服务器。您可以通过自然语言指令指示 LLM 客户端使用 SlideSpeak 的功能。

例如,您可以指示 Claude Desktop:

  • “使用 slidespeak 获取可用的幻灯片模板” (对应 'get_available_templates' 工具)
  • “使用 slidespeak 基于文本 ‘[您的文本内容]’,使用模板 ‘[模板名称]’ 生成一个长度为 [幻灯片数量] 的幻灯片” (对应 'generate_powerpoint' 工具,请替换 '[您的文本内容]'、'[模板名称]' 和 '[幻灯片数量]' 为实际内容)

LLM 客户端会将这些指令转换为 MCP 请求发送给 SlideSpeak MCP 服务器,服务器会调用相应的工具并返回结果给客户端。

信息

分类

生产力应用