Aller au contenu principal

Guide d'Utilisation

Ce guide fournit des instructions détaillées sur la manière d'installer, de configurer et d'utiliser le serveur MCP de CWCloud.

Prérequis​

Installation​

Option 1 : Cloner et Compiler​

# Cloner le dépôt
git clone https://github.com/cwloudtech/cwcloud-mcp.git
cd cwcloud-mcp

# Compiler le serveur
go build -o cwcloud-mcp ./cmd/server

# Rendre le fichier exécutable
chmod +x cwcloud-mcp

Option 2 : Installation Directe​

# Installer directement depuis la source
go install github.com/cwloudtech/cwcloud-mcp/cmd/server@latest

Configuration​

Configuration de l'Environnement​

Créez un fichier .env à la racine du projet :

# Copier la configuration d'exemple
cp .env.example .env

Modifiez .env avec vos informations d'identification CWCloud :

# Configuration de l'API CWCloud
COMWORK_API_URL=https://api.cwcloud.tech
COMWORK_ACCESS_KEY=votre_cle_d_acces_ici
COMWORK_SECRET_KEY=votre_cle_secrete_ici

# Configuration du Serveur (optionnel)
SERVER_PORT=8080
LOG_LEVEL=info

Obtenir Vos Clés API​

  1. Connectez-vous à votre Tableau de Bord CWCloud
  2. Naviguez vers Informations d'identification → Clés API
  3. Générez une nouvelle paire de clés API
  4. Copiez la clé d'accès et la clé secrète dans votre fichier .env

Démarrage Rapide​

Guide d'Intégration Github Copilot (Recommandé)​

La manière la plus rapide de démarrer avec le serveur MCP de CWCloud et GitHub Copilot :

# Cloner et naviguer vers le projet
git clone https://github.com/cwloudtech/cwcloud-mcp.git
cd cwcloud-mcp

# Exécuter la configuration automatisée
./setup-github-copilot.sh

Cela va :

  • Compiler le serveur
  • Configurer vos informations d'identification API CWCloud
  • Mettre en place l'intégration MCP de VS Code
  • Tester la connexion

Consultez le Guide d'Intégration Github Copilot pour un guide d'installation détaillé

Test Manuel​

# Exécuter des tests interactifs avec la fonctionnalité IA
./test-interactive.sh

Se Connecter avec les Clients MCP​

GitHub Copilot​

Après avoir exécuté ./setup-github-copilot.sh, redémarrez VS Code et utilisez :

Outils IA :

  • #generate_ai_prompt - Générer des réponses IA
  • #list_conversations - Lister l'historique des conversations
  • #list_adapters - Lister les adaptateurs IA disponibles

Outils de Gestion d'Environnements :

  • #list_environments - Lister tous vos environnements cloud
  • #get_environment - Obtenir des informations détaillées sur un environnement spécifique
  • #create_environment - Créer de nouveaux environnements cloud
  • #update_environment - Mettre à jour les propriétés d'environnements existants
  • #delete_environment - Supprimer des environnements (avec confirmation)

Utilisation de Docker​

Construire l'Image Docker​

# Construire l'image Docker
docker build -t cwcloud-mcp .

Exécuter avec des Variables d'Environnement​

# Méthode 1 : Utiliser des variables d'environnement individuelles
docker run -i --rm \
  -e COMWORK_API_URL=https://api.cwcloud.tech \
  -e COMWORK_ACCESS_KEY=votre_cle_d_acces \
  -e COMWORK_SECRET_KEY=votre_cle_secrete \
  -e LOG_LEVEL=info \
  cwcloud-mcp

# Méthode 2 : Utiliser un fichier d'environnement
docker run -i --rm --env-file .env.docker cwcloud-mcp

Tester le Conteneur Docker​

# Tester le protocole MCP (fonctionnalité de base)
echo '{"jsonrpc": "2.0", "id": 1, "method": "initialize", "params": {"protocolVersion": "2025-06-18", "capabilities": {"tools": {}}, "clientInfo": {"name": "test", "version": "1.0.0"}}}' | \
docker run -i --rm --env-file .env.docker cwcloud-mcp

# Tester la génération IA
echo '{"jsonrpc": "2.0", "id": 2, "method": "tools/call", "params": {"name": "generate_ai_prompt", "arguments": {"adapter": "gpt4o", "message": "Bonjour le monde!"}}}' | \
docker run -i --rm --env-file .env.docker cwcloud-mcp

# Tester le listage des conversations
echo '{"jsonrpc": "2.0", "id": 3, "method": "tools/call", "params": {"name": "list_conversations", "arguments": {}}}' | \
docker run -i --rm --env-file .env.docker cwcloud-mcp

# Tester le listage des environnements
echo '{"jsonrpc": "2.0", "id": 4, "method": "tools/call", "params": {"name": "list_environments", "arguments": {"format": "table"}}}' | \
docker run -i --rm --env-file .env.docker cwcloud-mcp

Outils Disponibles (119 au Total)​

Outils IA (3) :

  • generate_ai_prompt: Générer des réponses IA en utilisant divers modèles (GPT-4, Claude, Gemini).
  • list_conversations: Lister et gérer votre historique de conversations IA.
  • list_adapters: Lister tous les adaptateurs IA disponibles et leur état actuel.

Gestion d'Environnements (11 outils) :

  • list_environments: Lister tous vos environnements cloud avec différents formats de sortie.
  • get_environment: Obtenir des informations détaillées sur un environnement spécifique.
  • admin_list_environments: Lister les environnements avec privilèges admin et détails améliorés.
  • admin_get_environment: Obtenir les détails d'environnement avec métadonnées admin.
  • admin_create_environment: Créer de nouveaux environnements cloud (VM, Kubernetes, Fonctions, etc.).
  • admin_update_environment: Mettre à jour les propriétés d'environnements avec privilèges admin.
  • admin_delete_environment: Supprimer des environnements avec privilèges admin et confirmation.

Gestion de Projets (7 outils) :

  • list_projects: Lister tous vos projets avec différents formats de sortie.
  • get_project: Obtenir des informations détaillées sur un projet spécifique.
  • admin_list_projects: Lister les projets avec privilèges admin et détails améliorés.
  • admin_get_project: Obtenir les détails de projet avec métadonnées admin.
  • admin_create_project: Créer de nouveaux projets avec privilèges admin.
  • admin_update_project: Mettre à jour les propriétés de projets avec privilèges admin.
  • admin_delete_project: Supprimer des projets avec privilèges admin et confirmation.

Gestion d'Instances (10 outils) :

  • list_instances: Lister toutes vos instances VM avec différents formats de sortie.
  • get_instance: Obtenir des informations détaillées sur une instance spécifique.
  • create_instance: Créer de nouvelles instances VM.
  • update_instance: Mettre à jour les propriétés d'instances existantes.
  • delete_instance: Supprimer des instances VM.
  • admin_list_instances: Lister les instances avec privilèges admin et détails améliorés.
  • admin_get_instance: Obtenir les détails d'instance avec métadonnées admin.
  • admin_create_instance: Créer des instances avec privilèges admin.
  • admin_update_instance: Mettre à jour les instances avec privilèges admin.
  • admin_delete_instance: Supprimer des instances avec privilèges admin.

Gestion de Stockage (10 outils) :

  • list_buckets: Lister tous vos buckets de stockage avec différents formats de sortie.
  • get_bucket: Obtenir des informations détaillées sur un bucket spécifique.
  • create_bucket: Créer de nouveaux buckets de stockage.
  • update_bucket: Mettre à jour les propriétés de buckets existants.
  • delete_bucket: Supprimer des buckets de stockage.
  • admin_list_buckets: Lister les buckets avec privilèges admin et détails améliorés.
  • admin_get_bucket: Obtenir les détails de bucket avec métadonnées admin.
  • admin_create_bucket: Créer des buckets avec privilèges admin.
  • admin_update_bucket: Mettre à jour les buckets avec privilèges admin.
  • admin_delete_bucket: Supprimer des buckets avec privilèges admin.

Gestion de Registres (10 outils) :

  • list_registries: Lister tous vos registres de conteneurs avec différents formats de sortie.
  • get_registry: Obtenir des informations détaillées sur un registre spécifique.
  • create_registry: Créer de nouveaux registres de conteneurs.
  • update_registry: Mettre à jour les propriétés de registres existants.
  • delete_registry: Supprimer des registres de conteneurs.
  • admin_list_registries: Lister les registres avec privilèges admin et détails améliorés.
  • admin_get_registry: Obtenir les détails de registre avec métadonnées admin.
  • admin_create_registry: Créer des registres avec privilèges admin.
  • admin_update_registry: Mettre à jour les registres avec privilèges admin.
  • admin_delete_registry: Supprimer des registres avec privilèges admin.

Gestion de Fonctions (12 outils) :

  • list_functions: Lister toutes vos fonctions serverless avec différents formats de sortie.
  • get_function: Obtenir des informations détaillées sur une fonction spécifique.
  • create_function: Créer de nouvelles fonctions serverless.
  • update_function: Mettre à jour les propriétés de fonctions existantes.
  • delete_function: Supprimer des fonctions serverless.
  • invoke_function: Exécuter des fonctions serverless avec paramètres.
  • list_invocations: Lister l'historique d'invocations et les logs de fonctions.
  • admin_list_functions: Lister les fonctions avec privilèges admin et détails améliorés.
  • admin_get_function: Obtenir les détails de fonction avec métadonnées admin.
  • admin_create_function: Créer des fonctions avec privilèges admin.
  • admin_update_function: Mettre à jour les fonctions avec privilèges admin.
  • admin_delete_function: Supprimer des fonctions avec privilèges admin.

Gestion de Surveillance (10 outils) :

  • list_monitors: Lister tous vos points de surveillance avec différents formats de sortie.
  • get_monitor: Obtenir des informations détaillées sur un moniteur spécifique.
  • create_monitor: Créer de nouveaux points de surveillance.
  • update_monitor: Mettre à jour les propriétés de moniteurs existants.
  • delete_monitor: Supprimer des points de surveillance.
  • admin_list_monitors: Lister les moniteurs avec privilèges admin et détails améliorés.
  • admin_get_monitor: Obtenir les détails de moniteur avec métadonnées admin.
  • admin_create_monitor: Créer des moniteurs avec privilèges admin.
  • admin_update_monitor: Mettre à jour les moniteurs avec privilèges admin.
  • admin_delete_monitor: Supprimer des moniteurs avec privilèges admin.

Gestion d'Utilisateurs (10 outils) :

  • list_users: Lister tous les utilisateurs système avec différents formats de sortie.
  • get_user: Obtenir des informations détaillées sur un utilisateur spécifique.
  • create_user: Créer de nouveaux utilisateurs système.
  • update_user: Mettre à jour les propriétés d'utilisateurs existants.
  • delete_user: Supprimer des utilisateurs système.
  • admin_list_users: Lister les utilisateurs avec privilèges admin et détails améliorés.
  • admin_get_user: Obtenir les détails d'utilisateur avec métadonnées admin.
  • admin_create_user: Créer des utilisateurs avec privilèges admin.
  • admin_update_user: Mettre à jour les utilisateurs avec privilèges admin.
  • admin_delete_user: Supprimer des utilisateurs avec privilèges admin.

Gestion DNS (10 outils) :

  • list_dns_records: Lister tous vos enregistrements DNS avec différents formats de sortie.
  • get_dns_record: Obtenir des informations détaillées sur un enregistrement DNS spécifique.
  • create_dns_record: Créer de nouveaux enregistrements DNS (A, AAAA, CNAME, MX, etc.).
  • update_dns_record: Mettre à jour les propriétés d'enregistrements DNS existants.
  • delete_dns_record: Supprimer des enregistrements DNS.
  • admin_list_dns_records: Lister les enregistrements DNS avec privilèges admin et détails améliorés.
  • admin_get_dns_record: Obtenir les détails d'enregistrement DNS avec métadonnées admin.
  • admin_create_dns_record: Créer des enregistrements DNS avec privilèges admin.
  • admin_update_dns_record: Mettre à jour les enregistrements DNS avec privilèges admin.
  • admin_delete_dns_record: Supprimer des enregistrements DNS avec privilèges admin.

Modèles d'IA Supportés:

  • gpt4o, gpt4o-mini - Variantes OpenAI GPT-4
  • claude3sonnet, claude3haiku - Anthropic Claude 3
  • gemini, gemini-pro - Google Gemini
  • openmistral - OpenMistral

Pour des exemples d'utilisation détaillés, consultez le Guide d'Intégration Github Copilot