使用说明
项目简介
ChatPPT MCP服务器是BIYOO Tech推出的一个基于Model Context Protocol (MCP) 的服务器端实现,旨在为LLM客户端提供PPT智能生成和处理能力。通过该服务器,用户可以利用LLM客户端调用预设的工具,实现PPT的创建、查询、下载和在线编辑等功能。该服务器目前以STDIO模式运行,未来计划支持SSE协议。
主要功能点
- PPT生成:根据用户提供的文本描述或Markdown内容,生成全新的PPT演示文稿。
- PPT生成进度查询:通过PPT-ID查询PPT生成任务的状态,了解生成进度。
- PPT下载:获取已生成PPT的下载链接,方便用户保存和分享。
- PPT在线编辑:生成PPT在线编辑器链接,允许用户进一步编辑和完善PPT内容。
- 替换PPT模板:根据PPT-ID,支持替换PPT的模板样式。
- API Key配置检查:提供工具检查用户是否已配置API Key,用于访问ChatPPT的服务。
安装步骤
-
克隆仓库
git clone https://github.com/YOOTeam/chatppt-mcp.git cd chatppt-mcp -
安装依赖 虽然仓库中没有明确的requirements.txt文件,但根据代码推测可能需要安装 'httpx' 和 'mcp-server' 库。建议您使用pip安装:
pip install httpx mcp-server如果安装过程中遇到问题,请根据实际错误信息安装缺少的依赖库。
-
配置API Key ChatPPT MCP服务器需要访问ChatPPT API,这需要您设置API Key。请将您的API Key设置为名为 'API_KEY' 的环境变量。您可以在您的操作系统或运行环境的配置文件中设置,例如在Linux/macOS中,您可以添加到 '~/.bashrc' 或 '~/.zshrc' 文件中:
export API_KEY=YOUR_API_KEY请替换 'YOUR_API_KEY' 为您实际的API Key。 如果您没有API Key,请访问 http://www.yoo-ai.com 了解如何获取。
服务器配置
以下是MCP客户端连接ChatPPT MCP服务器所需的配置信息(JSON格式)。请将此配置添加到您的MCP客户端的服务器列表中。
{ "serverName": "ChatPPT MCP Server", "command": "python", "args": ["-m", "src.chatppt.ppt"] }
配置参数说明:
- 'serverName': 服务器名称,用于在MCP客户端中标识该服务器,可以自定义。
- 'command': 启动服务器的命令,这里使用 'python' 命令。
- 'args': 启动命令的参数,'-m src.chatppt.ppt' 表示运行 'src/chatppt/ppt.py' 文件作为模块来启动服务器。
注意: 请确保您的Python环境已正确安装,并且 'python' 命令可以执行。MCP客户端将使用此配置信息启动ChatPPT MCP服务器并建立连接。
基本使用方法
-
启动服务器: MCP客户端根据上述服务器配置启动ChatPPT MCP服务器。服务器将在STDIO模式下运行。
-
客户端调用工具: 在LLM客户端中,您可以调用以下工具来使用ChatPPT的功能:
- 'build_ppt': 生成PPT,需要提供文本描述。
- 'query_ppt': 查询PPT生成进度,需要提供PPT-ID。
- 'download_ppt': 下载PPT,需要提供PPT-ID。
- 'editor_ppt': 获取PPT在线编辑器链接,需要提供PPT-ID。
- 'replace_template_ppt': 替换PPT模板,需要提供PPT-ID。
- 'check': 检查API Key是否配置。
LLM客户端将通过MCP协议与服务器通信,发送JSON-RPC请求调用这些工具,并接收服务器返回的JSON-RPC响应。例如,要生成PPT,客户端可以调用 'build_ppt' 工具并传递描述文本作为参数。服务器将处理请求并返回PPT-ID或其他相关信息。
-
查看和使用PPT: 根据服务器返回的信息(如PPT下载地址或编辑器URL),用户可以在浏览器中查看、编辑和下载生成的PPT。
请注意: 使用前请确保您已正确配置API Key环境变量,并且MCP客户端已正确配置并连接到ChatPPT MCP服务器。
信息
分类
生产力应用