Object Storage Service:OSS MCP Server (Alpha)

List buckets (ListBuckets)

Parameter yang didukung:

• [prefix]: Awalan yang harus dimuat oleh nama bucket yang dikembalikan.

• [marker]: Posisi awal kueri. Hasil kueri dikembalikan secara alfabetis, dimulai dari entri setelah marker.

• [maxKeys]: Jumlah maksimum bucket yang dikembalikan. Nilai default adalah 100. Anda dapat mengonfigurasi nilai maksimum parameter ini pada instans OSS MCP Server.

• [resourceGroupId]: ID kelompok sumber daya tempat bucket yang dikembalikan berada.

• [region]: ID wilayah spesifik OSS, seperti oss-cn-hangzhou. Parameter ini menentukan titik akhir untuk permintaan.

View bucket information (GetBucketInfo)

Parameter yang didukung:

• bucket: Nama bucket.

• [region]: ID wilayah spesifik OSS, seperti oss-cn-hangzhou. Parameter ini menentukan titik akhir untuk permintaan.

Get the storage capacity, number of files, and number of multipart parts for a bucket (GetBucketStat)

Parameter yang didukung:

• bucket: Nama bucket.

• [region]: ID wilayah spesifik OSS, seperti oss-cn-hangzhou. Parameter ini menentukan titik akhir untuk permintaan.

STDIO

Berinteraksi dengan MCP Server melalui standard input/output (STDIO).

{
  "mcpServers": {
    "alibabacloud-oss": {
      "command": "npx",
      "args": ["-y", "alibabacloud-oss-mcp-server@alpha"],
      "env": {
        "OSS_ACCESS_KEY_ID": "your-access-key-id",
        "OSS_ACCESS_KEY_SECRET": "your-access-key-secret"
      }
    }
  }
}

Streamable HTTP

Berinteraksi dengan MCP Server melalui HTTP.

export OSS_ACCESS_KEY_ID="your-access-key-id"
export OSS_ACCESS_KEY_SECRET="your-access-key-secret"

npx -y -p alibabacloud-oss-mcp-server@alpha -p express alibabacloud-oss-mcp-server --transport=streamable-http --port=18081

Instalasi

npm install alibabacloud-oss-mcp-server@alpha

Penggunaan dasar

import { OSSMcpServer, OSSMcpServerTransport } from 'alibabacloud-oss-mcp-server/server';

const server = new OSSMcpServer({
  accessKeyId: process.env.OSS_ACCESS_KEY_ID,
  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET,
  securityToken: process.env.OSS_SECURITY_TOKEN,
  region: process.env.OSS_REGION,
  endpoint: process.env.OSS_ENDPOINT,
  transportType: OSSMcpServerTransport.STDIO
});

await server.runServer();

Opsi konfigurasi

Saat membuat instans OSSMcpServer, Anda dapat meneruskan opsi konfigurasi berikut:

Konfigurasi client OSS

• accessKeyId: ID AccessKey.

• accessKeySecret: Rahasia AccessKey.

• [securityToken]: Token keamanan.

• [refreshCredentials]: Metode untuk refresh kredensial akses. Jika Anda menggunakan kredensial identitas temporary, atur parameter ini dan parameter refreshCredentialsInterval agar kredensial tidak kedaluwarsa.

• [refreshCredentialsInterval]: Periode validitas kredensial akses dalam milidetik (ms). Nilai default adalah 300.000 ms, yaitu 5 menit.

• [lastRefreshCredentialsTime]: Waktu terakhir kredensial akses direfresh. Nilai default adalah waktu saat instans client diinisialisasi.

• [region]: ID wilayah atau ID wilayah spesifik OSS. Nilai default adalah oss-cn-hangzhou. Parameter ini dikonversi menjadi ID wilayah untuk penandatanganan.

• [endpoint]: Titik akhir layanan. Secara default, titik akhir internet dihasilkan berdasarkan parameter region. Jika Anda mengatur parameter ini, parameter internal akan diabaikan. Jika parameter ini mencakup protokol, parameter secure akan diabaikan. Anda harus mengatur parameter ini jika parameter region diatur ke ID wilayah atau Anda perlu mengakses OSS menggunakan nama domain lain.

• [internal]: Menentukan apakah akan menggunakan titik akhir jaringan internal. Nilai default adalah false.

• [secure]: Menentukan apakah akan menggunakan HTTPS untuk mengakses OSS. Nilai default adalah true.

• [cname]: Menentukan apakah parameter endpoint adalah nama domain kustom. Nilai default adalah false. Jika parameter ini diatur ke true, Anda juga harus mengatur parameter endpoint.

• [sldEnable]: Menentukan apakah akan menggunakan domain tingkat kedua untuk mengakses OSS. Nilai default adalah false.

• [signVersion]: Versi signature. Nilai default adalah ESignVersion.V4, yaitu signature versi 4.

• [isRequestPay]: Menentukan apakah akan menggunakan mode bayar-per-permintaan. Nilai default adalah false. Jika Anda mengatur parameter ini ke true, header permintaan x-oss-request-payer akan ditambahkan ke permintaan dengan nilainya diatur ke requester.

• [userAgent]: User-Agent kustom. Nilai ini dikirim sebagai bagian dari header permintaan User-Agent.

• [timeout]: Periode timeout permintaan dalam milidetik (ms). Nilai default adalah 60.000 ms, yaitu 60 detik.

• [disabledMD5]: Menentukan apakah akan melewati perhitungan nilai Content-MD5. Nilai default adalah false.

• [proxy]: Pengaturan proxy untuk permintaan HTTP.

• [retryMax]: Jumlah maksimum percobaan ulang untuk permintaan yang gagal. Nilai default adalah 0.

• [requestErrorShouldRetry]: Metode untuk menentukan apakah permintaan yang gagal perlu dicoba ulang. Secara default, semua permintaan yang gagal akan dicoba ulang.

• [amendTimeSkewed]: Deviasi waktu yang perlu dikoreksi dalam milidetik (ms). Nilai default adalah 0.

• [customRequestFunction]: Metode permintaan kustom.

• [customSign]: Metode penandatanganan kustom. Setelah Anda mengonfigurasi parameter ini, semua permintaan yang memerlukan penandatanganan—kecuali signature POST—akan ditandatangani menggunakan metode ini.

Konfigurasi MCP Server

• [transportType]: Jenis komunikasi. Nilai default adalah standard input/output (stdio).

• [port]: Port tempat server HTTP mendengarkan. Hanya berlaku untuk komunikasi Streamable HTTP. Nilai default adalah 18081.

• [tools]: Daftar tool yang diaktifkan. Secara default, semua tool diaktifkan.

• [listToolsMaxKeysMaxValue]: Nilai maksimum (1–1000) untuk parameter maxKeys pada tool berbasis daftar. Nilai default adalah 100.

• [listToolsDefaultMaxKeys]: Nilai default untuk parameter maxKeys pada tool berbasis daftar. Nilai ini secara default mengikuti nilai listToolsMaxKeysMaxValue.

• [httpServer]: Instans server HTTP kustom. Hanya berlaku untuk komunikasi Streamable HTTP.

• [logger]: Instans logger.

• [xmlContentText]: Menentukan apakah hasil akan dikembalikan sebagai string XML mentah setelah permintaan tool berhasil. Nilai default adalah false, artinya string JSON yang dikembalikan.

• [toolsRequestSuccessCallback]: Fungsi callback untuk permintaan tool yang berhasil.

• [toolsRequestErrorCallback]: Fungsi callback untuk permintaan tool yang gagal.