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

Cliente para el Protocolo de Contexto de Modelo (MCP).

Este paquete proporciona una implementación de cliente para interactuar con servidores MCP, construida sobre nuestro @huggingface/inference.

Incluye un ejemplo de agente CLI smol que puede aprovechar las herramientas MCP.

Instalación

Este paquete forma parte del monorepo de Hugging Face JS. Para instalar las dependencias de todos los paquetes, ejecute desde la raíz del repositorio:

pnpm install

Uso (Agente CLI)

El paquete incluye un agente de interfaz de línea de comandos (CLI) que demuestra cómo usar el cliente MCP.

Prerrequisitos

  • Hugging Face API Token: Necesitas un token de API de Hugging Face con los permisos adecuados. Configúralo como variable de entorno:
    export HF_TOKEN="hf_..."

Ejecutar el Agente

Navegue hasta el directorio del paquete y ejecute el script del agente:

cd packages/mcp-client
pnpm agent

Alternativamente, ejecute desde la raíz del monorepo:

pnpm --filter @huggingface/mcp-client agent

El agente cargará las herramientas MCP disponibles (por defecto, conectándose a un servidor de sistema de archivos para tu escritorio y a un servidor de Playwright) y te pedirá una entrada (>).

Configuración (Variables de entorno)

  • HF_TOKEN (Opcional): Tu token de API de Hugging Face. Es obligatorio si usas un proveedor de inferencia en HF.
  • MODEL_ID (Opcional): El ID del modelo que se usará para la inferencia del agente. El valor predeterminado es Qwen/Qwen2.5-72B-Instruct.
  • PROVIDER (Opcional): El proveedor de inferencia. El valor predeterminado es together. Consulte @huggingface/inference para ver los proveedores disponibles.
  • ENDPOINT_URL o BASE_URL (Opcional): una URL base personalizada (por ejemplo, local) para llamar.

Ejemplo con un modelo personalizado:

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

Desarrollo

Las tareas de desarrollo habituales se pueden ejecutar mediante scripts de pnpm:

  • pnpm build: Compila el paquete.
  • pnpm lint: Analiza y corrige el estilo del código.
  • pnpm format: Formatea el código usando Prettier.
  • pnpm test: Ejecuta las pruebas usando Vitest.
  • pnpm check: Comprueba los tipos del código usando TypeScript.

Licencia

MIT

Update on GitHub