@carrierllc/sdk

中文文档
0.2.36发布于 2026/11/06MITTypeScriptES Module零依赖近 30 天下载 3767

TypeScript client for the Carrier API, MCP server, and CLI.

原始使用文档

@carrierllc/sdk

TypeScript client for the Carrier API, the hosted MCP server, and the carrier CLI. intents.create issues one eSIM. call uses an OpenAPI operation id. Mcp speaks Streamable HTTP. Cli runs the binary with an argument list. restTools, mcpTools, and cliTools return plain tool objects. Pass inputSchema through the Vercel AI SDK jsonSchema() helper. This package does not depend on that SDK.

import { Carrier } from "@carrierllc/sdk"

const carrier = new Carrier(process.env.CARRIER_API_KEY ?? "")

const intent = await carrier.intents.create(
  { plan: "test_global_1gb", metadata: { order: "123" } },
  { idempotencyKey: "order_123" },
)

intents.create posts to /v1/connectivity/intents. Issuance requires a stable caller key matching [A-Za-z0-9][A-Za-z0-9_.:-]{0,199} (1–200 ASCII characters). The same key and body identify the original operation; they do not prove provider exactly-once completion. After transport/body loss, CarrierError has code: "outcome_unknown", the original idempotencyKey, and retryable: false. The SDK sends once, disables redirects, and never generates a replacement key. Preserve the key and reconcile; do not automatically retry or reissue. products.create posts to /v1/connectivity/products. The price on a product is catalogue data. Neither call debits a wallet.

import { Cli, Mcp, restTools } from "@carrierllc/sdk"

const accounts = await carrier.call("list_reseller_accounts")
const issued = await carrier.call("create_connectivity_intent", {
  body: { plan: "test_global_1gb" },
  idempotencyKey: "order_123",
})

const session = new Mcp(process.env.CARRIER_OCS_API_TOKEN ?? "")
const tools = await session.listTools()
await session.callTool("list_subscribers", { limit: 5 })

const cli = new Cli()
await cli.run(["subscribers", "list", "--limit", "5"])
const agentTools = restTools(carrier)

new Mcp(token, { auth: "bearer" }) sends an OAuth access token or a Clerk organization API key. The default sends ?TOKEN= to https://mcp.carrier.llc/mcp. Cli never invokes a shell. Catalog entries marked internal do not accept a customer API key.

npm install @carrierllc/[email protected] installs this surface. 0.1.0 only creates connectivity intents and products. The published tarball is the compiled dist output, including the generated operation catalog.

版本与发布记录

@carrierllc/sdk 共发布 36 个版本,首次发布于 2026/09/23;过去 12 个月发布了 36 个版本。

版本发布日期距今
0.2.36latest2026/11/063 天前
0.2.352026/11/053 天前
0.2.332026/11/054 天前
0.2.322026/11/054 天前
0.2.312026/11/054 天前
0.2.302026/11/054 天前

关于 @carrierllc/sdk 的常见问题

@carrierllc/sdk 是什么?

TypeScript client for the Carrier API, MCP server, and CLI.

如何安装 @carrierllc/sdk?

在项目目录运行 npm install @carrierllc/sdk,或使用 pnpm add / yarn add / bun add。

@carrierllc/sdk 支持 TypeScript 吗?

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

@carrierllc/sdk 支持 ESM 还是 CommonJS?

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

@carrierllc/sdk 需要什么版本的 Node.js?

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

@carrierllc/sdk 可以商用吗?

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

@carrierllc/sdk 的下载量有多少?

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

@carrierllc/sdk 还在维护吗?

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