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

Model Context Protocol (MCP) istemcisi.

Bu paket, @huggingface/inference üzerine kurulu InferenceClient ile MCP sunucuları ile etkileşime girmek için bir istemci uygulaması sağlar.

MCP araçlarından yararlanabilen örnek bir CLI smol Agent içerir.

Kurulum

Bu paket, Hugging Face JS monorepo'sunun bir parçasıdır. Tüm paketler için bağımlılıkları yüklemek için, depoyun kök dizininden şunu çalıştırın:

pnpm install

Kullanım (CLI Ajanı)

Paket, MCP istemcisinin nasıl kullanılacağını gösteren bir komut satırı arayüzü (CLI) aracını içerir.

Ön koşullar

  • Hugging Face API Token: Uygun izinlere sahip bir Hugging Face API jetonu gereklidir. Bunu bir ortam değişkeni olarak ayarlayın:
    export HF_TOKEN="hf_..."

Ajanı Çalıştırma

Paket dizinine gidin ve ajan betiğini çalıştırın:

cd packages/mcp-client
pnpm agent

Alternatif olarak, monorepo kök dizininden çalıştırın:

pnpm --filter @huggingface/mcp-client agent

Ajan, kullanılabilir MCP araçlarını yükleyecektir (varsayılan olarak, Masaüstünüz için bir dosya sistemi sunucusuna ve bir Playwright sunucusuna bağlanır) ve sizden girdi ister (>).

Yapılandırma (Ortam Değişkenleri)

  • HF_TOKEN (İsteğe bağlı): Hugging Face API anahtarınız. HF üzerinde bir Inference Provider kullanıyorsanız gereklidir.
  • MODEL_ID (İsteğe bağlı): Ajanın çıkarımı için kullanılacak model kimliği. Varsayılan olarak Qwen/Qwen2.5-72B-Instruct kullanılır.
  • PROVIDER (İsteğe bağlı): Çıkarım sağlayıcısı. Varsayılan olarak together kullanılır. Kullanılabilir sağlayıcılar için @huggingface/inference paketini inceleyin.
  • ENDPOINT_URL veya BASE_URL (İsteğe bağlı): Çağrılacak özel bir temel URL (örneğin yerel).

Özel modelle örnek:

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

Geliştirme

Ortak geliştirme görevleri pnpm betikleri kullanılarak çalıştırılabilir:

  • pnpm build: Paketi derler.
  • pnpm lint: Kod stilini denetler ve düzeltir.
  • pnpm format: Kodu Prettier ile biçimlendirir.
  • pnpm test: Vitest kullanarak testleri çalıştırır.
  • pnpm check: Kodu TypeScript kullanarak tip kontrolü yapar.

Lisans

MIT

Update on GitHub