@ codespar/ 类型

零依赖性 TypeScript 包定义了 CodeSpar 运行时间的共享会话接口等级.

任何执行的运行时间 SessionBase ——所管理的CodeSpar后端,Anthropic管理代理,自托管服务器,或测试双人——是SDK生态系统中的一等公民. 该合同是运行时间和运行在它们上方的工具之间唯一的接合.

安装

npm install @codespar/types

接口

SessionBase

任何运行时间都必须执行最小接口 .

import type { SessionBase } from "@codespar/types";

interface SessionBase {
  readonly id: string;
  readonly status: "active" | "closed" | "error";

  execute(toolName: string, params: Record<string, unknown>): Promise<ToolResult>;
  send(message: string): Promise<SendResult>;
  sendStream(message: string): AsyncIterable<StreamEvent>;
  connections(): Promise<BaseConnection[]>;
  close(): Promise<void>;
}

Session

编码的特有扩展 SessionBase,用于通过管理的代码Spar API创建会话.

import type { Session } from "@codespar/types";

interface Session extends SessionBase {
  proxyExecute(request: ProxyRequest): Promise<ProxyResult>;
  authorize(serverId: string, config: AuthConfig): Promise<AuthResult>;

  // Tool discovery + connection wizard (codespar_discover / codespar_manage_connections)
  discover(useCase: string, options?: DiscoverOptions): Promise<DiscoverResult>;
  connectionWizard(options: ConnectionWizardOptions): Promise<ConnectionWizardResult>;

  // Meta-tool wrappers — typed payloads, same wire as session.execute(...)
  charge(args: ChargeArgs): Promise<ChargeResult>;
  ship(args: ShipArgs): Promise<ShipResult>;
  shop(args: ShopArgs): Promise<ShopResult>;

  // Async settlement (codespar_charge / codespar_pay)
  paymentStatus(toolCallId: string): Promise<PaymentStatusResult>;
  paymentStatusStream(
    toolCallId: string,
    options: PaymentStatusStreamOptions,
  ): Promise<PaymentStatusResult>;

  // Async verification (codespar_kyc)
  verificationStatus(toolCallId: string): Promise<VerificationStatusResult>;
  verificationStatusStream(
    toolCallId: string,
    options: VerificationStatusStreamOptions,
  ): Promise<VerificationStatusResult>;

  mcp?: {
    url: string;
    headers: Record<string, string>;
  };
}

isCodesparSession

将护卫类型缩小a SessionBase 改为 Session 当您需要特定代码的方法时.

import { isCodesparSession } from "@codespar/types";

function useSession(session: SessionBase) {
  if (isCodesparSession(session)) {
    // session is Session here — proxyExecute, authorize, mcp available
    const config = session.mcp;
  }
}

电线类型

已输入的元工具外观( T)shop(), (中文(简体) ), charge(), (中文(简体) ), ship(),.)需要运行时间来执行元工具. 这些电线类型是合同 @codespar/sdk 是一个客户端结束 execute("codespar_<tool>", args)。在自办的运行时间没有登记该元工具的执行的情况下,调用返回 Tool not registered。 + 外观类型为 MIT 和可自宿; 执行时间为 SDK 点的运行时间.

符合性测试

@codespar/types 船舶a runContractSuite 帮助者 a /testing 子路径导出 。 它登记一个测试套件 用来锻炼五个 SessionBase 方法对抗活的 HTTP 端点.

// my-runtime.test.ts
import { runContractSuite } from "@codespar/types/testing";

// Skip unless the env vars are present
const apiKey = process.env["MY_RUNTIME_API_KEY"];
const baseUrl = process.env["MY_RUNTIME_BASE_URL"] ?? "http://localhost:3000";

if (apiKey) {
  runContractSuite(baseUrl, apiKey);
}

该套间开放会话通过 POST /v1/sessions 与 Authorization: Bearer <apiKey> 和身体状况 { servers: [], user_id: "contract-suite" }每条腿都说 201 载体 id, (中文(简体) ), status: "active",所贴 user_id, (中文(简体) ), servers 联合国 string[] 包括每个张贴的id)和可解析 created_at ——田园 @codespar/sdk 建立会议基础。 然后验证:

• execute() 调用注册工具并返回 a ToolResult
• send() 返回 a SendResult 带有 message 字段
• sendStream() 产量类型良好 StreamEvent包括一个 done 事件
• connections() 回答 2xx 为 { servers },每个条目 id 财务报告和审定财务报表 connected (单位:千美元)tools,当存在时,必须是数组)
• close() 过渡 session.status 改为 "closed"

见 文件/海关会议-运行时间 为一份全面实施指南.

还需要吗?

需要治理、预算限制和代理付款的审计线索? 代码Spar 企业 在这些MCP服务器上添加了政策引擎,支付路由,以及合规模板.

许可证

麻省理工学院 - 代码.dev