关键词

Blaxel SDKMCP服务器工具集成智能体开发上下文协议

使用说明

项目简介

Blaxel Typescript SDK 是一个用于连接智能体和工具到 Blaxel 平台的开发工具包。它包含了创建 Model Context Protocol (MCP) 服务器的功能，使开发者能够构建符合 MCP 标准的后端服务，以便与支持 MCP 协议的客户端（如大语言模型应用）进行交互。通过 Blaxel SDK，您可以轻松托管和管理资源，注册和执行工具，并定义 Prompt 模板，从而为您的 LLM 应用提供强大的上下文服务框架。

主要功能点

  • 资源管理: 虽然文档中没有明确提及资源管理，但 MCP 服务器的核心职责之一是管理资源，推测该 SDK 支持资源的托管和访问控制。（仓库代码未明确体现资源管理相关功能，此处为基于MCP定义的推测）
  • 工具注册与执行: 允许开发者注册和执行工具 (Tools)，并提供示例代码展示如何定义和注册一个简单的天气工具。这使得 LLM 客户端可以通过 MCP 服务器调用这些工具。
  • Prompt 模板支持: 虽然文档中没有直接展示 Prompt 模板的定义和渲染，但 MCP 服务器的定义包含了 Prompt 模板功能，推测 SDK 具备支持 Prompt 模板的能力。（仓库代码未明确体现Prompt模板相关功能，此处为基于MCP定义的推测）
  • JSON-RPC 通信: MCP 服务器通过 JSON-RPC 协议与客户端通信，SDK 内部实现了基于 WebSocket 的 'BlaxelMcpServerTransport'，支持与 MCP 客户端进行标准化数据交换。
  • 多种传输协议支持: SDK 支持 'BlaxelMcpServerTransport' (WebSocket) 和 'StdioServerTransport'，为不同部署环境提供灵活的传输协议选择。

安装步骤

  1. 安装 Node.js: 确保您的开发环境已安装 Node.js v18 或更高版本。
  2. 安装 Blaxel CLI: 按照 README.md 中的指引安装 Blaxel CLI 工具： 
    curl -fsSL https://raw.githubusercontent.com/beamlit/toolkit/preview/install.sh | BINDIR=$HOME/.local/bin sh
  3. 登录 Blaxel 平台: 使用 Blaxel CLI 登录您的工作区： 
    bl login YOUR-WORKSPACE
  4. 安装 npm 包: 在您的项目中安装 '@blaxel/sdk' npm 包: 
    npm install @blaxel/sdk
    或者使用 yarn: 
    yarn add @blaxel/sdk

服务器配置

MCP 客户端需要配置以下信息以连接到 MCP 服务器。以下是一个 JSON 格式的配置示例，您可以根据实际情况进行调整：

{
  "server name": "WeatherMCP",  // MCP 服务器的名称，可自定义
  "command": "bl serve --hotreload", // 启动 MCP 服务器的命令，使用 Blaxel CLI 提供的 serve 命令，并开启热重载方便开发
  "args": [] // 启动命令的参数，此处为空，如有需要可添加其他参数
}

配置信息说明:

  • 'server name': 为您的 MCP 服务器指定一个易于识别的名称。
  • 'command': 指定启动 MCP 服务器的命令。'bl serve --hotreload' 是使用 Blaxel CLI 启动本地开发服务器的便捷方式，'--hotreload' 参数支持代码热重载，提高开发效率。
  • 'args': 命令的参数列表。在基础配置中，通常无需额外参数。您可以根据高级配置需求添加参数，例如指定端口或主机地址等。（仓库文档未提及其他启动参数，此处留空）

MCP 客户端配置示例 (非 SDK 代码，仅为配置示例):

假设您的 MCP 客户端是一个 LLM 应用，您需要在其配置中指定上述 JSON 信息，以便客户端能够找到并连接到您的 Blaxel MCP 服务器。具体的配置方式取决于您的 MCP 客户端实现。

基本使用方法

  1. 创建 MCP 服务器项目: 使用 Blaxel CLI 创建一个新的 MCP 服务器项目： 
    bl create-mcp-server my-mcp-server
cd my-mcp-server
  2. 查看示例代码: 'my-mcp-server' 目录下包含一个基本的 MCP 服务器示例代码 'index.ts'，展示了如何使用 '@blaxel/sdk' 创建 MCP 服务器并注册一个简单的工具。
  3. 启动 MCP 服务器: 在 'my-mcp-server' 项目目录下，使用 Blaxel CLI 启动 MCP 服务器： 
    bl serve --hotreload
    这将启动一个本地开发服务器，监听默认端口 (通常为 8080)。
  4. 连接 MCP 客户端: 配置您的 MCP 客户端，使其能够连接到运行在本地的 MCP 服务器。客户端需要配置服务器的地址（例如 'ws://localhost:8080'，如果使用 WebSocket 传输协议）和启动命令等信息（如上述 服务器配置 部分所示）。
  5. 部署 MCP 服务器: 当您完成开发和测试后，可以使用 'bl deploy' 命令将 MCP 服务器部署到 Blaxel 平台。

通过以上步骤，您可以使用 Blaxel SDK 快速搭建和部署 MCP 服务器，为您的 LLM 应用提供强大的工具和上下文服务支持。

信息

分类

开发者工具

访问项目