# @byokit/mcp 中文文档

规范地址：https://npmcn.com/package/%40byokit/mcp/

版本：0\.2\.1
npm 元数据更新时间：2026-10-29T08:14:49.530Z
中文译文更新时间：2026-11-09T20:40:25.347Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40byokit/mcp
原文对照：https://npmcn.com/package/%40byokit/mcp/?lang=original
项目主页：https://github.com/umeranjum17/byokit#mcp
源码仓库：https://github.com/umeranjum17/byokit

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：45 kB，12 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18
- 运行依赖：4 个
- 首次发布：2026-10-01T08:50:06.354Z
- 最新版本发布：2026-10-29T08:14:49.065Z
- 近 30 天下载量：1740（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

TypeScript套件让人们通过他们已经支付的人工智能计划,在网络,电话和桌面上登录到你的应用程序.

## 安装

```sh
npm install @byokit/mcp
```

也可以使用：`pnpm add @byokit/mcp`、`yarn add @byokit/mcp`、`bun add @byokit/mcp`

## README

# @ byokit/ mcp

在可流的HTTP上托管了工具和资源. 官方MCP TypeScript SDK 拥有 协议,包括初始化、事件流和会话终止。 这个包 添加设备签名, 在每个请求上认证, 以及绑定在一个人身上的会话 . 它运行于节点22.18上或后期;是一个服务器包,没有浏览器或电话条目.

## 安装片段

```sh
npm install @byokit/mcp zod@4
```

设备批准后设置 `MCP_URL` 到您的 HTTPS 端点和 `MCP_TOKEN` 改为 在您的外壳的私人环境中返回的访问符 。 这些是一行加法:

```sh
# Claude Code
claude mcp add --transport http demo "$MCP_URL" --header "Authorization: Bearer $MCP_TOKEN"
# Codex
codex mcp add demo --url "$MCP_URL" --bearer-token-env-var MCP_TOKEN
# Cursor (opens the install dialog; macOS uses open, Linux uses xdg-open)
node --input-type=module -e 'import {spawnSync} from "node:child_process"; const config=Buffer.from(JSON.stringify({url:process.env.MCP_URL,headers:{Authorization:`Bearer ${process.env.MCP_TOKEN}`}})).toString("base64"); spawnSync(process.platform === "darwin" ? "open" : "xdg-open", [`cursor://anysphere.cursor-deeplink/mcp/install?name=demo&config=${encodeURIComponent(config)}`], {stdio:"ignore"});'
```

头和安装-链接格式保存客户端配置中的符. 保留 那个配置的私人。 目前还没有客户端自动启动设备流. 命令格式 : [HTTP 添加](https://code.claude.com/docs/en/mcp), (中文(简体) ), [远程添加](https://developers.openai.com/codex/mcp/), (中文(简体) ), [安装链接](https://prod.cursor.com/docs/mcp/install-links)。 。 。 .

## 最小服务器

```ts
import { createServer } from 'node:http';
import { z } from 'zod';
import { overrideStore } from '@byokit/secrets';
import { deviceFlow, hostedMcp } from '@byokit/mcp';

// In-memory demo only. Supply your app's secrets backend for persistent grants.
const auth = deviceFlow({
  store: overrideStore({}),
  verificationUri: 'http://127.0.0.1:3000/approve',
});
const kit = hostedMcp({
  name: 'demo', version: '0.1.0', url: 'http://127.0.0.1:3000/mcp', auth, device: auth,
  mount(m) {
    m.tool('hello', { inputSchema: { name: z.string() } }, async ({ name }, context) => {
      await context.progress(1, 1);
      return { content: [{ type: 'text', text: `${context.principal.name} says hello to ${name}.` }] };
    });
    m.resource('profile', 'demo://profile', { mimeType: 'text/plain' }, (uri, context) => ({
      contents: [{ uri: uri.href, text: context.principal.name, mimeType: 'text/plain' }],
    }));
  },
});
const http = createServer((req, res) => { void kit.handle(req, res); });
http.listen(3000, '127.0.0.1');

// In your authenticated account page, after Umer explicitly approves the typed code:
function approveForDemoUser(typedCode: string) {
  auth.approve(typedCode, { id: 'umer', name: 'Umer' });
}
// On shutdown: await kit.close(); http.close();
```

主机拥有它的收听器,帐号页和部署. 在生产和生产中使用HTTPS 通过公共终点为 `url`该工具包根据该URL验证主机和原产地; 您的反向代理必须保存公共主机。 在这条路径及其上挂载处理器 设备子路径。 它不为批准页服务,也不执行账户登录.

## 自动流量

1.  贾森后 `{}` 改为 `/mcp/device/code`。答复中包含 `device_code`, (中文(简体) ), `user_code`, (中文(简体) ), `verification_uri`, (中文(简体) ), `expires_in` 财务报告和审定财务报表 `interval` (秒数).
2.  显示校验地址和用户代码 。 那个人签到主机帐户 并明确批准。 认证的CSRF保护的页面呼叫 `auth.approve(userCode, principal)`;设备不能选择自己的本能.
3.  贾森后 `{ "device_code": "…" }` 改为 `/mcp/device/token`,不会比 `interval`。 。 。 . `pending` 表示仍需批准; `busy` 意思是等到投票前再说. 核准数量 `access_token`, (中文(简体) ), `token_type: "Bearer"` 财务报告和审定财务报表 `expires_in` 一次就是这样.
4.  发送 `Authorization: Bearer …` 在每一个 POST 上,获取和删除 `/mcp`. SDK 软件 谈判初始化并供应会话头. 取消赠款 `await auth.revoke(token)`; 过期或被撤销的令牌停止对现有会话的工作.

同一流量可直接与 `begin()`, (中文(简体) ), `approve()` 财务报告和审定财务报表 `poll()`。设备代码 5分钟后失效;30天后失效;待投票时违约为5个 秒数。 一切皆能现相. 工具箱只保留待发地图中的设备编码散列 并将SHA-256号接通式散列车作为提供的名称储存 `@byokit/secrets` `Keystore`。没有保存纯文本访问符。 一个密封的 `fileStore({ path, passphrase })` 或者OS密钥环后端可以坚持这些授予;主机通过每一个路径和秘密. 该工具包不读取环境变量、日志证书,也不检查其他应用程序.

`McpError.code` 区分 `unauthorized`, (中文(简体) ), `expired`, (中文(简体) ), `invalid`, (中文(简体) ), `pending`, (中文(简体) ), `busy`, (中文(简体) ), `session` 财务报告和审定财务报表 `failed`;它的信息是一个固定的平话. 未知的处理器和 存储例外成为 `failed`,而不披露其原始消息或堆栈. 工具返回出错结果;资源返回协议出错. 成功处理器 结果为应用数据:主机必须保留它们和它自己的HTTP日志中的证书.

`Authenticator.authenticate(token)` 是未来授权计划的接合点. OAuth 发现、重定向和刷新没有执行。 这个设备流是套件 设置 API,不是 OAuth 授权服务器 .

## 会议和部署

每个初始化都会在 SDK 服务器上挂载新的定义. 回电收到 当前请求的本金,取消信号和一个进度发送器。 同时 请求有不同的上下文。 默认会话持续30分钟( E)`sessionMs`和 无法被他人重复使用。 设备批准和会话处于内存中: 使用一个 过程,或粘接的路由。 恢复损失等待批准和会议;已保存 象征性赠款留在主店。 连续续会和分期会议 本版本未提供。 当请求打开时授权流; 主机 账户访问变更时,应当取消长期运行的工作.

`maxPending` 财务报告和审定财务报表 `maxSessions` 默认为 1000。 把设备端点放在后面 主机的每源速率限制 。 托肯没有隐含的工具范围;主机执行它 使用所提供本金的回调权限. `close()` 结束工具箱的会话 并拒绝更多的请求,而主机拥有关闭其收听器.

## 检查

从寄存器根 :

```sh
export TMPDIR=$(mktemp -d /tmp/bk-XXXX)
trap 'rm -rf "$TMPDIR"' EXIT
npm run build
npm run check
sh scripts/test.sh 'packages/mcp/test/*.test.ts'
npm run smoke:pack
```

测试使用真实的SDK客户端和回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回回 存储。 不需要账户、外部网络或模型.

## 常见问题

### @byokit/mcp 是什么？

TypeScript套件让人们通过他们已经支付的人工智能计划,在网络,电话和桌面上登录到你的应用程序\.

### 如何安装 @byokit/mcp？

在项目目录运行 npm install @byokit/mcp，或使用 pnpm add / yarn add / bun add。

### @byokit/mcp 支持 TypeScript 吗？

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

### @byokit/mcp 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @byokit/mcp 需要什么版本的 Node\.js？

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

### @byokit/mcp 可以商用吗？

@byokit/mcp 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @byokit/mcp 的下载量有多少？

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

### @byokit/mcp 还在维护吗？

最新版本 0\.2\.1 发布于 2026/10/29（11 天前）；至今共发布 11 个版本，其中过去 12 个月发布了 11 个；首次发布于 2026/10/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。