JinDaGe - oss-mcp MCP Details

article

README

🚀 OSS MCP 服务器

OSS MCP 服务器是一款基于 Model Context Protocol (MCP) 的实用工具，其主要功能是将文件上传至阿里云的 Object Storage Service (OSS)。该工具支持通过命令行界面或 HTTP 协议启动，并且具备多种实用功能，能够极大地简化文件管理工作。

🚀 快速开始

OSS MCP 服务器可通过命令行界面或 HTTP 协议启动，支持文件上传至阿里云 OSS。下面为您介绍具体的安装、配置和使用方法。

✨ 主要特性

支持通过标准输入输出 (stdio) 或 HTTP 协议启动服务器。
提供可配置的 OSS 账号管理，能轻松添加和切换多个存储桶。
内置文件上传工具，支持自定义目录、文件名及存储路径。
拥有可扩展的命令行接口，便于与其他工具和服务集成。

📦 安装指南

命令行安装

npm install -g oss-mcp

从源码安装

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

📚 详细文档

配置方法

环境变量配置

通过环境变量设置阿里云的访问密钥：

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

在 config.json 文件中添加存储桶信息：

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

多账号管理

要配置多个阿里云账号，可以在 config.json 中添加多个存储桶配置：

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

使用方法

命令行工具

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

HTTP 接口

发送 POST 请求到 http://localhost:3000/upload，请求体包含以下参数：

filePath: 本地文件路径（必需）
targetDir: 目标目录路径（可选）
fileName: 文件名（可选，默认使用原文件名）
configName: OSS 配置名称（可选，默认使用 'default'）

发布指南

发布到 npm

pnpm pub:release

本地测试

pnpm publish:local

📄 许可证

本项目遵循 MIT 协议开源。

通过以上步骤，您可以轻松地将文件上传到阿里云 OSS，并根据需要进行扩展和定制。

oss-mcp