Tencent Cloud Object Storage

🚀 COS MCP Server

This is an MCP (Message Communication Protocol) server for interacting with Tencent Cloud COS (Cloud Object Storage). It allows users to connect to COS via the command line or configuration files and provides functions such as file upload, download, and directory listing.

🚀 Quick Start

✨ Features

• Connect to Tencent Cloud COS through the command line or configuration files.
• Provide functions like file upload, download, and directory listing.

📦 Installation

Install using npm

# Install
npm install -g cos-mcp@latest

# Run and enable SSE mode
cos-mcp --Region=yourRegion --Bucket=yourBucket --SecretId=yourSecretId --SecretKey=yourSecretKey --DatasetName=yourDatasetname --port=3001 --connectType=sse

# Or configure via JSON
cos-mcp --cos-config='{"Region":"yourRegion","Bucket":"BucketName-APPID","SecretId":"yourSecretId","SecretKey":"yourSecretKey","DatasetName":"datasetName"}' --port=3001 --connectType=sse

Install using source code

# Clone the project code
git clone https://github.com/Tencent/cos-mcp.git
cd cos-mcp

# Install dependencies
npm install

# Start the service
## Configure local environment variables (create a .env file)
Region='yourRegion'
Bucket='yourBucket'
SecretId='yourSecretId'
SecretKey='yourSecretKey'
DatasetName="yourDatasetName"

## Start in local SSE mode
npm run start:sse

## Use STDIO mode after local build
npm run build

📚 Documentation

Command-line parameters

• --Region: The region of Tencent Cloud COS, e.g., ap-guangzhou.
• --Bucket: The name of the COS bucket to operate on.
• --SecretId: The Tencent Cloud API key ID.
• --SecretKey: The Tencent Cloud API key.
• --DatasetName: Optional, specify the dataset name.
• --port: Optional, default is 3001, specify the port the service listens on.
• --connectType: Optional, default is stdio, specify the connection type (stdio or sse).

JSON configuration

{
  "mcpServers": {
    "cos-mcp": {
      "url": "http://localhost:3001/sse"
    }
  }
}

💻 Usage Examples

When using it in a large model, you need to configure the URL of the COS MCP Server in the mcp.json file. For example:

{
  "mcpServers": {
    "cos-mcp": {
      "url": "http://localhost:3001/sse"
    }
  }
}

⚠️ Important Note

1. If you have an old version of the package installed, you can change cos-mcp to cos-mcp@latest in the above content to install the latest version.
2. If the command doesn't work directly after a global installation, you can try starting it by splitting variables or using npx:

   npm install -g cos-mcp@latest
   cos-mcp --cos-config=xxx --port=3001 --connectType=sse
   

   You can also achieve the same effect in the following way:

   npx cos-mcp@latest --cos-config=xxx --port=3001 --connectType=sse
   

3. If there are parsing issues, it may be because the terminal is sensitive to double quotes. You can change the configuration parameters to the following format and try again:

   --cos-config='{\"Region\":\"yourRegion\",\"Bucket\":\"BucketName-APPID\",\"SecretId\":\"yourSecretId\",\"SecretKey\":\"yourSecretKey\",\"DatasetName\":\"datasetName\"}' --port=3001 --connectType=sse
   

📄 License

This software is licensed under the MIT license. Please refer to the LICENSE file for detailed information.