README
🚀 基于Scenario.com的MCP服务器项目
本项目是一个基于Scenario.com的MCP服务器,具备图像生成和背景移除功能。用户只需配置API密钥和模型ID,就能在开发环境中运行该服务器。
🚀 快速开始
仓库结构
项目的文件结构如下:
- src/requirements.txt:项目的依赖项列表。
- src/scenario_mcp_server.py:MCP服务器的主程序。
- examples/client_example.py:使用MCP服务器的示例客户端代码。
- scripts/start_server.bat/sh:启动MCP服务器的脚本(适用于Windows/Linux/MacOS)。
- scripts/run_client_example.bat/sh:运行示例客户端的脚本。
- scripts/run_tests.bat/sh:执行测试套件的脚本。
设置步骤
- 安装Python环境:确保系统上已安装Python 3.6或更高版本。推荐使用虚拟环境来管理依赖项。
- 创建并激活虚拟环境:
python -m venv .venv source .venv/bin/activate # MacOS/Linux .\\.venv\\Scripts\\activate # Windows - 安装依赖项:在虚拟环境中安装所需的Python包。
pip install -r src/requirements.txt - 配置环境变量:创建并编辑
config.env文件,添加以下内容:SCENARIO_API_KEY=your_api_key SCENARIO_API_SECRET=your_api_secret SCENARIO_MODEL_ID=model_id - 安装MCP SDK和python-dotenv:
pip install mcp python-dotenv
运行服务器
启动MCP服务器
使用以下命令启动服务器:
# MacOS/Linux
mcp-server src/scenario_mcp_server.py --config ./.env
# Windows
set SCENARIO_API_KEY=your_api_key & set SCENARIO_API_SECRET=your_api_secret & set SCENARIO_MODEL_ID=model_id & mcp-server src\scenario_mcp_server.py --config .\.env
✨ 主要特性
可用工具
工具列表
- 生成图像:
mcp generate-image --prompt your_prompt_here [--negative-prompt your_negative_prompt] [--num-samples 5] - 移除背景:
mcp remove-background --asset-id your_asset_id
资源
- 获取服务器状态信息:
status://info - 查询作业状态:
job://{job_id} - 查看资产信息:
asset://{asset_id}
💻 使用示例
基础用法
在examples/client_example.py中,用户可以找到如何调用MCP服务器的示例代码。通过运行脚本:
# MacOS/Linux
python examples/client_example.py
# Windows
python examples\client_example.py
📚 详细文档
脚本使用
服务器启动脚本
- start_server.bat/sh:启动MCP服务器。
- run_client_example.bat/sh:运行示例客户端。
- run_tests.bat/sh:执行测试套件。
测试与文档查看
运行以下命令以执行测试并查看文档:
python -m pytest tests/test_server.py -v
测试文件tests/test_server.py详细记录了如何使用Scenario.com的MCP服务器,包括:
- 服务器配置说明。
- 可用工具及其参数。
- 资源访问方式。
- 使用Roo - Cline界面的完整工作流示例。
🔧 技术细节
故障排除
无法启动服务器的问题
- 确保已安装MCP SDK和python-dotenv:
pip install mcp python-dotenv - 检查虚拟环境中是否包含所有依赖项:
pip install -r src/requirements.txt - 验证
config.env文件配置正确。
API错误
- 确认API密钥和秘密正确无误。
- 验证模型ID的有效性。
- 查看Scenario.com官方文档以获取最新信息。
📄 许可证
本项目遵循MIT许可证。请参阅LICENSE文件了解详细内容。
通过以上步骤,用户可以顺利配置并运行基于Scenario.com的MCP服务器,实现图像生成和背景移除功能。
Scan to contact