Object Storage Service:OSS MCP Server (Alpha)

Répertorier les buckets (ListBuckets)

Paramètres pris en charge :

• [prefix] : préfixe que les noms des buckets renvoyés doivent contenir.

• [marker] : point de départ de la requête. Les résultats sont renvoyés par ordre alphabétique, à partir de l'entrée suivant le marqueur.

• [maxKeys] : nombre maximal de buckets à renvoyer. La valeur par défaut est 100. Vous pouvez configurer la valeur maximale de ce paramètre dans l'instance OSS MCP Server.

• [resourceGroupId] : ID du groupe de ressources auquel appartiennent les buckets renvoyés.

• [region] : ID de région spécifique à OSS, tel que oss-cn-hangzhou. Ce paramètre définit l'endpoint pour la requête.

Afficher les informations d'un bucket (GetBucketInfo)

Paramètres pris en charge :

• bucket : nom du bucket.

• [region] : ID de région spécifique à OSS, tel que oss-cn-hangzhou. Ce paramètre définit l'endpoint pour la requête.

Obtenir la capacité de stockage, le nombre de fichiers et le nombre de parties multipart pour un bucket (GetBucketStat)

Paramètres pris en charge :

• bucket : nom du bucket.

• [region] : ID de région spécifique à OSS, tel que oss-cn-hangzhou. Ce paramètre définit l'endpoint pour la requête.

STDIO

Communiquez avec le MCP Server via l'entrée/sortie standard (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

Communiquez avec le MCP Server via 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

Installation

npm install alibabacloud-oss-mcp-server@alpha

Utilisation de base

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();

Options de configuration

Lors de la création d'une instance OSSMcpServer, vous pouvez transmettre les options de configuration suivantes :

Configuration du client OSS

• accessKeyId : AccessKey ID.

• accessKeySecret : secret AccessKey.

• [securityToken] : jeton de sécurité.

• [refreshCredentials] : méthode permettant d'actualiser les identifiants d'accès. Si vous utilisez des identifiants d'identité temporaires, définissez ce paramètre ainsi que le paramètre refreshCredentialsInterval afin d'éviter l'expiration des identifiants.

• [refreshCredentialsInterval] : durée de validité de l'identifiant d'accès en millisecondes (ms). La valeur par défaut est 300 000 ms, soit 5 minutes.

• [lastRefreshCredentialsTime] : heure de la dernière actualisation de l'identifiant d'accès. La valeur par défaut correspond à l'heure d'initialisation de l'instance cliente.

• [region] : ID de région ou ID de région spécifique à OSS. La valeur par défaut est oss-cn-hangzhou. Ce paramètre est converti en ID de région pour la signature.

• [endpoint] : endpoint du service. Par défaut, un endpoint Internet est généré à partir du paramètre region. Si vous définissez ce paramètre, le paramètre internal est ignoré. Si ce paramètre inclut un protocole, le paramètre secure est ignoré. Vous devez définir ce paramètre si le paramètre region est défini sur un ID de région ou si vous devez accéder à OSS via un autre nom de domaine.

• [internal] : indique s'il faut utiliser un endpoint de réseau interne. La valeur par défaut est false.

• [secure] : indique s'il faut utiliser HTTPS pour accéder à OSS. La valeur par défaut est true.

• [cname] : indique si le paramètre endpoint est un nom de domaine personnalisé. La valeur par défaut est false. Si ce paramètre est défini sur true, vous devez également définir le paramètre endpoint.

• [sldEnable] : indique s'il faut utiliser un domaine de second niveau pour accéder à OSS. La valeur par défaut est false.

• [signVersion] : version de signature. La valeur par défaut est ESignVersion.V4, correspondant à la version de signature 4.

• [isRequestPay] : indique s'il faut utiliser le mode « paiement par le demandeur ». La valeur par défaut est false. Si vous définissez ce paramètre sur true, l'en-tête de requête x-oss-request-payer est ajouté aux requêtes avec la valeur requester.

• [userAgent] : User-Agent personnalisé. Cette valeur est envoyée dans le cadre de l'en-tête de requête User-Agent.

• [timeout] : délai d'expiration de la requête en millisecondes (ms). La valeur par défaut est 60 000 ms, soit 60 secondes.

• [disabledMD5] : indique s'il faut ignorer le calcul de la valeur Content-MD5. La valeur par défaut est false.

• [proxy] : paramètres de proxy pour les requêtes HTTP.

• [retryMax] : nombre maximal de tentatives pour une requête ayant échoué. La valeur par défaut est 0.

• [requestErrorShouldRetry] : méthode permettant de déterminer s'il faut relancer une requête ayant échoué. Par défaut, toutes les requêtes ayant échoué sont relancées.

• [amendTimeSkewed] : décalage temporel à corriger en millisecondes (ms). La valeur par défaut est 0.

• [customRequestFunction] : méthode de requête personnalisée.

• [customSign] : méthode de signature personnalisée. Après configuration de ce paramètre, toutes les requêtes nécessitant une signature, à l'exception des signatures POST, sont signées à l'aide de cette méthode.

Configuration du serveur MCP

• [transportType] : type de communication. La valeur par défaut est l'entrée/sortie standard (stdio).

• [port] : port sur lequel le serveur HTTP écoute. Valide uniquement pour la communication Streamable HTTP. La valeur par défaut est 18081.

• [tools] : liste des outils à activer. Par défaut, tous les outils sont activés.

• [listToolsMaxKeysMaxValue] : valeur maximale (1-1000) pour le paramètre maxKeys dans les outils basés sur des listes. La valeur par défaut est 100.

• [listToolsDefaultMaxKeys] : valeur par défaut du paramètre maxKeys dans les outils basés sur des listes. Par défaut, cette valeur correspond à celle de listToolsMaxKeysMaxValue.

• [httpServer] : instance de serveur HTTP personnalisée. Valide uniquement pour la communication Streamable HTTP.

• [logger] : instance de journalisation.

• [xmlContentText] : indique s'il faut renvoyer le résultat sous forme de chaîne XML brute après le succès d'une requête d'outil. La valeur par défaut est false, ce qui signifie qu'une chaîne JSON est renvoyée.

• [toolsRequestSuccessCallback] : fonction de rappel pour les requêtes d'outil réussies.

• [toolsRequestErrorCallback] : fonction de rappel pour les requêtes d'outil ayant échoué.