# @contextgraphprotocol/typescript-sdk 中文文档

规范地址：https://npmcn.com/package/%40contextgraphprotocol/typescript-sdk/

版本：0\.1\.0
npm 元数据更新时间：2026-07-23T20:48:05.735Z
中文译文更新时间：2026-11-10T16:55:58.123Z
软件包许可：MIT OR Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40contextgraphprotocol/typescript-sdk
原文对照：https://npmcn.com/package/%40contextgraphprotocol/typescript-sdk/?lang=original

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

- 包体积（解压后）：18.1 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-07-23T20:48:05.246Z
- 最新版本发布：2026-07-23T20:48:05.532Z
- 近 30 天下载量：6899（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 1 个）

## 中文简介

零依赖性 TypeSDK 用于构建相容的上下文图形协议提供者.

## 安装

```sh
npm install @contextgraphprotocol/typescript-sdk
```

也可以使用：`pnpm add @contextgraphprotocol/typescript-sdk`、`yarn add @contextgraphprotocol/typescript-sdk`、`bun add @contextgraphprotocol/typescript-sdk`

## README

# @ contextgraph/ sdk — TypeScript (英语)

用于构建的零依赖性类型SDK **符合者** 背景图 礼宾提供者。 执行一个接口,把它交给运行时间,然后你 有个供货商会用线形JSON线 绕过楼梯 和评断Rust参考商的套房一样.

> 这是第二次独立执行(在Rust提及之后),以及 它传递了完全符合的套件,即: 协议的"通过合同强制执行,而非约定"索赔. 见 [`sdk/README.md`](https://npmcn.com/package/%40contextgraphprotocol/README.md) 为多语言图片.

## 安装

```sh
npm install @contextgraph/sdk
```

## 写入提供者

```ts
import { runStdioProvider, budgetTokens, type Provider } from "@contextgraph/sdk";

const provider: Provider = {
  info: () => ({
    name: "my-docs-provider",
    version: "0.1.0",
    // Nothing leaves the machine ⇒ declare the honest local-only egress scope.
    data_flow: { reads: true, writes: false, egress: false, egress_scopes: ["local-only"] },
  }),
  capabilities: () => ({ query: { kinds: ["doc"] }, correlation: true, verify: true }),
  query: () => ({
    frames: [
      {
        id: "doc:1",
        kind: "doc",
        title: "Getting started",
        content: "Install the binding, then implement the required methods.",
        content_digest: `sha256:${"11".repeat(32)}`,
        score: 0.9,
        // token_cost MUST equal ceil(utf8_len(content)/4) — the SDK computes it.
        token_cost: budgetTokens("Install the binding, then implement the required methods."),
        valid_from: "2026-01-01T00:00:00Z",
        provenance: [{ type: "file", uri: "file:///docs/start.md", range: "L1-10", digest: `sha256:${"11".repeat(32)}` }],
        citation_label: "start.md L1-10",
        relations: [],
      },
    ],
    truncated: false,
  }),
};

runStdioProvider(provider);
```

运行时间处理一个主机驱动器的整个生命周期——握手,查询 (选择相关性) `id`),核实,关闭——并保持与打入的活 错误在错误的行上而不是崩溃 .

## 它给你什么

-   **电线类型** (单位:千美元)`ContextFrame`, (中文(简体) ), `ContextQuery`, (中文(简体) ), `Capabilities`, (中文(简体) ), `Envelope`, (...) (中文(简体) ) 由JSON Schema所镜出——语言中性的真理来源.
-   **`runStdioProvider(provider)`** ——stdio生命周期循环.
-   **`budgetTokens(content)`** 峡谷B3成本, `ceil(utf8_len/4)`。 。 。 .
-   一个可运行 **实例提供者** (单位:千美元)`examples/example-docs.ts`传递所有 7次合规检查.

## 证明它符合规定

构建, 然后对您的提供者运行参考套件 :

```sh
npm run build
# from the repository root, with the Rust bins built (cargo build --workspace --bins):
./.github/scripts/conformance-external.sh -- node sdk/typescript/dist/examples/example-docs.js
```

绿色跑步是机器可以检查的声称 你的提供者尊重 议定书——每次执行都要遵守同一条.

## 许可证

MIT OR Apache-2.0,匹配上下文图形协议的框.

## 常见问题

### @contextgraphprotocol/typescript-sdk 是什么？

零依赖性 TypeSDK 用于构建相容的上下文图形协议提供者\.

### 如何安装 @contextgraphprotocol/typescript-sdk？

在项目目录运行 npm install @contextgraphprotocol/typescript-sdk，或使用 pnpm add / yarn add / bun add。

### @contextgraphprotocol/typescript-sdk 支持 TypeScript 吗？

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

### @contextgraphprotocol/typescript-sdk 支持 ESM 还是 CommonJS？

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

### @contextgraphprotocol/typescript-sdk 需要什么版本的 Node\.js？

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

### @contextgraphprotocol/typescript-sdk 可以商用吗？

@contextgraphprotocol/typescript-sdk 使用 MIT OR Apache-2\.0 许可。可在 MIT、Apache-2\.0 中任选其一遵守。选择 MIT 时，宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @contextgraphprotocol/typescript-sdk 的下载量有多少？

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

### @contextgraphprotocol/typescript-sdk 还在维护吗？

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