deepseek-harness/packages/api/README.zh.md

description, kind

description	kind
应用 Remote 层的包映射：类型化的 Client 到 Host 能力调用、结果与转发事件，供用户与维护者浏览该组。	package-group

api/ — Remote API 层

English | 中文

概述

api/ 组提供应用的 Remote 层：Client 环境可以调用运行在 Host 上的业务能力——管理目标、运行命令、查看插件清单、发现文件与会话引用——调用方式是类型化方法，并接收结果或转发的 Host 事件。remotes 决定暴露哪些能力、以及每次调用如何到达正确会话的 agent；gateway 在 Client 与 Host 之间承载调用及其结果。技术栈运行在应用共享的 Connection 之上；流式会话数据刻意不在其中。

目录

• 包
• 相关文档
• 开发备注

---

包

下面这些包共同提供 Remote 层；穷尽式约定以各包 README 为准。

包	职责	ctx key
remotes/	决定 Client 可以消费哪些 Host 能力与事件。	—
gateway/	承载带类型的单次调用、多路复用 stream 与转发的 Host 事件。	ctx.typertGateway / ctx.remote
session-controller/	拥有 Session 命令、历史 stream、实时控制状态与 Agent/Session 身份策略。	ctx.sessionController / ctx.remote.session
settings-controller/	拥有 settings 域各 seam 之上的配置界面读写。	ctx.settingsController、ctx.credentialsController / ctx.remote.settings、ctx.remote.credentials
workspace-controller/	拥有 Workspace 变更与完整 Client Workspace 投影。	ctx.workspaceController / ctx.remote.workspace

Remote 调用沿 Client → Host 方向运行在应用共享的 Connection 之上。API Gateway 拥有 Remote 传输，各 controller 包分别拥有 Session、配置界面与 Workspace 行为。没有 Remote 定义的 endpoint 会回退到应用的 API Proxy。

---

相关文档

先读 API Gateway 参考以端到端了解 Remote 模型，再读 Typert 子系统页了解共享定义，以及载体与回退包了解调用如何传输、没有 Remote 定义的 endpoint 如何被服务。

• API Gateway 参考——Typert API Gateway 的现状参考：编程模型、生成流水线与运行时调用。
• Typert 子系统参考——protocol、Gateway 与消费方装配共享的公共约定。
• Connection——每次 Remote 调用背后的 RPC 载体、/api 信任围栏与响应封装。
• API Proxy——没有 Remote 描述符的 endpoint 的回退路径。

开发备注

维护者的工作上下文——点击展开

无。