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)のクライアントです。

このパッケージは、@huggingface/inference の InferenceClient を基盤として構築された、MCP サーバーとのやり取りを行うためのクライアント実装を提供します。

MCPツールを活用できるCLI smol Agentの例が含まれています。

インストール

このパッケージは Hugging Face JS モノレポの一部です。すべてのパッケージの依存関係をインストールするには、リポジトリのルートから以下を実行してください:

pnpm install

使用法(CLI エージェント)

このパッケージには、MCPクライアントの使用方法を示すコマンドラインインターフェース(CLI)エージェントが含まれています。

前提条件

  • Hugging Face API Token: 適切な権限を持つ Hugging Face API トークンが必要です。環境変数として設定してください:
    export HF_TOKEN="hf_..."

エージェントの実行

パッケージのディレクトリに移動し、エージェントスクリプトを実行します:

cd packages/mcp-client
pnpm agent

代わりに、モノレポのルートから実行します:

pnpm --filter @huggingface/mcp-client agent

エージェントは利用可能なMCPツールを読み込みます(デフォルトでは、デスクトップのファイルシステムサーバーとPlaywrightサーバーに接続します)。その後、入力(>)を求めます。

設定(環境変数)

  • HF_TOKEN(任意): Hugging Face API トークン。HF の Inference Provider を使用する場合は必須です。
  • MODEL_ID(任意):エージェントの推論に使用するモデル ID です。デフォルトは Qwen/Qwen2.5-72B-Instruct です。
  • PROVIDER(任意):推論プロバイダー。デフォルトはtogetherです。利用可能なプロバイダーについては@huggingface/inferenceを参照してください。
  • ENDPOINT_URL または BASE_URL(任意):呼び出すカスタムベースURL(ローカルなど)。

カスタムモデルの例:

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

開発

一般的な開発タスクは、pnpm スクリプトを使用して実行できます:

  • pnpm build: パッケージをビルドします。
  • pnpm lint: コードスタイルのLintと修正を行います。
  • pnpm format: Prettierを使用してコードを整形します。
  • pnpm test: Vitest を使用してテストを実行します。
  • pnpm check: TypeScript を使用してコードの型チェックを実行します。

ライセンス

MIT

Update on GitHub