项目简介

Blaxel Typescript SDK 是一个开发工具包,旨在帮助开发者构建连接到 Blaxel 平台的智能体(Agent)和工具(Tools)。它提供了与 Blaxel 平台上的模型(Models)、函数(Functions/Tools)、知识库(Knowledgebases)以及其他智能体交互的能力。该 SDK 也包含用于构建符合 Model Context Protocol (MCP) 标准的服务器组件和示例。

主要功能点

  • 与 Blaxel 平台集成,使用平台的模型和工具。
  • 支持多种流行的 AI 框架(如 Vercel AI, LlamaIndex, LangGraph, Mastra)。
  • 提供 Blaxel 平台的遥测(Telemetry)和可观测性(Observability)集成。
  • 支持创建和连接 MCP 服务器,以标准方式向 LLM 客户端提供工具。
  • 提供 Blaxel 平台沙箱(Sandbox)环境的访问能力。

安装步骤

  1. 安装 Node.js (v18 或更高版本)。
  2. 安装 Blaxel CLI 工具:运行命令 'curl -fsSL https://raw.githubusercontent.com/beamlit/toolkit/preview/install.sh | BINDIR=$HOME/.local/bin sh'
  3. 登录 Blaxel 平台:运行命令 'bl login YOUR-WORKSPACE' (将 'YOUR-WORKSPACE' 替换为你的工作空间名称)。
  4. 在你的项目中安装 SDK:'npm install @blaxel/core @blaxel/llamaindex @blaxel/vercel @blaxel/langgraph @blaxel/mastra' (根据需要选择安装对应的框架包)

服务器配置 (用于MCP客户端连接此MCP服务器)

MCP客户端通常需要MCP服务器的连接信息。对于使用 Blaxel SDK 构建的 MCP 服务器并在 Blaxel 平台上部署为函数(Function)的情况,MCP客户端连接时,Blaxel平台会自动处理发现和连接细节。但在本地运行或特定场景下,可能需要如下配置信息来启动或连接MCP服务器:

{
  "serverName": "your-mcp-server-name", // MCP服务器在Blaxel平台的名称
  "command": "/app/start",            // 服务器启动命令,例如指向主执行文件
  "args": [],                       // 服务器启动参数数组
  "env": {                          // 服务器运行所需的环境变量
     "BL_SERVER_PORT": "8080",      // 服务器监听端口 (由Blaxel平台或用户指定)
     "BL_WORKSPACE": "your-workspace", // 所在的Blaxel工作空间
     "BL_NAME": "your-mcp-server-name", // 服务器名称
     "BL_TYPE": "function",           // 资源类型(通常为function)
     "BL_API_KEY": "...",             // 连接到Blaxel API的API Key (仅在需要SDK认证时)
     // ...                              // 其他必要的环境变量
  }
}

请注意,具体 'command' 和 'args' 取决于您如何打包和运行您的 Node.js MCP 服务器应用。'BlaxelMcpServerTransport' 会读取 'BL_SERVER_PORT' 环境变量来启动 WebSocket 服务器。

基本使用方法

  • 创建MCP服务器: 使用 Blaxel CLI 创建项目模板 ('bl create-mcp-server my-weather-server'),然后在主文件中实现你的 MCP 工具逻辑,并使用 'BlaxelMcpServerTransport' 连接到 MCP 服务器实例。
  • 部署到Blaxel: 使用 Blaxel CLI 将你的 MCP 服务器(作为 Blaxel 函数类型)部署到 Blaxel 平台 ('bl deploy')。
  • 在智能体中使用: 在你的 Blaxel 智能体项目中使用 'blTools(['your-mcp-server-name'])' 来获取并调用你的 MCP 服务器提供的工具。

信息

分类

开发者工具