Dropstone Docs

服务器

通过 HTTP 与 Dropstone 服务器交互。

dropstone serve 命令运行一个无头 HTTP 服务器,该服务器公开一个 OpenAPI 端点,Dropstone 客户端可以使用该端点。


用法

dropstone serve [--port <number>] [--hostname <string>] [--cors <origin>]

选项

标志描述默认值
--port监听的端口4096
--hostname监听的主机名127.0.0.1
--mdns启用 mDNS 发现false
--mdns-domainmDNS 服务的自定义域名dropstone.local
--cors允许的其他浏览器源[]

--cors 可以多次传递:

dropstone serve --cors http://localhost:5173 --cors https://app.example.com

身份验证

设置 DROPSTONE_SERVER_PASSWORD 以使用 HTTP 基本身份验证保护服务器。用户名默认为 dropstone,或设置 DROPSTONE_SERVER_USERNAME 以覆盖它。这适用于 dropstone servedropstone web

DROPSTONE_SERVER_PASSWORD=your-password dropstone serve

工作原理

dropstone serve 通过 OpenAPI 3.1 HTTP 端点公开 Dropstone 的功能。同一端点用于生成 SDK

当您想以编程方式驱动 Dropstone 时使用服务器:从脚本、CI 管道或您自己的集成。交互式会话和服务器是独立的。运行 dropstone serve 会启动一个全新的独立服务器,无论您是否有打开的交互式会话。

您可以使用 --hostname--port 标志 覆盖绑定地址。


规范

服务器发布一个 OpenAPI 3.1 规范,可以在以下位置查看:

http://<hostname>:<port>/doc

例如,http://localhost:4096/doc。使用规范生成客户端或检查请求和响应类型。或在 Swagger 浏览器中查看它。


API

Dropstone 服务器公开以下 API。


全局

方法路径描述响应
GET/global/health获取服务器健康状态和版本{ healthy: true, version: string }
GET/global/event获取全局事件(SSE 流)事件流

项目

方法路径描述响应
GET/project列出所有项目Project[]
GET/project/current获取当前项目Project

路径和版本控制

方法路径描述响应
GET/path获取当前路径Path
GET/vcs获取当前项目的版本控制信息VcsInfo

配置

方法路径描述响应
GET/config获取配置信息Config
PATCH/config更新配置Config

会话

方法路径描述备注
GET/session列出所有会话返回 Session[]
POST/session创建新会话请求体:{ parentID?, title? },返回 Session
GET/session/status获取所有会话的会话状态返回 { [sessionID: string]: SessionStatus }
GET/session/:id获取会话详情返回 Session
DELETE/session/:id删除会话及其所有数据返回 boolean
PATCH/session/:id更新会话属性请求体:{ title? },返回 Session
GET/session/:id/children获取会话的子会话返回 Session[]
GET/session/:id/todo获取会话的待办事项列表返回 Todo[]
POST/session/:id/init分析应用并创建 AGENTS.md请求体:{ messageID, providerID, modelID },返回 boolean
POST/session/:id/fork在消息处分叉现有会话请求体:{ messageID? },返回 Session
POST/session/:id/abort中止运行中的会话返回 boolean
GET/session/:id/diff获取此会话的差异查询:messageID?,返回 FileDiff[]
POST/session/:id/summarize总结会话请求体:{ providerID, modelID },返回 boolean
POST/session/:id/revert恢复消息请求体:{ messageID, partID? },返回 boolean
POST/session/:id/unrevert恢复所有已恢复的消息返回 boolean
POST/session/:id/permissions/:permissionID响应权限请求请求体:{ response, remember? },返回 boolean

消息

方法路径描述备注
GET/session/:id/message列出会话中的消息查询:limit?,返回 { info: Message, parts: Part[]}[]
POST/session/:id/message发送消息并等待响应请求体:{ messageID?, model?, agent?, noReply?, system?, tools?, parts },返回 { info: Message, parts: Part[]}
GET/session/:id/message/:messageID获取消息详情返回 { info: Message, parts: Part[]}
POST/session/:id/prompt_async异步发送消息(不等待)请求体:与 /session/:id/message 相同,返回 204 No Content
POST/session/:id/command执行斜杠命令请求体:{ messageID?, agent?, model?, command, arguments },返回 { info: Message, parts: Part[]}
POST/session/:id/shell运行 shell 命令请求体:{ agent, model?, command },返回 { info: Message, parts: Part[]}

命令

方法路径描述响应
GET/command列出所有命令Command[]

文件

方法路径描述响应
GET/find?pattern=<pat>在文件中搜索文本匹配对象数组,包含 pathlinesline_numberabsolute_offsetsubmatches
GET/find/file?query=<q>按名称查找文件和目录string[](路径)
GET/find/symbol?query=<q>查找工作区符号Symbol[]
GET/file?path=<path>列出文件和目录FileNode[]
GET/file/content?path=<p>读取文件FileContent
GET/file/status获取跟踪文件的状态File[]

/find/file 查询参数

  • query(必需):搜索字符串(模糊匹配)
  • type(可选):将结果限制为 "file""directory"
  • directory(可选):覆盖搜索的项目根目录
  • limit(可选):最大结果数(1–200)
  • dirs(可选):旧版标志("false" 仅返回文件)

LSP、格式化程序和 MCP

方法路径描述响应
GET/lsp获取 LSP 服务器状态LSPStatus[]
GET/formatter获取格式化程序状态FormatterStatus[]
GET/mcp获取 MCP 服务器状态{ [name: string]: MCPStatus }
POST/mcp动态添加 MCP 服务器请求体:{ name, config },返回 MCP 状态对象

代理

方法路径描述响应
GET/agent列出所有可用代理Agent[]

日志

方法路径描述响应
POST/log写入日志条目。请求体:{ service, level, message, extra? }boolean

身份验证

方法路径描述响应
PUT/auth/:id为给定目标设置身份验证凭据。boolean

事件

方法路径描述响应
GET/event服务器发送事件流。第一个事件是 server.connected,然后是总线事件服务器发送事件流

文档

方法路径描述响应
GET/docOpenAPI 3.1 规范包含 OpenAPI 规范的 HTML 页面
Ctrl+I