Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://wb-21fd5541-docs-2658.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Model Context Protocol (MCP) est une norme ouverte qui permet aux agents d’IA d’appeler des outils externes. Le serveur MCP de W&B donne à votre IDE, à votre assistant de code ou à votre agent conversationnel un accès direct à vos données et à votre documentation W&B, afin de répondre aux questions sur vos runs, traces, évaluations et artefacts sans avoir à faire de copier-coller. Pour obtenir la liste complète de ce que vous pouvez faire avec le serveur, consultez la section fonctionnalités du serveur MCP de W&B. Il s’intègre nativement à la plupart des IDE, assistants de code et agents conversationnels, notamment :
  • Cursor
  • Visual Studio Code (VS Code)
  • Claude Code
  • Codex
  • Gemini CLI
  • Mistral LeChat
  • Claude Desktop

Types de déploiement

Vous pouvez utiliser le serveur MCP hébergé ou configurer une version locale si vous avez besoin de davantage d’isolation et de flexibilité. L’utilisation de la version locale oblige votre client à utiliser une URL différente pour accéder au serveur.

Serveur hébergé (recommandé)

Un serveur MCP géré par W&B, auquel votre client se connecte via HTTP avec votre clé API W&B. Aucune installation ni aucun processus local à maintenir.Utiliser le serveur hébergé

Installation locale

Exécutez le serveur MCP sur votre propre machine via STDIO ou HTTP. À utiliser si vous avez besoin d’un fonctionnement isolé du réseau, de verrouiller une version précise, d’un comportement de serveur personnalisé, d’un développement actif du serveur ou de la prise en charge d’un client qui ne prend en charge que STDIO.Exécuter le serveur MCP localement
Si vous exécutez W&B sur Cloud dédié ou Autogéré et que le serveur MCP hébergé n’est pas encore activé sur votre instance, contactez l’assistance W&B ou votre équipe de compte W&B pour en faire la demande.

Prérequis

Avant de configurer un client :
  • Créez une clé API W&B sur wandb.ai/authorize.
  • Définissez cette clé comme variable d’environnement WANDB_API_KEY, ou transmettez-la à votre client sous forme de jeton Bearer.
  • Pour Cloud dédié, Autogéré et les installations locales sur une instance autre que l’instance par défaut, définissez la variable d’environnement WANDB_BASE_URL sur l’URL de votre instance.

Utiliser le serveur hébergé

W&B gère un serveur MCP pour chaque type de déploiement. Vous n’avez rien à installer. Configurez votre client pour se connecter via HTTP avec une clé API W&B dans l’en-tête Authorization.

URL de connexion

L’URL dépend de votre type de déploiement W&B :
DéploiementURL du serveur
Cloud mutualiséhttps://mcp.withwandb.com/mcp
Cloud dédiéhttps://<your-instance>/mcp
Autogéréhttps://<your-instance>/mcp
Pour Cloud dédié ou Autogéré, remplacez https://mcp.withwandb.com/mcp par https://<your-instance>/mcp et laissez tout le reste inchangé. Les configurations client ci-dessous utilisent l’URL du Cloud mutualisé.
Exécutez la commande suivante dans votre terminal, en remplaçant le jeton Bearer par votre clé API W&B :
claude mcp add --transport http wandb https://mcp.withwandb.com/mcp \
  --header "Authorization: Bearer <your-wandb-api-key>"
Ajoutez --scope user pour configurer Claude Code globalement. Omettez-le pour configurer uniquement le projet en cours.Vérifiez la connexion en demandant List my W&B entities. L’agent doit appeler list_entities_tool et renvoyer votre nom d’utilisateur ainsi que les éventuelles Teams. Si la connexion échoue, voir Résolution des problèmes. Pour plus d’informations, voir la documentation MCP de Claude Code.

Exécuter le serveur MCP en local

Une installation locale est une alternative au serveur hébergé, et non l’option par défaut pour aucun type de déploiement. Utilisez-la lorsque le serveur hébergé ne convient pas à votre environnement. Raisons courantes d’exécuter le serveur en local :
  • Environnements isolés du réseau ou hors ligne où votre client ne peut pas atteindre un point de terminaison W&B hébergé.
  • Version épinglée. Le serveur hébergé suit la branche principale. Une installation locale permet d’épingler une balise de version spécifique.
  • Comportement personnalisé du serveur, comme modifier les descriptions des outils, ajouter des outils ou définir un budget de jetons de réponse différent de la valeur par défaut.
  • Développement actif sur le serveur lui-même.
  • Clients STDIO uniquement ou clients nécessitant un processus local.
Pour les utilisateurs de Cloud dédié ou Autogéré, la solution hébergée est à privilégier. Utilisez une installation locale depuis wandb/wandb-mcp-server uniquement si le serveur hébergé n’est pas encore activé sur votre instance ou si l’une des raisons ci-dessus s’applique. Définissez la variable d’environnement WANDB_BASE_URL avec l’URL de votre instance.

Prérequis locaux

Pour exécuter le serveur en local, assurez-vous de disposer des éléments suivants :
  • Python 3.11 ou version ultérieure.
  • uv ou pip.
  • Une clé API W&B, définie dans WANDB_API_KEY.
  • WANDB_BASE_URL défini sur l’URL de votre instance si vous utilisez Cloud dédié ou Autogéré.

Installer le serveur

Choisissez une méthode d’installation et exécutez la commande suivante pour installer le serveur MCP :
uvx --from git+https://github.com/wandb/wandb-mcp-server wandb_mcp_server

Configurez votre client

Sélectionnez votre client MCP, puis exécutez la configuration suivante en remplaçant <your-wandb-api-key> par votre clé API W&B si nécessaire :
Exécutez la commande suivante. Ajoutez --scope user pour une configuration globale.
claude mcp add wandb \
  -e WANDB_API_KEY=<your-wandb-api-key> \
  -e WANDB_BASE_URL=https://your-wandb-instance.example.com \
  -- uvx --from git+https://github.com/wandb/wandb-mcp-server wandb_mcp_server

Exécutez le serveur avec le transport HTTP

Pour les clients web et pour effectuer des tests, exécutez le serveur avec le transport HTTP :
uvx wandb_mcp_server --transport http --host 0.0.0.0 --port 8080
Pour exposer un serveur local à des clients externes, tels que l’API OpenAI Responses, utilisez un tunnel :
uvx wandb_mcp_server --transport http --port 8080

# Dans un autre terminal
ngrok http 8080
Mettez à jour la configuration de votre client MCP pour utiliser l’URL du tunnel.

Variables d’environnement

Les variables d’environnement suivantes contrôlent l’authentification, le routage de l’instance et le comportement du serveur pour les installations locales. Définissez-les dans le bloc env de votre client ou exportez-les dans votre shell.
VariableDescription
WANDB_API_KEYClé API W&B pour l’authentification. Requise.
WANDB_BASE_URLURL personnalisée de l’instance W&B pour Cloud dédié ou Autogéré. Valeur par défaut : https://api.wandb.ai.
WANDB_MCP_PROXY_DOCSActive le proxy de recherche dans la documentation search_wandb_docs_tool. Valeur par défaut : true.
WANDBOT_BASE_URLPoint de terminaison personnalisé pour le proxy de recherche dans la documentation.
MAX_RESPONSE_TOKENSBudget de jetons pour la troncature des réponses des outils. Valeur par défaut : 30000.
MCP_SERVER_LOG_LEVELNiveau de verbosité de la journalisation. Valeurs possibles : DEBUG, INFO, WARNING, ERROR.
Pour la référence complète de la ligne de commande et les options avancées, voir le README de wandb-mcp-server.

Capacités du serveur MCP de W&B

Utilisez le serveur MCP pour analyser des Experiments, déboguer des traces, créer des Reports, gérer le registre et les artefacts, et répondre à des questions sur la documentation W&B. Les prompts d’exemple suivants illustrent certaines des tâches que vous pouvez demander à votre agent d’effectuer lorsqu’il est connecté au serveur MCP de W&B :
  • “Montrez-moi les 5 meilleurs runs selon eval/accuracy dans your-team/your-project.”
  • “Comment la latence des traces de prédiction de mon agent de recrutement a-t-elle évolué au cours du dernier mois ?”
  • “Générez un Report W&B comparant les décisions prises par l’agent de recrutement la semaine dernière.”
  • “Quelles versions de l’artefact production-model existent, et quelles modifications ont été apportées entre v2 et v3 ?”
  • “Comment puis-je créer un classement dans Weave ?”

Outils disponibles

Le serveur propose plusieurs outils à diverses fins. Le tableau suivant répertorie le nom de chaque outil, à quel moment l’agent doit l’utiliser, ainsi qu’un prompt concret que vous pouvez utiliser pour invoquer cet outil.
Des outils qui vous aident à identifier les noms de projet et d’entité, et à inspecter les schémas.
ToolUse whenExample prompt
list_entities_toolAucune entité n’est spécifiée, ou pour énumérer les équipes et comptes auxquels la clé API peut accéder.”À quelles équipes W&B ai-je accès ?”
query_wandb_entity_projectsL’entité est connue, mais pas le nom du projet, ou une requête précédente a échoué avec “project not found”.”Liste tous les projets de your-team.”
probe_project_toolPour découvrir les métriques disponibles, les clés de configuration et les tags dans un projet basé sur des runs que vous ne connaissez pas.”Analyse your-team/your-project et dites-moi quelles métriques sont enregistrées.”
infer_trace_schema_toolPour découvrir les noms de champs, les types et des exemples de valeurs dans un projet de traces Weave que vous ne connaissez pas avant d’exécuter une requête.”Quels champs figurent dans les traces Weave de your-team/your-project ?”

Requêtes de traces axées sur le schéma

Pour les requêtes de traces Weave, appelez d’abord infer_trace_schema_tool pour identifier les champs disponibles, puis appelez query_weave_traces_tool avec une liste précise de colonnes et detail_level :
detail_levelRenvoieÀ utiliser lorsque
schemaChamps structurels uniquement. Le plus rapide.Pour parcourir ou compter.
summaryEntrées et sorties tronquées. Par défaut.Pour la plupart des tâches d’analyse.
fullTout, sans troncature.Pour examiner en détail un petit nombre de traces spécifiques.
Cette approche limite l’utilisation des jetons pour les questions générales et permet à l’agent de passer à full uniquement pour les traces pertinentes.

Conseils d’utilisation

Les pratiques et flux de travail ci-dessous vous aideront à obtenir de meilleurs résultats avec le serveur MCP de W&B. Commencez par les pratiques générales, puis lisez la sous-section qui correspond à votre charge de travail pour obtenir des conseils plus précis et des enchaînements d’outils en plusieurs étapes.

Bonnes pratiques générales

Suivez ces pratiques, quel que soit votre cas d’utilisation :
  • Spécifiez l’entité et le projet. Les outils MCP nécessitent une entité explicite (votre équipe ou votre compte personnel) et un nom de projet. Indiquez les deux dans каждой question, par exemple « dans your-team/your-project ».
  • Posez des questions ciblées. Préférez « Quelle évaluation a obtenu le score F1 le plus élevé ? » à « Quelle est ma meilleure évaluation ? ». Des métriques et des plages de temps précises produisent de meilleurs appels d’outils.
  • Vérifiez la récupération complète. Pour les questions larges telles que « Quels sont mes runs les plus performants ? », demandez à l’agent de confirmer qu’il a récupéré tous les runs disponibles, et pas seulement les plus récents.
  • Combinez avec W&B Skills. W&B Skills montrent aux agents de code comment structurer les flux de travail W&B. Skills fournit des modèles et MCP fournit l’accès aux données ; les deux fonctionnent bien ensemble.

Pour les flux de travail avec de nombreuses traces

Suivez ces bonnes pratiques lorsque vous travaillez avec les traces Weave :
  • Commencez par le schéma. Appelez infer_trace_schema_tool avant query_weave_traces_tool afin que l’agent sache quels champs et quelles valeurs de filtre sont valides.
  • Choisissez le bon detail_level. Utilisez schema pour explorer, summary (par défaut) pour l’analyse, et full uniquement lorsque vous examinez en détail un petit nombre de traces spécifiques.
  • Enchaînez avec resolve_trace_roots_tool. Après une requête sur des traces enfants, transmettez la liste de trace_id obtenue à resolve_trace_roots_tool pour associer chaque trace à sa session racine en un seul appel groupé.
  • Privilégiez summarize_evaluation_tool pour les évaluations. Il agrège automatiquement la hiérarchie Evaluation.evaluate et predict_and_score. Ne revenez à query_weave_traces_tool que pour les données de trace brutes.
Pour un flux de travail de bout en bout, voir Triage des appels LLM en échec.

Pour les flux de travail comportant beaucoup de runs

Suivez ces pratiques lorsque vous travaillez avec des runs W&B Models :
  • Sondez avant d’interroger. Appelez probe_project_tool sur un projet centré sur les runs que vous ne connaissez pas encore afin d’identifier les clés de métriques, les clés de configuration et les tags avant de construire votre requête GraphQL.
  • Utilisez get_run_history_tool pour les séries chronologiques. GraphQL n’échantillonne pas. Pour les courbes de perte et les autres données de séries chronologiques, get_run_history_tool est donc à la fois plus rapide et moins coûteux.
  • Laissez compare_runs_tool calculer les écarts. Il renvoie les écarts de configuration et de métriques avec un historique aligné en un appel unique, ce qui évite une comparaison manuelle.
  • Commencez par un contrôle de santé. Lorsqu’un run d’entraînement semble anormal, appelez diagnose_run_tool avant d’examiner manuellement l’historique.
Pour les flux de travail de bout en bout, Voir Diagnostiquer un run d’entraînement défaillant et Résumer les évaluations et comparer les versions de modèle.

Pour Cloud dédié et Autogéré

Suivez ces pratiques pour les déploiements non multilocataires :
  • Préférez le serveur hébergé sur votre instance, à l’adresse https://<your-instance>/mcp. Il expose les mêmes outils que le serveur multilocataire, sans nécessiter de WANDB_BASE_URL côté client. Ne recourez à une installation locale que si le serveur hébergé n’est pas encore activé.
  • Si vous l’exécutez localement sur votre instance, définissez WANDB_BASE_URL avec l’URL de votre instance dans le bloc env du client. Sans cela, le serveur cible api.wandb.ai et ne renvoie aucune donnée.
  • Les limites de débit sur Cloud dédié sont distinctes de celles du mode multilocataire. Voir les limites de débit du Cloud dédié pour connaître les valeurs par défaut et savoir comment demander des modifications.

Pour les installations en local

Suivez ces bonnes pratiques lorsque vous exécutez le serveur sur votre propre machine :
  • Privilégiez le transport STDIO pour les clients de bureau (Cursor, VS Code, Claude Code, Claude Desktop). Ne passez au transport HTTP que si un client l’exige explicitement (par exemple, l’API OpenAI Responses).
  • Lorsque les appels d’outil échouent silencieusement, définissez MCP_SERVER_LOG_LEVEL=DEBUG dans le bloc env du client, puis vérifiez à nouveau les journaux MCP du client.
  • Si vous installez depuis GitHub (uvx --from git+https://github.com/wandb/wandb-mcp-server wandb_mcp_server), uvx utilise la branche par défaut. Pour utiliser une version stable, spécifiez un tag explicite en ajoutant @v0.3.2 à l’URL Git.
La plupart des questions concrètes nécessitent plus d’un outil. Demandez à votre agent de suivre l’une de ces chaînes.

Explorer un projet inconnu

Pour explorer ce qui a été enregistré dans un projet, enchaînez ces outils :
  1. list_entities_tool pour trouver une entité ou une équipe.
  2. query_wandb_entity_projects pour trouver le projet.
  3. probe_project_tool pour les projets basés sur des runs, ou infer_trace_schema_tool pour les projets de traces Weave.
  4. Un appel ciblé à query_wandb_tool ou query_weave_traces_tool à l’aide des clés identifiées.

Analyser les appels LLM en échec

Pour trouver les traces problématiques et les sessions qui les ont produites, utilisez ces outils dans l’ordre suivant :
  1. query_weave_traces_tool avec un filtre sur les champs d’erreur ou d’exception, et detail_level="summary".
  2. resolve_trace_roots_tool sur la liste de trace_id obtenue afin d’associer chaque échec à sa session racine.
  3. query_weave_traces_tool avec detail_level="full" sur un petit nombre de racines spécifiques afin d’approfondir l’analyse.
  4. create_wandb_report_tool pour documenter les résultats.

Diagnostiquer un run d’entraînement défaillant

Pour exécuter un contrôle de santé sur un run d’entraînement suspect, enchaînez les outils suivants :
  1. get_run_history_tool pour récupérer les courbes de perte et de validation.
  2. diagnose_run_tool pour effectuer des vérifications automatisées de convergence, de surapprentissage et de NaN.
  3. compare_runs_tool par rapport à un run de référence connu pour être correct.
  4. create_wandb_report_tool avec des panneaux de graphiques linéaires pour partager le diagnostic.

Résumer les évaluations et comparer les versions du modèle

Pour trouver quelle version du modèle a donné les meilleurs résultats lors d’une évaluation, enchaînez ces outils :
  1. summarize_evaluation_tool pour les taux de réussite par Scorer et le nombre d’erreurs.
  2. list_artifact_versions_tool sur la collection de modèles concernée.
  3. compare_artifact_versions_tool entre la version candidate et la version de production actuelle.
  4. log_analysis_to_wandb et create_wandb_report_tool pour publier la comparaison.

Dépannage

Utilisez le tableau suivant pour vous aider à diagnostiquer et à résoudre les problèmes liés au serveur MCP de W&B :
SymptômeCause et correctif
401 Unauthorized ou Invalid API keyVotre clé API W&B est absente, mal formée ou n’est pas autorisée pour l’entité ou l’équipe cible. Générez une nouvelle clé sur wandb.ai/authorize et vérifiez qu’elle est transmise sous forme de jeton Bearer ou définie dans WANDB_API_KEY.
Résultats vides pour des requêtes qui devraient aboutirLe nom de l’équipe/de l’entité ou du projet est incorrect, ou la clé API ne dispose pas de l’accès nécessaire. Vérifiez les deux avec l’agent, puis réessayez.
404 Not Found ou connection refused sur https://<your-instance>/mcpLe serveur MCP hébergé n’est pas encore activé sur votre instance Cloud dédié ou Autogéré, ou le client pointe vers une URL incorrecte. Contactez l’assistance W&B pour demander l’activation, puis vérifiez l’URL dans URL de connexion.
429 Too Many Requests sur Cloud dédiéVous avez atteint les limites de débit de votre instance. Voir limites de débit du Cloud dédié pour savoir comment demander des limites plus élevées.
Le serveur local ne parvient pas à trouver uvx dans Claude DesktopUtilisez le chemin complet vers uvx dans le champ command de claude_desktop_config.json.