Skip to content

feat: add support for progress and cancel notifications #26161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
esparky wants to merge 1 commit into from
Closed

feat: add support for progress and cancel notifications #26161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions packages/opencode/src/acp/agent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,9 @@ export class Agent implements ACPAgent {
title: part.tool,
locations: toLocations(part.tool, part.state.input),
rawInput: part.state.input,
rawOutput: {
metadata: part.state.metadata,
},
},
})
.catch((error) => {
Expand Down Expand Up @@ -332,6 +335,9 @@ export class Agent implements ACPAgent {
title: part.tool,
locations: toLocations(part.tool, part.state.input),
rawInput: part.state.input,
rawOutput: {
metadata: part.state.metadata,
},
...(content.length > 0 && { content }),
},
})
Expand Down Expand Up @@ -862,6 +868,9 @@ export class Agent implements ACPAgent {
title: part.tool,
locations: toLocations(part.tool, part.state.input),
rawInput: part.state.input,
rawOutput: {
metadata: part.state.metadata,
},
...(runningContent.length > 0 && { content: runningContent }),
},
})
Expand Down
37 changes: 31 additions & 6 deletions packages/opencode/src/cli/cmd/tui/routes/session/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1621,17 +1621,29 @@ function GenericTool(props: ToolProps<any>) {
return [...lines().slice(0, maxLines), "…"].join("\n")
})

const progress = () => {
if (props.metadata?.progress !== undefined && typeof props.metadata.progress === "number") {
const p = props.metadata.progress
const t = props.metadata.total
if (typeof t === "number" && t > 0) {
return ` (${Math.round((p / t) * 100)}%)`
}
return ` (${p})`
}
return ""
}

return (
<Show
when={props.output && ctx.showGenericToolOutput()}
fallback={
<InlineTool icon="⚙" pending="Writing command..." complete={true} part={props.part}>
{props.tool} {input(props.input)}
{props.tool} {input(props.input)}{progress()}
</InlineTool>
}
>
<BlockTool
title={`# ${props.tool} ${input(props.input)}`}
title={`# ${props.tool} ${input(props.input)}${progress()}`}
part={props.part}
onClick={overflow() ? () => setExpanded((prev) => !prev) : undefined}
>
Expand Down Expand Up @@ -1661,6 +1673,7 @@ function InlineTool(props: {
const ctx = use()
const sync = useSync()
const renderer = useRenderer()
const sdk = useSDK()
const [hover, setHover] = createSignal(false)

const permission = createMemo(() => {
Expand Down Expand Up @@ -1724,11 +1737,23 @@ function InlineTool(props: {
<Spinner color={fg()} children={props.children} />
</Match>
<Match when={true}>
<text paddingLeft={3} fg={fg()} attributes={denied() ? TextAttributes.STRIKETHROUGH : undefined}>
<Show fallback={<>~ {props.pending}</>} when={props.complete}>
<span style={{ fg: props.iconColor }}>{props.icon}</span> {props.children}
<box flexDirection="row">
<text paddingLeft={3} fg={fg()} attributes={denied() ? TextAttributes.STRIKETHROUGH : undefined}>
<Show fallback={<>~ {props.pending}</>} when={props.complete}>
<span style={{ fg: props.iconColor }}>{props.icon}</span> {props.children}
</Show>
</text>
<Show when={props.part.state.status === "running" && !permission()}>
<text
fg={theme.error}
onMouseUp={() => {
void sdk.client.session.cancelTool({ sessionID: ctx.sessionID, callID: props.part.callID })
}}
>
{" [Cancel]"}
</text>
</Show>
</text>
</box>
</Match>
</Switch>
<Show when={error() && !denied()}>
Expand Down
22 changes: 21 additions & 1 deletion packages/opencode/src/mcp/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,9 @@ function isMcpConfigured(entry: McpEntry): entry is ConfigMCP.Info {

const sanitize = (s: string) => s.replace(/[^a-zA-Z0-9_-]/g, "_")

import type { Context as ToolContext } from "@/tool/tool"
export const McpContextMap = new Map<string, ToolContext>()

// Convert MCP tool definition to AI SDK Tool type
function convertMcpTool(mcpTool: MCPToolDef, client: MCPClient, timeout?: number): Tool {
const inputSchema = mcpTool.inputSchema
Expand All @@ -129,7 +132,9 @@ function convertMcpTool(mcpTool: MCPToolDef, client: MCPClient, timeout?: number
return dynamicTool({
description: mcpTool.description ?? "",
inputSchema: jsonSchema(schema),
execute: async (args: unknown) => {
execute: async (args: unknown, options?: any) => {
const toolCallId = options?.toolCallId
const ctx = toolCallId ? McpContextMap.get(toolCallId) : undefined
return client.callTool(
{
name: mcpTool.name,
Expand All @@ -139,6 +144,21 @@ function convertMcpTool(mcpTool: MCPToolDef, client: MCPClient, timeout?: number
{
resetTimeoutOnProgress: true,
timeout,
signal: options?.abortSignal,
onprogress: (progressPayload) => {
if (ctx && ctx.metadata) {
Effect.runPromise(
ctx.metadata({
title: `Working...`,
metadata: {
progress: progressPayload?.progress,
total: progressPayload?.total,
description: mcpTool.name,
},
})
).catch((e) => log.error("Failed to update progress from MCP", { error: e }))
}
},
},
)
},
Expand Down
29 changes: 29 additions & 0 deletions packages/opencode/src/server/routes/instance/httpapi/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ export const SessionPaths = {
update: `${root}/:sessionID`,
fork: `${root}/:sessionID/fork`,
abort: `${root}/:sessionID/abort`,
cancelTool: `${root}/:sessionID/tool/:callID/cancel`,
share: `${root}/:sessionID/share`,
init: `${root}/:sessionID/init`,
summarize: `${root}/:sessionID/summarize`,
Expand Down Expand Up @@ -252,6 +253,17 @@ export const SessionApi = HttpApi.make("session")
description: "Create a new session by forking an existing session at a specific message point.",
}),
),
HttpApiEndpoint.post("cancelTool", SessionPaths.cancelTool, {
params: { sessionID: SessionID, callID: Schema.String },
success: Schema.Boolean,
}).annotateMerge(
OpenApi.annotations({
identifier: "session.cancelTool",
summary: "Cancel tool",
description: "Cancel a specific active tool execution.",
}),
),

HttpApiEndpoint.post("abort", SessionPaths.abort, {
params: { sessionID: SessionID },
success: Schema.Boolean,
Expand Down Expand Up @@ -607,6 +619,22 @@ export const sessionHandlers = Layer.unwrap(
)
})

const cancelTool = Effect.fn("SessionHttpApi.cancelTool")(function* (ctx: {
params: { sessionID: SessionID; callID: string }
}) {
const instance = yield* InstanceState.context
yield* Effect.promise(() =>
Instance.restore(instance, () =>
AppRuntime.runPromise(
SessionPrompt.Service.use((svc) => svc.cancelTool(ctx.params.sessionID, ctx.params.callID)).pipe(
Effect.provide(SessionPrompt.defaultLayer),
),
),
),
)
return true
})

const abort = Effect.fn("SessionHttpApi.abort")(function* (ctx: { params: { sessionID: SessionID } }) {
const instance = yield* InstanceState.context
yield* Effect.promise(() =>
Expand Down Expand Up @@ -922,6 +950,7 @@ export const sessionHandlers = Layer.unwrap(
.handle("remove", remove)
.handle("update", update)
.handle("fork", fork)
.handle("cancelTool", cancelTool)
.handle("abort", abort)
.handle("init", init)
.handle("share", share)
Expand Down
1 change: 1 addition & 0 deletions packages/opencode/src/server/routes/instance/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ export const InstanceRoutes = (upgrade: UpgradeWebSocket): Hono => {
app.post(SessionPaths.init, (c) => handler(c.req.raw, context))
app.post(SessionPaths.fork, (c) => handler(c.req.raw, context))
app.post(SessionPaths.abort, (c) => handler(c.req.raw, context))
app.post(SessionPaths.cancelTool, (c) => handler(c.req.raw, context))
app.post(SessionPaths.share, (c) => handler(c.req.raw, context))
app.delete(SessionPaths.share, (c) => handler(c.req.raw, context))
app.post(SessionPaths.summarize, (c) => handler(c.req.raw, context))
Expand Down
32 changes: 32 additions & 0 deletions packages/opencode/src/server/routes/instance/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,38 @@ export const SessionRoutes = lazy(() =>
return yield* svc.fork({ ...body, sessionID })
}),
)
.post(
"/:sessionID/tool/:callID/cancel",
describeRoute({
summary: "Cancel tool",
description: "Cancel a specific active tool execution.",
operationId: "session.cancelTool",
responses: {
200: {
description: "Cancelled tool",
content: {
"application/json": {
schema: resolver(z.boolean()),
},
},
},
...errors(400, 404),
},
}),
validator(
"param",
z.object({
sessionID: SessionID.zod,
callID: z.string(),
}),
),
async (c) =>
jsonRequest("SessionRoutes.cancelTool", c, function* () {
const svc = yield* SessionPrompt.Service
yield* svc.cancelTool(c.req.valid("param").sessionID, c.req.valid("param").callID)
return true
}),
)
.post(
"/:sessionID/abort",
describeRoute({
Expand Down
Loading
Loading