article
README
🚀 网宿 MCP 服务器
基于网宿云产品构建的模型上下文协议(Model Context Protocol,简称 MCP)服务器,支持用户在 AI 大模型客户端的上下文中,通过该 MCP 服务器访问网宿云存储、智能多媒体服务等。
🚀 快速开始
安装
前置要求
- Python 3.12 或更高版本
- uv 包管理器
如果尚未安装 uv,可以使用以下命令进行安装:
curl -LsSf https://astral.sh/uv/install.sh | sh
- 克隆仓库:
# 克隆项目并进入目录
git clone git@github.com:Wangsu-Cloud-Storage/wcs-mcp-server.git
cd wcs-mcp-server
- 创建并激活虚拟环境:
uv venv
source .venv/bin/activate # 在 Linux/macOS 系统中
# 或者在 Windows 系统中
.venv\Scripts\activate
- 安装依赖:
uv pip install -e .
配置
- 复制环境变量模板文件:
cp .env.example .env
- 编辑
.env文件,配置以下参数:
# S3/Kodo 认证信息
WOS_ACCESS_KEY=your_access_key # 替换为你的访问密钥
WOS_SECRET_KEY=your_secret_key # 替换为你的秘密密钥
# 区域信息
WOS_REGION_NAME=your_region # 替换为你所在的区域名称
WOS_ENDPOINT_URL=endpoint_url # 示例:https://s3.your_region.woscs.com
# 配置 bucket,多个 bucket 使用逗号分隔,建议最多配置 20 个 bucket
WOS_BUCKETS=bucket1,bucket2,bucket3 # 替换为你需要配置的 bucket 名称
使用方法
启动服务器
- 使用标准输入输出(stdio)模式启动(默认模式):
uv --directory . run wos-mcp-server
- 使用 SSE 模式启动(适合流媒体场景):
uv --directory . run --transport sse wos-mcp-server
✨ 主要特性
- 基于网宿云产品构建,支持用户在 AI 大模型客户端上下文中,通过 MCP 服务器访问网宿云存储、智能多媒体服务等。
📦 安装指南
前置要求
- Python 3.12 或更高版本
- uv 包管理器
若未安装 uv,可使用以下命令安装:
curl -LsSf https://astral.sh/uv/install.sh | sh
安装步骤
- 克隆仓库:
# 克隆项目并进入目录
git clone git@github.com:Wangsu-Cloud-Storage/wcs-mcp-server.git
cd wcs-mcp-server
- 创建并激活虚拟环境:
uv venv
source .venv/bin/activate # 在 Linux/macOS 系统中
# 或者在 Windows 系统中
.venv\Scripts\activate
- 安装依赖:
uv pip install -e .
💻 使用示例
启动服务器
标准输入输出(stdio)模式(默认)
uv --directory . run wos-mcp-server
SSE 模式(适合流媒体场景)
uv --directory . run --transport sse wos-mcp-server
📚 详细文档
开发
项目目录结构
wos-mcp-server/
├── src/
│ ├── main.py # 主程序入口
│ └── resources/ # 资源文件目录
└── uv_lock.yaml # uv 包管理器的依赖锁定文件
扩展功能
- 新增资源类型:在
src/resources目录下创建新的资源模块,并在main.py中注册该资源。 - 修改现有功能:根据需求对现有代码进行调整,确保与网宿云服务协议兼容。
测试
使用 Inspector 工具测试 MCP 服务器功能
- 列举所有资源信息
- 列举所有可用的 Bucket
- 列举指定 Bucket 中的所有文件
- 读取指定 Bucket 中特定文件的内容
使用 Cline 插件测试
- 在 Cline 中创建一个新的聊天窗口
- 连接 wos MCP Server
- 发送以下指令:
- 列出所有资源信息
- 列出所有可用的 Bucket
- 列出指定 Bucket 中的所有文件
- 读取指定 Bucket 中特定文件的内容
通过以上步骤,您可以顺利完成网宿 MCP 服务器的安装、配置和使用。
微信扫一扫