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 o Model Context Protocol (MCP).

Este pacote fornece uma implementação de cliente para interagir com servidores MCP, construída sobre nosso @huggingface/inference.

Inclui um exemplo de agente CLI smol que pode aproveitar as ferramentas MCP.

Instalação

Este pacote faz parte do monorepo JS do Hugging Face. Para instalar as dependências de todos os pacotes, execute a partir da raiz do repositório:

pnpm install

Uso (Agente de CLI)

O pacote inclui um agente de interface de linha de comando (CLI) que demonstra como usar o cliente MCP.

Pré-requisitos

  • Hugging Face API Token: Você precisa de um token de API do Hugging Face com as permissões adequadas. Defina-o como uma variável de ambiente:
    export HF_TOKEN="hf_..."

Executando o Agente

Navegue até o diretório do pacote e execute o script do agente:

cd packages/mcp-client
pnpm agent

Alternativamente, execute a partir da raiz do monorepo:

pnpm --filter @huggingface/mcp-client agent

O agente carregará as ferramentas MCP disponíveis (por padrão, conectando-se a um servidor de sistema de arquivos para seu Desktop e a um servidor Playwright) e solicitará sua entrada (>).

Configuração (Variáveis de Ambiente)

  • HF_TOKEN (Opcional): Seu token de API do Hugging Face. Obrigatório se você usar um Inference Provider no HF.
  • MODEL_ID (Opcional): O ID do modelo a ser usado para a inferência do agente. O padrão é Qwen/Qwen2.5-72B-Instruct.
  • PROVIDER (Opcional): O provedor de inferência. O padrão é together. Consulte @huggingface/inference para ver os provedores disponíveis.
  • ENDPOINT_URL ou BASE_URL (Opcional): uma URL base personalizada (por exemplo, local) para chamar.

Exemplo com modelo personalizado:

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

Desenvolvimento

Tarefas comuns de desenvolvimento podem ser executadas usando scripts do pnpm:

  • pnpm build: Compila o pacote.
  • pnpm lint: Verifica e corrige o estilo do código.
  • pnpm format: Formata o código usando Prettier.
  • pnpm test: Executa os testes usando Vitest.
  • pnpm check: Verifica os tipos do código usando TypeScript.

Licença

MIT

Update on GitHub