Huggingface.js documentation

@huggingface/mcp-client

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

@huggingface/mcp-client

Client pour le Model Context Protocol (MCP).

Ce package fournit une implémentation de client pour interagir avec les serveurs MCP, construite sur la base de notre @huggingface/inference, InferenceClient.

Il inclut un exemple d'agent CLI smol qui peut exploiter les outils MCP.

Installation

Ce package fait partie du monorepo JS de Hugging Face. Pour installer les dépendances de tous les packages, exécutez depuis la racine du dépôt :

pnpm install

Utilisation (Agent CLI)

Le package inclut un agent d'interface en ligne de commande (CLI) qui illustre comment utiliser le client MCP.

Prérequis

  • Hugging Face API Token: Vous avez besoin d'un jeton API Hugging Face avec les autorisations appropriées. Définissez-le en tant que variable d'environnement :
    export HF_TOKEN="hf_..."

Exécuter l'Agent

Accédez au répertoire du package et exécutez le script de l'agent :

cd packages/mcp-client
pnpm agent

Sinon, exécutez depuis la racine du monorepo :

pnpm --filter @huggingface/mcp-client agent

L'agent chargera les outils MCP disponibles (par défaut, il se connecte à un serveur de système de fichiers pour votre Bureau et à un serveur Playwright) et vous demandera une entrée (>).

Configuration (Variables d'environnement)

  • HF_TOKEN (Facultatif) : votre jeton API Hugging Face. Requis si vous utilisez un Inference Provider sur HF.
  • MODEL_ID (Facultatif) : l’identifiant du modèle à utiliser pour l’inférence de l’agent. Par défaut, Qwen/Qwen2.5-72B-Instruct.
  • PROVIDER (Facultatif) : le fournisseur d’inférence. La valeur par défaut est together. Consultez @huggingface/inference pour la liste des fournisseurs disponibles.
  • ENDPOINT_URL ou BASE_URL (facultatif) : une URL de base personnalisée (par exemple locale) à appeler.

Exemple avec un modèle personnalisé :

export HF_TOKEN="hf_..."
export MODEL_ID="Qwen/Qwen2.5-72B-Instruct"
pnpm agent

Développement

Les tâches de développement courantes peuvent être exécutées à l'aide des scripts pnpm :

  • pnpm build : Construit le package.
  • pnpm lint : Lint et correction du style du code.
  • pnpm format : Formater le code à l'aide de Prettier.
  • pnpm test : Exécute les tests à l'aide de Vitest.
  • pnpm check : Vérifie les types du code à l'aide de TypeScript.

Licence

MIT

Update on GitHub