Streamable HTTP Transport for Web Fetch API

面向 Web Fetch API 的 Streamable HTTP 传输

此代码库包含 EdgeStreamableHTTPTransport，这是一种兼容边缘环境的 Model Context Protocol（MCP）服务端传输方式。它通过服务器发送事件（SSE）和标准 HTTP 请求实现实时双向通信，适用于 Hono 等现代 Web 框架。该传输方式旨在实现 MCP Streamable HTTP 传输规范，并针对边缘环境进行了优化。

概述

本项目旨在为需要实时数据流的应用提供可靠高效的传输层，尤其适用于使用 Model Context Protocol 的应用。项目使用 TypeScript 构建，旨在轻松集成到各种服务端环境中，尤其是运行在边缘计算平台上的环境。

软件包

此单体代码库包含以下主要软件包：

• packages/stremeable-http-transport：
  • 实现 EdgeStreamableHTTPTransport。
  • 支持 SSE 流式传输和直接 HTTP 响应。
  • 提供会话管理功能（有状态和无状态模式）。
  • 通过可扩展的事件存储支持断点续传。
  • 更多详情请参阅软件包 README。

开发

本项目采用现代开发技术栈，以确保代码质量、可维护性和贡献便利性。

工具

开发环境配置了以下工具：

• TypeScript：提供强类型和现代 JavaScript 功能。
• pnpm workspaces：用于管理单体代码库的结构和依赖项。
• Vitest：用于快速、可靠的单元测试和集成测试。
• Biome：用于统一代码格式并进行代码检查。
• tsdown：用于将 TypeScript 代码高效打包为 CJS 和 ESM 格式。
• Changeset：用于简化版本管理和变更日志生成。
• GitHub Actions：用于自动执行 CI/CD 流水线，包括测试、构建和发布。
• Lefthook：用于管理 Git 钩子。

关键脚本（在代码库根目录运行）

• pnpm install：安装所有软件包的依赖项。
• pnpm run build：构建所有软件包。
• pnpm run test：运行所有软件包的测试。
• pnpm run check：检查整个代码库的代码并统一格式。
• pnpm run dev：启动开发环境，通常会监视相关软件包的变化。
• pnpm changeset：创建新的版本变更集。
• pnpm changeset version：应用变更集并更新软件包版本。

有关更具体的脚本，请参阅根目录及各软件包中的 package.json。

贡献

欢迎贡献！请阅读 CONTRIBUTING.md 指南，了解如何为本项目作出贡献，包括报告错误、提出功能建议和提交拉取请求。

此外，请遵守我们的 CODE_OF_CONDUCT.md。

安全

有关安全漏洞，请参阅我们的 SECURITY.MD 政策。

许可证

本项目根据 LICENSE 文件中的条款授权。