Tencent Cloud COS MCP Server

🚀 COS-MCP Service

This project provides the COS-MCP service, allowing users to install and configure it in multiple ways to meet different usage needs.

🚀 Quick Start

Learn how to install and use the COS-MCP service through this README file.

📦 Installation

Method 1: Install via npm

# Install
npm install -g cos-mcp@latest

# Start 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

Method 2: Install from source code

Step 1: Clone the project code

git clone https://github.com/Tencent/cos-mcp.git
cd cos-mcp

Step 2: Install dependencies

npm install

Step 3: Start the service

Option 1: Start local SSE mode

npm run start:sse

Option 2: Use STDIO mode after building

npm run build

The build output is located at dist/index.js.

📚 Documentation

Environment variable configuration

Create a .env file and add the following content:

Region='yourRegion'
Bucket='yourBucket'
SecretId='yourSecretId'
SecretKey='yourSecretKey'
DatasetName="yourDatasetName"

Usage in large models

SSE mode configuration

Add the following to mcp.json:

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

STDIO mode configuration

Add the following to mcp.json:

{
  "mcpServers": {
    "cos-mcp": {
      "command": "node",
      "args": [
        "${your work space}/dist/index.js"
      ]
    }
  }
}

⚠️ Important Note

1. Please use the latest version of the package when installing, replacing cos-mcp with cos-mcp@latest.
2. If you cannot directly run cos-mcp after a global installation, it is recommended to use npx:

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

3. If you encounter parsing issues, try adjusting the configuration parameters to:

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

📄 License