Huggingface.js 文档

@huggingface/mcp-client

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

@huggingface/mcp-client

Model Context Protocol (MCP) 客户端。

此软件包提供了与 MCP 服务器交互的客户端实现,它基于我们的 InferenceClient,即 @huggingface/inference

它包含一个可以利用 MCP 工具的 CLI smol Agent 示例。

安装

此软件包是 Hugging Face JS Monorepo 的一部分。要安装所有软件包的依赖项,请在仓库根目录运行:

pnpm install

用法 (CLI Agent)

该软件包包含一个命令行界面 (CLI) 代理,用于演示如何使用 MCP 客户端。

先决条件

  • Hugging Face API 令牌:您需要一个具有适当权限的 Hugging Face API 令牌。将其设置为环境变量:
    export HF_TOKEN="hf_..."

运行代理

导航到软件包目录并运行代理脚本:

cd packages/mcp-client
pnpm agent

或者,从 monorepo 的根目录运行:

pnpm --filter @huggingface/mcp-client agent

代理将加载可用的 MCP 工具(默认情况下,连接到桌面文件系统服务器和 Playwright 服务器),并提示您输入(>)。

配置(环境变量)

  • HF_TOKEN(可选):您的 Hugging Face API 令牌。如果您在 HF 上使用推理提供商,则需要此项。
  • MODEL_ID(可选):用于代理推理的模型 ID。默认为 Qwen/Qwen2.5-72B-Instruct
  • PROVIDER(可选):推理提供商。默认为 together。有关可用提供商,请参阅 @huggingface/inference
  • ENDPOINT_URLBASE_URL(可选):要调用的自定义基本 URL(例如本地 URL)。

使用自定义模型示例:

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

开发

常见的开发任务可以使用 pnpm 脚本运行:

  • pnpm build:构建软件包。
  • pnpm lint:检查并修复代码风格。
  • pnpm format:使用 Prettier 格式化代码。
  • pnpm test:使用 Vitest 运行测试。
  • pnpm check:使用 TypeScript 进行类型检查。

许可证

MIT

< > 在 GitHub 上更新