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

Klien untuk Model Context Protocol (MCP).

Paket ini menyediakan implementasi klien untuk berinteraksi dengan server MCP, yang dibangun di atas @huggingface/inference kami.

Termasuk contoh CLI smol Agent yang dapat memanfaatkan alat MCP.

Instalasi

Paket ini merupakan bagian dari monorepo Hugging Face JS. Untuk menginstal dependensi untuk semua paket, jalankan dari root repositori:

pnpm install

Penggunaan (Agen CLI)

Paket ini mencakup agen antarmuka baris perintah (CLI) yang mendemonstrasikan cara menggunakan klien MCP.

Prasyarat

  • Hugging Face API Token: Anda memerlukan token API Hugging Face dengan izin yang sesuai. Atur sebagai variabel lingkungan:
    export HF_TOKEN="hf_..."

Menjalankan Agen

Navigasi ke direktori paket dan jalankan skrip agen:

cd packages/mcp-client
pnpm agent

Sebagai alternatif, jalankan dari root monorepo:

pnpm --filter @huggingface/mcp-client agent

Agen akan memuat alat MCP yang tersedia (secara default, terhubung ke server filesystem untuk Desktop Anda dan server Playwright) dan meminta Anda untuk memberikan input (>).

Konfigurasi (Variabel Lingkungan)

  • HF_TOKEN (Opsional): Token API Hugging Face Anda. Wajib diisi jika Anda menggunakan Inference Provider di HF.
  • MODEL_ID (Opsional): ID model yang akan digunakan untuk inferensi agen. Secara default menggunakan Qwen/Qwen2.5-72B-Instruct.
  • PROVIDER (Opsional): Penyedia inferensi. Bawaan adalah together. Lihat @huggingface/inference untuk penyedia yang tersedia.
  • ENDPOINT_URL atau BASE_URL (Opsional): URL dasar kustom (misalnya lokal) untuk dipanggil.

Contoh dengan model kustom:

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

Pengembangan

Tugas pengembangan umum dapat dijalankan menggunakan skrip pnpm:

  • pnpm build: Membangun paket.
  • pnpm lint: Lint dan perbaiki gaya kode.
  • pnpm format: Memformat kode menggunakan Prettier.
  • pnpm test: Menjalankan pengujian menggunakan Vitest.
  • pnpm check: Memeriksa tipe kode menggunakan TypeScript.

Lisensi

MIT

Update on GitHub