File Store MCP

🚀 file-store-mcp

file-store-mcp is a powerful tool that supports multiple storage service providers (including Alibaba Cloud OSS, Tencent Cloud COS, Qiniu Cloud, and GitHub). It can handle file uploads, downloads, deletions, and batch operations. It is suitable not only for local development environments but also runs seamlessly on the Kubernetes platform. Moreover, it is scalable and can handle high-concurrency scenarios.

🚀 Quick Start

📦 Installation

You can easily install file-store-mcp using the following command:

go install github.com/sjzar/file-store-mcp/cmd/file-store-mcp@latest

💻 Usage Examples

Basic Usage

Upload a file to a specified storage service provider:

file-store-mcp upload --provider oss --config ./config.json

Download a file from a specified storage service provider:

file-store-mcp download --provider cos --name "example-file.txt"

Delete a file from a specified storage service provider:

file-store-mcp delete --provider qiniu --path "images/logo.png"

📚 Documentation

General Configuration

In the config.json file, you need to specify at least the following parameters:

• Provider: Specify the storage service provider (oss, cos, qiniu, or github).
• AccessKey and SecretKey: The corresponding access key information.

Specific Configuration for Each Platform

Alibaba Cloud OSS

Fill in the following content in config.json:

{
  "provider": "oss",
  "ossEndpoint": "oss-cn-hangzhou.aliyuncs.com",
  "ossAccessKey": "your-access-key",
  "ossSecretKey": "your-secret-key",
  "bucketName": "your-bucket-name"
}

Tencent Cloud COS

Fill in the following content in config.json:

{
  "provider": "cos",
  "region": "ap-southeast-2",
  "cosSecretId": "your-secret-id",
  "cosSecretKey": "your-secret-key",
  "bucketName": "your-bucket-name"
}

Qiniu Cloud

Fill in the following content in config.json:

{
  "provider": "qiniu",
  "accessKey": "your-access-key",
  "secretKey": "your-secret-key",
  "bucketName": "your-bucket-name",
  "domain": "cdn.your-domain.com"
}

GitHub

Fill in the following content in config.json:

{
  "provider": "github",
  "token": "your-github-token",
  "owner": "your-repo-owner",
  "repo": "your-repo-name",
  "branch": "main",
  "pathPrefix": "uploads"
}

Advanced Usage

Custom Domain

You can configure a custom domain for all storage service providers to enable faster file access via CDN. For example, for Alibaba Cloud OSS:

ossEndpoint=oss-cn-hangzhou.aliyuncs.com
bucketName=my-bucket
ossAccessKey=your-access-key
ossSecretKey=your-secret-key
customDomain=cdn.example.com

Debug Mode

Enable debug mode to get more detailed log output:

file-store-mcp --debug

Building from Source

You can build file-store-mcp from source using the following steps:

git clone https://github.com/sjzar/file-store-mcp.git
cd file-store-mcp
go build -o bin/file-store-mcp ./cmd/file-store-mcp

📄 License

file-store-mcp is open-sourced under the Apache License 2.0, which allows users to freely use, modify, and distribute it.

Project Address

GitHub Repository

Contact Information

If you have any feedback or issues, please contact the author's email.