@contextvm/mcp-sdk

中文文档
1.30.0发布于 2026/06/19MITTypeScriptESM + CJS近 30 天下载 4635

用于 TypeScript 的轻量级 Stdio 聚焦型式上下文协议 SDK

中文使用文档
文档目录17 节
  1. 概览
  2. 分叉范围
  3. 安装
  4. 快速启动
  5. 核心概念
  6. 服务器和运输
  7. 工具、资源、提示
  8. 能力:取样、诱导和任务
  9. JSON Schema 验证( opt- in)
  10. 客户
  11. 节点.js 兼容性
  12. 软件包导出
  13. 出版说明
  14. 文档
  15. 释放工作流程
  16. 捐款
  17. 许可证

@contextvm/mcp-sdk (英语) MIT licensed

目录

概览

@contextvm/mcp-sdk 是用于ContextVM的上层MCP TypeScript SDK和其他仅需要MCP协议核心+的局部进程集成的轻量级叉 stdio 运输.

此分叉保留了核心协议运行时间和高端客户端/服务器API,同时有意去除HTTP,SSE,WebSocket,Express,Hono等面向OAuth的表面,这些表面增加了重量而无助于stdio使用大小写.

这使得:

  • 创建曝光资源、提示和工具的 MCP 服务器
  • 构建可连接本地 MCP 服务器的 MCP 客户端
  • 使用保留 stdio 依赖足迹较小的运输

分叉范围

在此软件包中支持 :

此分叉显然未包含:

  • 可流式HTTP运输
  • 遗留的SSE运输
  • 捷运和Hono一体化
  • OAuth/自动帮助堆栈
  • 浏览器/网络传输层

安装

npm install @contextvm/mcp-sdk zod

此 SDK 对等端依赖 zod 用于计划验证. 包内部从 zod/v4,同时仍然与使用 Zod v3.25 或以后的项目相兼容.

快速启动

import { McpServer } from '@contextvm/mcp-sdk/server';
import { StdioServerTransport } from '@contextvm/mcp-sdk/server/stdio';
import { z } from 'zod';

const server = new McpServer({
    name: 'example-server',
    version: '1.0.0'
});

server.tool('echo', { message: z.string() }, async ({ message }) => ({
    content: [{ type: 'text', text: message }]
}));

const transport = new StdioServerTransport();
await server.connect(transport);

核心概念

服务器和运输

MCP 服务器一般用 McpServer 连接到 StdioServerTransport 用于当地、由流程产生的整合.

工具、资源、提示

  • 工具 让 LLM 请求您的服务器采取行动( 计算、 副作用、 网络呼叫) .
  • 资源 将客户端能够向用户或模型显示的只读数据曝光.
  • 提示 用于帮助用户以一致的方式与模型交谈的可重复使用的模板.

保留的服务器表面仍然包括工具、资源、提示、完成、记录、引出、取样和实验任务.

能力:取样、诱导和任务

SDK包括更高级的更丰富的工作流程能力:

  • 取样:服务器侧工具可以要求连接客户端运行LLM补全.
  • 形式诱导:工具可以通过结构化形式请求非敏感输入.
  • URL 诱导:服务器可以要求用户在浏览器中完成安全流(例如API密钥条目,支付,OAuth).
  • 任务(实验): 长期的工具呼叫可以被转换成任务,由您进行投票或稍后恢复.

JSON Schema 验证( opt- in)

工具 outputSchema (在客户端)验证和(在服务器上)引出响应验证 选入默认情况下, SDK 不捆绑一个 JSON Schema 校验器, 因此这些响应无需验证即可返回 .

要启用校验, 导入 AjvJsonSchemaValidator 从专用子路径传到客户端和/或服务器:

import { Client } from '@contextvm/mcp-sdk/client';
import { AjvJsonSchemaValidator } from '@contextvm/mcp-sdk/validation/ajv';

const client = new Client(
    { name: 'my-client', version: '1.0.0' },
    { jsonSchemaValidator: new AjvJsonSchemaValidator() }
);

保持验证选择性意味着 ajv 运行时间只有在您实际导入验证器时才会被加载——不需要输出验证的消费者会用更小的捆绑. 请注意: McpServer 仍直接(通过Zod)验证其自己的工具输入/输出,独立于这个可选的JSON Schema验证器.

这些更高级的能力被保存在以斯地迪奥为主的分叉中.

客户

高级别 Client 类连接 MCP 服务器于保留位置 StdioClientTransport 并揭露援助者 listTools, (中文(简体) ), callTool, (中文(简体) ), listResources, (中文(简体) ), readResource, (中文(简体) ), listPrompts,以及 getPrompt。 。 。 .

节点.js 兼容性

这个分叉目标为Node.js 18+并被优化为以地铁为主的集成.

软件包导出

  • @contextvm/mcp-sdk
  • @contextvm/mcp-sdk/client
  • @contextvm/mcp-sdk/client/stdio
  • @contextvm/mcp-sdk/server
  • @contextvm/mcp-sdk/server/stdio
  • @contextvm/mcp-sdk/experimental
  • @contextvm/mcp-sdk/experimental/tasks

出版说明

本套件拟作为公共 npm 套件在 @contextvm/mcp-sdk 名称。 公布的柏球只包括: dist 输出.

文档

释放工作流程

以 npm run build,检查柏油球 npm pack --dry-run,并与 npm publish --access public 一经 @contextvm/mcp-sdk 范围准备好了.

捐款

GitHub网站欢迎提出问题和拉动请求 https://github.com/ ContextVM/mcp-sdk 互联网档案馆的存檔,存档日期2013-12-21。 。 。 .

许可证

这个项目根据麻省理工学院许可证获得许可——见 自由主义 详细文件.

版本与发布记录

@contextvm/mcp-sdk 共发布 11 个版本,首次发布于 2026/03/22;过去 12 个月发布了 11 个版本。

版本发布日期距今
1.30.0latest2026/06/194 个月前
1.29.32026/06/194 个月前
1.29.22026/06/184 个月前
1.29.12026/06/124 个月前
1.29.02026/06/124 个月前
1.28.02026/03/267 个月前

其他发布通道:next → 1.27.1-contextvm.2。

关于 @contextvm/mcp-sdk 的常见问题

@contextvm/mcp-sdk 是什么?

用于 TypeScript 的轻量级 Stdio 聚焦型式上下文协议 SDK

如何安装 @contextvm/mcp-sdk?

在项目目录运行 npm install @contextvm/mcp-sdk,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:zod(^3.25 || ^4.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@contextvm/mcp-sdk 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@contextvm/mcp-sdk 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@contextvm/mcp-sdk 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@contextvm/mcp-sdk 可以商用吗?

@contextvm/mcp-sdk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@contextvm/mcp-sdk 的下载量有多少?

根据 npm 官方下载统计,@contextvm/mcp-sdk 在 2026/10/11 – 2026/11/09 这 30 天内被下载 4,635 次,日均约 155 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@contextvm/mcp-sdk 还在维护吗?

最新版本 1.30.0 发布于 2026/06/19(4 个月前);至今共发布 11 个版本,其中过去 12 个月发布了 11 个;首次发布于 2026/03/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。