Dropstone SDK
用于 Dropstone 代理运行时的类型安全 JS 客户端。SDK 会话继承 Dropstone 的跨界面记忆(Continuity)——与 CLI、聊天和 SDK 共享的持久记忆。
Dropstone JS/TS SDK 提供了一个类型安全的客户端,用于与 Dropstone 代理运行时 交互。它会将 dropstone serve 作为子进程启动,并为你提供一个指向它的类型化 HTTP 客户端。由于它运行的是与 CLI 相同的本地代理,每个 SDK 会话都会继承你的账户记忆——在 CLI、聊天或 SDK 中教一次,所有界面就都知道了(参见 记忆(Continuity))。
需要在 CI 中使用无头 API 访问?
对于纯程序化使用(CI 流水线、自动化、无服务器),请优先使用带 DROPSTONE_API_KEY 的 HTTP API。本页的 SDK 适用于在安装了 CLI 二进制的 Node 进程中嵌入交互式代理。
有关底层 HTTP API 的工作原理,请参阅 服务器 页面。
安装
从 npm 安装 SDK:
npm install @blankline/dropstone-sdk
无头 API 客户端
对于 CI 流水线、自动化和无服务器场景,你完全不需要 CLI。使用无头客户端,它通过 API 密钥直接与 Dropstone HTTP API 通信:
import { createDropstoneApi } from "@blankline/dropstone-sdk"
// 自动从环境中读取 DROPSTONE_API_KEY。
const dropstone = createDropstoneApi()
const resp = await dropstone.chat.completions.create({
model: "dropstone-fast", // 或 "dropstone-pro" / "dropstone-heavy"
messages: [{ role: "user", content: "写一首关于调试的俳句。" }],
})
console.log(resp.choices[0].message.content)
console.log("费用: $" + resp.usage?.cost) // 计费金额,以美元为单位
获取 API 密钥
- 在 dropstone.io/dashboard 登录。
- 打开 dropstone.io/dashboard/settings 中的 设置 → API 并创建密钥——它看起来像
dsk_live_<43 个字符>。 - 将其设置为环境变量(或将
apiKey传递给createDropstoneApi):
export DROPSTONE_API_KEY=dsk_live_...
Note
请像对待密码一样对待你的 API 密钥。切勿将其提交到 git 或嵌入前端打包文件中。API 密钥请求按使用量从你的预付余额中计费——套餐配额不适用。参见 使用与限制。
流式传输的工作方式相同,并且客户端兼容 OpenAI——你可以将 OpenAI SDK 指向 Dropstone 的 base URL:
const stream = await dropstone.chat.completions.create({
model: "dropstone-fast",
stream: true,
messages: [{ role: "user", content: "数到 5。" }],
})
for await (const chunk of stream) {
process.stdout.write(chunk.choices?.[0]?.delta?.content ?? "")
}
完整参考请参阅 HTTP API 页面。
创建客户端
创建 dropstone 实例:
import { createDropstone } from "@blankline/dropstone-sdk"
const { client } = await createDropstone()
这会同时启动服务器和客户端。每个 SDK 方法都返回 { data, request, response },因此通过 .data 访问有效负载。
默认情况下,服务器以在该机器上运行 dropstone auth login 的用户身份登录。在无人值守的主机上没有这样的账户,因此请通过 config 传递 API 密钥和显式的权限允许列表:
const { client } = await createDropstone({
config: {
provider: {
dropstone: {
options: {
apiKey: process.env.DROPSTONE_API_KEY,
baseURL: "https://api.dropstone.io/api/v1",
},
},
},
permission: { "*": "deny", read: "allow", edit: "allow", glob: "allow", grep: "allow", bash: "allow" },
},
})
两个部分都是必需的。API 密钥在 /v1 处会被拒绝,并且默认的 build 代理在每次工具调用前都会询问,因此如果没有允许列表,运行会等待一个无人能给出的批准并挂起,而不是失败。在提示中发送 "agent": "accept all" 是允许列表的替代方案。参见 服务器 和 权限。
选项
| 选项 | 类型 | 描述 | 默认值 |
|---|---|---|---|
hostname | string | 服务器主机名 | 127.0.0.1 |
port | number | 服务器端口 | 4096 |
signal | AbortSignal | 用于取消的中止信号 | undefined |
timeout | number | 服务器启动超时时间(毫秒) | 5000 |
config | Config | 配置对象 | {} |
配置
你可以传递配置对象来自定义行为。实例仍然会读取你的 dropstone.json,但你可以在内联中覆盖或添加配置:
import { createDropstone } from "@blankline/dropstone-sdk"
const dropstone = await createDropstone({
hostname: "127.0.0.1",
port: 4096,
config: {
model: "dropstone/dropstone-pro",
},
})
console.log(`服务器运行在 ${dropstone.server.url}`)
dropstone.server.close()
记忆(Continuity)
Dropstone 为每个账户保留一个持久记忆。我们称之为 Continuity——由 CLI、聊天、VS Code 和 SDK 共享的跨界面记忆。在任何地方教一次,所有界面就都知道了。
通过 SDK 运行的会话使用与 CLI 相同的账户记忆。你在 CLI 中教的内容,SDK 会话已经知道,而 SDK 会话记录的内容也可以在 CLI 和聊天中获取。在每一轮中,代理在回答之前会自动回忆相关记忆,因此它不会重新学习已经知道的内容。
SDK 代理还可以直接读写记忆,使用与 CLI 相同的工具:
| 工具 | 用途 |
|---|---|
memory_recall | 回忆与当前任务最相关的经验 |
record_lesson | 保存持久经验(规则或事实) |
list_lessons | 显示它学到的关于你的一切 |
forget_lesson | 删除经验 |
Note
记忆需要登录 Dropstone。SDK 服务器读取与 CLI 相同的 auth.json,因此只需用 dropstone 登录一次,SDK 会话就会继承相同的账户记忆。如果未登录,则不会存储任何内容。
示例
从代码中声明偏好,它会以与 CLI 中相同的方式被记录——之后在 CLI 和聊天中可见:
const { client } = await createDropstone()
const session = await client.session.create({ body: { title: "教记忆" } })
await client.session.prompt({
path: { id: session.data.id },
body: {
parts: [{ type: "text", text: "记住这条长期规则:始终使用 bun,而不是 npm。" }],
},
})
Continuity 与 AGENTS.md
AGENTS.md 是你提交到 Git 的项目文件,用于团队约定——稳定、限定于仓库范围,并与任何克隆它的人共享。Continuity 是你的私有账户记忆:你在 CLI、聊天或 SDK 中教的内容会跟随你的账户跨界面和项目。它们解决不同的问题,并且最好配合使用——项目规则放在 AGENTS.md 中,个人跨界面记忆放在 Continuity 中。参见 规则 和 记忆。
会记住什么
记忆只存储你明确教给它的规则和事实——值得跨会话携带的偏好、约定和修正。它不同于单个会话的临时上下文,后者在会话结束后不会被保留。
有关 Dropstone 如何决定保留什么,请参阅 记忆 页面。
仅客户端
如果你已经有一个正在运行的 dropstone 实例,你可以创建客户端实例来连接它:
import { createDropstoneClient } from "@blankline/dropstone-sdk"
const client = createDropstoneClient({
baseUrl: "http://localhost:4096",
})
选项
| 选项 | 类型 | 描述 | 默认值 |
|---|---|---|---|
baseUrl | string | 服务器 URL | http://localhost:4096 |
fetch | function | 自定义 fetch 实现 | globalThis.fetch |
parseAs | string | 响应解析方法 | auto |
responseStyle | string | 返回样式:data 或 fields | fields |
throwOnError | boolean | 抛出错误而不是返回 | false |
类型
SDK 包含所有 API 类型的 TypeScript 定义。直接导入它们:
import type { Session, Message, Part } from "@blankline/dropstone-sdk"
所有类型都是从服务器的 OpenAPI 规范生成的,因此你在 TypeScript 中看到的名称与 服务器 的请求和响应结构一一对应。
错误
SDK 可能会抛出你可以捕获和处理的错误:
try {
await client.session.get({ path: { id: "invalid-id" } })
} catch (error) {
console.error("获取会话失败:", (error as Error).message)
}
结构化输出
你可以通过指定带有 JSON schema 的 format 来请求模型输出结构化 JSON。模型将使用 StructuredOutput 工具返回与你 schema 匹配的经过验证的 JSON。
基本用法
const result = await client.session.prompt({
path: { id: sessionId },
body: {
parts: [{ type: "text", text: "研究 Dropstone 并提供公司信息" }],
format: {
type: "json_schema",
schema: {
type: "object",
properties: {
company: { type: "string", description: "公司名称" },
founded: { type: "number", description: "成立年份" },
products: {
type: "array",
items: { type: "string" },
description: "主要产品",
},
},
required: ["company", "founded"],
},
},
},
})
// 访问结构化输出
console.log(result.data.info.structured_output)
// { company: "Dropstone", founded: 2024, products: ["Dropstone CLI"] }
输出格式类型
| 类型 | 描述 |
|---|---|
text | 默认。标准文本响应(无结构化输出) |
json_schema | 返回与提供的 schema 匹配的经过验证的 JSON |
JSON Schema 格式
使用 type: 'json_schema' 时,提供:
| 字段 | 类型 | 描述 |
|---|---|---|
type | 'json_schema' | 必需。指定 JSON schema 模式 |
schema | object | 必需。定义输出结构的 JSON Schema 对象 |
retryCount | number | 可选。验证重试次数(默认:2) |
错误处理
如果模型在所有重试后仍无法生成有效的结构化输出,响应将包含 StructuredOutputError:
if (result.data.info.error?.name === "StructuredOutputError") {
console.error("无法生成结构化输出:", result.data.info.error.message)
console.error("尝试次数:", result.data.info.error.retries)
}
最佳实践
- 在 schema 属性中提供清晰的描述,以帮助模型理解要提取哪些数据
- 使用
required指定哪些字段必须存在 - 保持 schema 聚焦 - 复杂的嵌套 schema 可能使模型更难正确填充
- 设置适当的
retryCount- 复杂 schema 增加,简单 schema 减少
API
SDK 通过类型安全的客户端公开所有服务器 API。
全局
| 方法 | 描述 | 响应 |
|---|---|---|
global.health() | 检查服务器健康和版本 | { healthy: true, version: string } |
示例
const health = await client.global.health()
console.log(health.data.version)
应用
| 方法 | 描述 | 响应 |
|---|---|---|
app.log() | 写入日志条目 | boolean |
app.agents() | 列出所有可用代理 | Agent[] |
示例
// 写入日志条目
await client.app.log({
body: {
service: "my-app",
level: "info",
message: "操作完成",
},
})
// 列出可用代理
const agents = await client.app.agents()
项目
| 方法 | 描述 | 响应 |
|---|---|---|
project.list() | 列出所有项目 | Project[] |
project.current() | 获取当前项目 | Project |
示例
// 列出所有项目
const projects = await client.project.list()
// 获取当前项目
const currentProject = await client.project.current()
路径
| 方法 | 描述 | 响应 |
|---|---|---|
path.get() | 获取当前路径 | Path |
示例
// 获取当前路径信息
const pathInfo = await client.path.get()
配置
| 方法 | 描述 | 响应 |
|---|---|---|
config.get() | 获取配置信息 | Config |
示例
const config = await client.config.get()
会话
| 方法 | 描述 | 备注 |
|---|---|---|
session.list() | 列出会话 | 返回 Session[] |
session.get({ path }) | 获取会话 | 返回 Session |
session.children({ path }) | 列出子会话 | 返回 Session[] |
session.create({ body }) | 创建会话 | 返回 Session |
session.delete({ path }) | 删除会话 | 返回 boolean |
session.update({ path, body }) | 更新会话属性 | 返回 Session |
session.init({ path, body }) | 分析应用并创建 AGENTS.md | 返回 boolean |
session.abort({ path }) | 中止正在运行的会话 | 返回 boolean |
session.summarize({ path, body }) | 总结会话 | 返回 boolean |
session.messages({ path }) | 列出会话中的消息 | 返回 { info: Message, parts: Part[]}[] |
session.message({ path }) | 获取消息详情 | 返回 { info: Message, parts: Part[]} |
session.prompt({ path, body }) | 发送提示消息 | body.noReply: true 返回 UserMessage(仅上下文)。默认返回带 AI 响应的 AssistantMessage。支持 body.outputFormat 用于 结构化输出 |
session.command({ path, body }) | 向会话发送命令 | 返回 { info: AssistantMessage, parts: Part[]} |
session.shell({ path, body }) | 运行 shell 命令 | 返回 AssistantMessage |
session.revert({ path, body }) | 回滚消息 | 返回 Session |
session.unrevert({ path }) | 恢复已回滚的消息 | 返回 Session |
postSessionByIdPermissionsByPermissionId({ path, body }) | 响应权限请求 | 返回 boolean |
示例
// 创建和管理会话
const session = await client.session.create({
body: { title: "我的会话" },
})
const sessions = await client.session.list()
// 发送提示消息
const result = await client.session.prompt({
path: { id: session.data.id },
body: {
model: { providerID: "dropstone", modelID: "dropstone-pro" },
parts: [{ type: "text", text: "你好!" }],
},
})
// 注入上下文而不触发 AI 响应(对插件有用)
await client.session.prompt({
path: { id: session.data.id },
body: {
noReply: true,
parts: [{ type: "text", text: "你是一个乐于助人的助手。" }],
},
})
文件
| 方法 | 描述 | 响应 |
|---|---|---|
find.text({ query }) | 在文件中搜索文本 | 匹配对象数组,包含 path、lines、line_number、absolute_offset、submatches |
find.files({ query }) | 按名称查找文件和目录 | string[](路径) |
find.symbols({ query }) | 查找工作区符号 | Symbol[] |
file.read({ query }) | 读取文件 | { type: "raw" | "patch", content: string } |
file.status({ query? }) | 获取已跟踪文件的状态 | File[] |
find.files 支持一些可选查询字段:
type:"file"或"directory"directory:覆盖搜索的项目根目录limit:最大结果数(1–200)
示例
// 搜索和读取文件
const textResults = await client.find.text({
query: { pattern: "function.*dropstone" },
})
const files = await client.find.files({
query: { query: "*.ts", type: "file" },
})
const directories = await client.find.files({
query: { query: "packages", type: "directory", limit: 20 },
})
const content = await client.file.read({
query: { path: "src/index.ts" },
})
认证
| 方法 | 描述 | 响应 |
|---|---|---|
auth.set({ ... }) | 设置认证凭据 | boolean |
示例
await client.auth.set({
path: { id: "dropstone" },
body: { type: "api", key: "your-dropstone-api-key" },
})
事件
| 方法 | 描述 | 响应 |
|---|---|---|
event.subscribe() | 服务器发送事件流 | 服务器发送事件流 |
示例
// 监听实时事件
const events = await client.event.subscribe()
for await (const event of events.stream) {
console.log("事件:", event.type, event.properties)
}
v2 API
SDK 附带稳定的 v1 接口(在上述示例中使用)和反映更新的 Effect HttpApi 契约的 v2 接口。新集成优先使用 v2:
import { createDropstone } from "@blankline/dropstone-sdk/v2"
const { client, server } = await createDropstone()
// v2 暴露更丰富的资源层次结构:workspace、worktree、file、find 等。
const files = await client.file.list({ path: "src" })
v1 接口保留用于向后兼容。新端点只添加到 v2。