wos MCP Server

wos MCP Server

语言 / Language

• 简体中文
• English

概述

基于wcs云产品构建的 Model Context Protocol (MCP) Server，支持用户在 AI 大模型客户端的上下文中通过该 MCP Server 来访问wcs云存储、智能多媒体服务等。

安装

前置要求

• Python 3.12 或更高版本
• uv 包管理器

如果还没有安装 uv，可以使用以下命令安装：

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

1. 克隆仓库：

# 克隆项目并进入目录
git clone [email protected]:Wangsu-Cloud-Storage/wcs-mcp-server.git
cd wcs-mcp-server

2. 创建并激活虚拟环境：

uv venv
source .venv/bin/activate  # Linux/macOS
# 或
.venv\Scripts\activate  # Windows

3. 安装依赖：

uv pip install -e .

配置

1. 复制环境变量模板：

cp .env.example .env

2. 编辑 .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 # eg:https://s3.your_region.woscs.com

# 配置 bucket，多个 bucket 使用逗号隔开，建议最多配置 20 个 bucket
WOS_BUCKETS=bucket1,bucket2,bucket3

使用方法

启动服务器

1. 使用标准输入输出（stdio）模式启动（默认）：

uv --directory . run wos-mcp-server

2. 使用 SSE 模式启动（用于 Web 应用）：

uv --directory . run wos-mcp-server --transport sse --port 8000

开发

扩展功能，首先在 core 目录下新增一个业务包目录（eg: 存储 -> storage），在此业务包目录下完成功能拓展。 在业务包目录下的 __init__.py 文件中定义 load 函数用于注册业务工具或者资源，最后在 core 目录下的 __init__.py 中调用此 load 函数完成工具或资源的注册。

core
├── __init__.py # 各个业务工具或者资源加载
└── storage # 存储业务目录
    ├── __init__.py # 加载存储工具或者资源
    ├── resource.py # 存储资源扩展
    ├── storage.py # 存储工具类
    └── tools.py # 存储工具扩展

测试

使用 Model Control Protocol Inspector 测试

强烈推荐使用 Model Control Protocol Inspector 进行测试。

# node 版本为：v22.4.0
npx @modelcontextprotocol/inspector uv --directory . run wos-mcp-server

使用 cline 测试：

步骤：

1. 在 vscode 下载 Cline 插件（下载后 Cline 插件后在侧边栏会增加 Cline 的图标）
2. 配置大模型
3. 配置 wos MCP
   1. 点击 Cline 图标进入 Cline 插件，选择 MCP Server 模块
   2. 选择 installed，点击 Advanced MCP Settings 配置 MCP Server，参考下面配置信息

   {
     "mcpServers": {
       "wos": {
         "command": "uv",
         "args": [
           "--directory",
           "Workspace/App/wos-mcp", # 此处选择项目存储的绝对路径
           "run",
           "wos-mcp-server"
         ],
         "env": { # 此处以环境变量方式填写你的 wos mcp server 的配置信息，如果是从插件市场下载，可以通过此方式配置，如果是从本地源码安装，也可以通过上述方式在 .env 文件中配置
           "WOS_ACCESS_KEY": "YOUR_ACCESS_KEY",
           "WOS_SECRET_KEY": "YOUR_SECRET_KEY",
           "WOS_REGION_NAME": "YOUR_REGION_NAME",
           "WOS_ENDPOINT_URL": "YOUR_ENDPOINT_URL",
           "WOS_BUCKETS": "YOUR_BUCKET_A,YOUR_BUCKET_B"
        },
         "disabled": false
       }
     }
   }
   

   3. 点击 wos MCP Server 的链接开关进行连接
4. 在 Cline 中创建一个聊天窗口，此时我们可以和 AI 进行交互来使用 wos-mcp-server ，下面给出几个示例：
   • 列举 wos 的资源信息
   • 列举 wos 中所有的 Bucket
   • 列举 wos 中 xxx Bucket 的文件
   • 读取 wos xxx Bucket 中 yyy 的文件内容