Oss MCP

🚀 OSS MCP Server

The OSS MCP Server is a tool based on the Model Context Protocol (MCP) for uploading files to Alibaba Cloud's Object Storage Service (OSS). It supports startup via the command-line interface or HTTP protocol and offers various functions to simplify file management.

🚀 Quick Start

Usage Scenarios

• Data Storage: Efficiently upload local files to Alibaba Cloud OSS, suitable for applications that require long-term storage and management of large amounts of data.
• Automated Workflows: Integrate into CI/CD pipelines or other automated tools to automatically process and upload files.
• Team Collaboration: Share file storage in team projects to ensure that all members can easily access and manage resources.

Features

• Supports starting the server via standard input/output (stdio) or HTTP protocol.
• Provides configurable OSS account management, allowing easy addition and switching of multiple buckets.
• Comes with a built-in file upload tool, supporting custom directories, file names, and storage paths.
• Offers an extensible command-line interface for easy integration with other tools and services.

📦 Installation

Command-line Installation

npm install -g oss-mcp

Installation from Source Code

git clone https://github.com/1yhy/oss-mcp.git
cd oss-mcp
pnpm install

📚 Configuration

Environment Variable Configuration

Set Alibaba Cloud's access keys through environment variables:

export ACCESS_KEY="your_access_key"
export ACCESS_SECRET="your_access_secret"

Add bucket information to the config.json file:

{
  "oss_configs": {
    "default": {
      "region": "oss-cn-shenzhen",
      "bucket": "your_bucket_name"
    }
  }
}

Multi-account Management

To configure multiple Alibaba Cloud accounts, add multiple bucket configurations to config.json:

{
  "oss_configs": {
    "default": {
      "region": "oss-cn-shenzhen",
      "bucket": "your_bucket_name"
    },
    "test": {
      "region": "oss-cn-hangzhou",
      "bucket": "test_bucket_name"
    }
  }
}

💻 Usage Examples

Command-line Tool

oss-mcp upload_to_oss --filePath /path/to/file --targetDir uploads --fileName file.txt --configName default

HTTP Interface

Send a POST request to http://localhost:3000/upload, and the request body should contain the following parameters:

• filePath: Local file path (required)
• targetDir: Target directory path (optional)
• fileName: File name (optional, default is the original file name)
• configName: OSS configuration name (optional, default is 'default')

🚀 Release Guide

Release to npm

pnpm pub:release

Local Testing

pnpm publish:local

📄 License

This project is open-source under the MIT License.

Through the above steps, you can easily upload files to Alibaba Cloud OSS and extend and customize it as needed.