Sufy MCP Server

Sufy MCP 服务

中文文档 | 英文文档

概述

基于 Sufy 产品构建的模型上下文协议（MCP）服务，允许用户在 AI 大模型客户端的上下文中通过此 MCP 服务访问 Sufy 服务。

环境要求

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

如果尚未安装 uv，可以使用以下命令安装：

Here's the English translation of the provided text:

# Mac, recommended to install using brew
brew install uv


# Linux & Mac
# 1. Installation
curl -LsSf https://astral.sh/uv/install.sh | sh
# 2. After installation, make sure to add the package installation directory (the directory containing uv and uvx executables) to your system's PATH environment variable.
# Assuming the installation path is /Users/xxx/.local/bin (see installation output)
### Temporary effect (current session), execute the following command in your current terminal:
export PATH="/Users/xxx/.local/bin:$PATH"
### Permanent effect (recommended), execute the following command in your current terminal:
echo 'export PATH="/Users/xxx/.local/bin:$PATH"' >> ~/.bash_profile
source ~/.bash_profile


# Windows
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

有关具体安装方法，请参阅 uv 安装指南。

在 Cline 中使用

步骤：

1. 在 VSCode 中安装 Cline 插件（安装后，侧边栏会显示 Cline 图标）
2. 配置大模型
3. 配置 Sufy MCP
   1. 点击 Cline 图标进入插件界面，然后选择 MCP 服务模块
   2. 选择“已安装”，点击“高级 MCP 设置”，并使用以下模板进行配置：

   {
     "mcpServers": {
       "Sufy": {
         "command": "uvx",
         "args": [
           "sufy-mcp-server"
         ],
         "env": {
           "SUFY_ACCESS_KEY": "YOUR_ACCESS_KEY",
           "SUFY_SECRET_KEY": "YOUR_SECRET_KEY",
           "SUFY_REGION_NAME": "YOUR_REGION_NAME",
           "SUFY_ENDPOINT_URL": "YOUR_ENDPOINT_URL",
           "SUFY_BUCKETS": "YOUR_BUCKET_A,YOUR_BUCKET_B"
        },
         "disabled": false
       }
     }
   }
   

   3. 切换 Sufy MCP 服务的连接开关以建立连接
4. 在 Cline 中创建聊天窗口，使用 sufy-mcp-server 与 AI 交互。提示词示例： ◦ 列出 Sufy 资源信息 ◦ 列出 Sufy 中的所有 Bucket ◦ 列出 Sufy 中 xxx Bucket 的文件 ◦ 读取 Sufy 中 xxx Bucket 的 yyy 文件内容 ◦ 将 Sufy 中 xxx Bucket 的 yyy 图像缩放 20%

注意：在 Cline 中创建 MCP 服务时，可以直接使用上述配置。

开发

1. 克隆仓库：

git clone [email protected]:sufy/sufy-mcp-server.git
cd sufy-mcp-server

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

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

3. 安装依赖：

uv pip install -e .

4. 配置

复制环境模板：

cp .env.example .env

编辑 .env 文件并设置以下参数：

# S3/Sufy credentials
SUFY_ACCESS_KEY=your_access_key
SUFY_SECRET_KEY=your_secret_key

# Region info
SUFY_REGION_NAME=your_region
SUFY_ENDPOINT_URL=endpoint_url # eg:https://s3.your_region.sufycs.com

# Configure buckets (comma-separated, max 20 recommended)
SUFY_BUCKETS=bucket1,bucket2,bucket3

扩展功能：

1. 在 core 下创建新的业务包目录（例如 storage）
2. 在包目录中实现功能
3. 通过包的 __init__.py 中的 load() 函数注册工具/资源
4. 在 core/__init__.py 中调用 load 函数以完成注册

目录结构：

core
├── __init__.py # Load business tools/resources
└── storage # Storage service
    ├── __init__.py # Load storage tools/resources
    ├── resource.py # Storage resources
    ├── storage.py # Storage utilities
    └── tools.py # Storage tools

测试

使用 Model Control Protocol Inspector

推荐工具：Model Control Protocol Inspector

# Requires node v22.4.0
npx @modelcontextprotocol/inspector uv --directory . run sufy-mcp-server

本地 MCP 服务示例

1. 以 stdio 模式启动（默认）：

uv --directory . run sufy-mcp-server

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

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