| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852 |
- import path from "path"
- import os from "os"
- import fs from "fs/promises"
- import z from "zod"
- import { Identifier } from "../id/id"
- import { MessageV2 } from "./message-v2"
- import { Log } from "../util/log"
- import { SessionRevert } from "./revert"
- import { Session } from "."
- import { Agent } from "../agent/agent"
- import { Provider } from "../provider/provider"
- import { type Tool as AITool, tool, jsonSchema, type ToolCallOptions } from "ai"
- import { SessionCompaction } from "./compaction"
- import { Instance } from "../project/instance"
- import { Bus } from "../bus"
- import { ProviderTransform } from "../provider/transform"
- import { SystemPrompt } from "./system"
- import { InstructionPrompt } from "./instruction"
- import { Plugin } from "../plugin"
- import PROMPT_PLAN from "../session/prompt/plan.txt"
- import BUILD_SWITCH from "../session/prompt/build-switch.txt"
- import MAX_STEPS from "../session/prompt/max-steps.txt"
- import { defer } from "../util/defer"
- import { clone } from "remeda"
- import { ToolRegistry } from "../tool/registry"
- import { MCP } from "../mcp"
- import { LSP } from "../lsp"
- import { ReadTool } from "../tool/read"
- import { ListTool } from "../tool/ls"
- import { FileTime } from "../file/time"
- import { Flag } from "../flag/flag"
- import { ulid } from "ulid"
- import { spawn } from "child_process"
- import { Command } from "../command"
- import { $, fileURLToPath } from "bun"
- import { ConfigMarkdown } from "../config/markdown"
- import { SessionSummary } from "./summary"
- import { NamedError } from "@opencode-ai/util/error"
- import { fn } from "@/util/fn"
- import { SessionProcessor } from "./processor"
- import { TaskTool } from "@/tool/task"
- import { Tool } from "@/tool/tool"
- import { PermissionNext } from "@/permission/next"
- import { SessionStatus } from "./status"
- import { LLM } from "./llm"
- import { iife } from "@/util/iife"
- import { Shell } from "@/shell/shell"
- import { Truncate } from "@/tool/truncation"
- // @ts-ignore
- globalThis.AI_SDK_LOG_WARNINGS = false
- export namespace SessionPrompt {
- const log = Log.create({ service: "session.prompt" })
- export const OUTPUT_TOKEN_MAX = Flag.OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX || 32_000
- const state = Instance.state(
- () => {
- const data: Record<
- string,
- {
- abort: AbortController
- callbacks: {
- resolve(input: MessageV2.WithParts): void
- reject(): void
- }[]
- }
- > = {}
- return data
- },
- async (current) => {
- for (const item of Object.values(current)) {
- item.abort.abort()
- for (const callback of item.callbacks) {
- callback.reject()
- }
- }
- },
- )
- export function assertNotBusy(sessionID: string) {
- const match = state()[sessionID]
- if (match) throw new Session.BusyError(sessionID)
- }
- export const PromptInput = z.object({
- sessionID: Identifier.schema("session"),
- messageID: Identifier.schema("message").optional(),
- model: z
- .object({
- providerID: z.string(),
- modelID: z.string(),
- })
- .optional(),
- agent: z.string().optional(),
- noReply: z.boolean().optional(),
- tools: z
- .record(z.string(), z.boolean())
- .optional()
- .describe(
- "@deprecated tools and permissions have been merged, you can set permissions on the session itself now",
- ),
- system: z.string().optional(),
- variant: z.string().optional(),
- parts: z.array(
- z.discriminatedUnion("type", [
- MessageV2.TextPart.omit({
- messageID: true,
- sessionID: true,
- })
- .partial({
- id: true,
- })
- .meta({
- ref: "TextPartInput",
- }),
- MessageV2.FilePart.omit({
- messageID: true,
- sessionID: true,
- })
- .partial({
- id: true,
- })
- .meta({
- ref: "FilePartInput",
- }),
- MessageV2.AgentPart.omit({
- messageID: true,
- sessionID: true,
- })
- .partial({
- id: true,
- })
- .meta({
- ref: "AgentPartInput",
- }),
- MessageV2.SubtaskPart.omit({
- messageID: true,
- sessionID: true,
- })
- .partial({
- id: true,
- })
- .meta({
- ref: "SubtaskPartInput",
- }),
- ]),
- ),
- })
- export type PromptInput = z.infer<typeof PromptInput>
- export const prompt = fn(PromptInput, async (input) => {
- const session = await Session.get(input.sessionID)
- await SessionRevert.cleanup(session)
- const message = await createUserMessage(input)
- await Session.touch(input.sessionID)
- // this is backwards compatibility for allowing `tools` to be specified when
- // prompting
- const permissions: PermissionNext.Ruleset = []
- for (const [tool, enabled] of Object.entries(input.tools ?? {})) {
- permissions.push({
- permission: tool,
- action: enabled ? "allow" : "deny",
- pattern: "*",
- })
- }
- if (permissions.length > 0) {
- session.permission = permissions
- await Session.update(session.id, (draft) => {
- draft.permission = permissions
- })
- }
- if (input.noReply === true) {
- return message
- }
- return loop(input.sessionID)
- })
- export async function resolvePromptParts(template: string): Promise<PromptInput["parts"]> {
- const parts: PromptInput["parts"] = [
- {
- type: "text",
- text: template,
- },
- ]
- const matches = ConfigMarkdown.files(template)
- const seen = new Set<string>()
- const names = matches
- .map((match) => match[1])
- .filter((name) => {
- if (seen.has(name)) return false
- seen.add(name)
- return true
- })
- const resolved = await Promise.all(
- names.map(async (name) => {
- const filepath = name.startsWith("~/")
- ? path.join(os.homedir(), name.slice(2))
- : path.resolve(Instance.worktree, name)
- const stats = await fs.stat(filepath).catch(() => undefined)
- if (!stats) {
- const agent = await Agent.get(name)
- if (!agent) return undefined
- return {
- type: "agent",
- name: agent.name,
- } satisfies PromptInput["parts"][number]
- }
- if (stats.isDirectory()) {
- return {
- type: "file",
- url: `file://${filepath}`,
- filename: name,
- mime: "application/x-directory",
- } satisfies PromptInput["parts"][number]
- }
- return {
- type: "file",
- url: `file://${filepath}`,
- filename: name,
- mime: "text/plain",
- } satisfies PromptInput["parts"][number]
- }),
- )
- for (const item of resolved) {
- if (!item) continue
- parts.push(item)
- }
- return parts
- }
- function start(sessionID: string) {
- const s = state()
- if (s[sessionID]) return
- const controller = new AbortController()
- s[sessionID] = {
- abort: controller,
- callbacks: [],
- }
- return controller.signal
- }
- export function cancel(sessionID: string) {
- log.info("cancel", { sessionID })
- const s = state()
- const match = s[sessionID]
- if (!match) return
- match.abort.abort()
- for (const item of match.callbacks) {
- item.reject()
- }
- delete s[sessionID]
- SessionStatus.set(sessionID, { type: "idle" })
- return
- }
- export const loop = fn(Identifier.schema("session"), async (sessionID) => {
- const abort = start(sessionID)
- if (!abort) {
- return new Promise<MessageV2.WithParts>((resolve, reject) => {
- const callbacks = state()[sessionID].callbacks
- callbacks.push({ resolve, reject })
- })
- }
- using _ = defer(() => cancel(sessionID))
- let step = 0
- const session = await Session.get(sessionID)
- while (true) {
- SessionStatus.set(sessionID, { type: "busy" })
- log.info("loop", { step, sessionID })
- if (abort.aborted) break
- let msgs = await MessageV2.filterCompacted(MessageV2.stream(sessionID))
- let lastUser: MessageV2.User | undefined
- let lastAssistant: MessageV2.Assistant | undefined
- let lastFinished: MessageV2.Assistant | undefined
- let tasks: (MessageV2.CompactionPart | MessageV2.SubtaskPart)[] = []
- for (let i = msgs.length - 1; i >= 0; i--) {
- const msg = msgs[i]
- if (!lastUser && msg.info.role === "user") lastUser = msg.info as MessageV2.User
- if (!lastAssistant && msg.info.role === "assistant") lastAssistant = msg.info as MessageV2.Assistant
- if (!lastFinished && msg.info.role === "assistant" && msg.info.finish)
- lastFinished = msg.info as MessageV2.Assistant
- if (lastUser && lastFinished) break
- const task = msg.parts.filter((part) => part.type === "compaction" || part.type === "subtask")
- if (task && !lastFinished) {
- tasks.push(...task)
- }
- }
- if (!lastUser) throw new Error("No user message found in stream. This should never happen.")
- if (
- lastAssistant?.finish &&
- !["tool-calls", "unknown"].includes(lastAssistant.finish) &&
- lastUser.id < lastAssistant.id
- ) {
- log.info("exiting loop", { sessionID })
- break
- }
- step++
- if (step === 1)
- ensureTitle({
- session,
- modelID: lastUser.model.modelID,
- providerID: lastUser.model.providerID,
- history: msgs,
- })
- const model = await Provider.getModel(lastUser.model.providerID, lastUser.model.modelID)
- const task = tasks.pop()
- // pending subtask
- // TODO: centralize "invoke tool" logic
- if (task?.type === "subtask") {
- const taskTool = await TaskTool.init()
- const taskModel = task.model ? await Provider.getModel(task.model.providerID, task.model.modelID) : model
- const assistantMessage = (await Session.updateMessage({
- id: Identifier.ascending("message"),
- role: "assistant",
- parentID: lastUser.id,
- sessionID,
- mode: task.agent,
- agent: task.agent,
- path: {
- cwd: Instance.directory,
- root: Instance.worktree,
- },
- cost: 0,
- tokens: {
- input: 0,
- output: 0,
- reasoning: 0,
- cache: { read: 0, write: 0 },
- },
- modelID: taskModel.id,
- providerID: taskModel.providerID,
- time: {
- created: Date.now(),
- },
- })) as MessageV2.Assistant
- let part = (await Session.updatePart({
- id: Identifier.ascending("part"),
- messageID: assistantMessage.id,
- sessionID: assistantMessage.sessionID,
- type: "tool",
- callID: ulid(),
- tool: TaskTool.id,
- state: {
- status: "running",
- input: {
- prompt: task.prompt,
- description: task.description,
- subagent_type: task.agent,
- command: task.command,
- },
- time: {
- start: Date.now(),
- },
- },
- })) as MessageV2.ToolPart
- const taskArgs = {
- prompt: task.prompt,
- description: task.description,
- subagent_type: task.agent,
- command: task.command,
- }
- await Plugin.trigger(
- "tool.execute.before",
- {
- tool: "task",
- sessionID,
- callID: part.id,
- },
- { args: taskArgs },
- )
- let executionError: Error | undefined
- const taskAgent = await Agent.get(task.agent)
- const taskCtx: Tool.Context = {
- agent: task.agent,
- messageID: assistantMessage.id,
- sessionID: sessionID,
- abort,
- callID: part.callID,
- extra: { bypassAgentCheck: true },
- messages: msgs,
- async metadata(input) {
- await Session.updatePart({
- ...part,
- type: "tool",
- state: {
- ...part.state,
- ...input,
- },
- } satisfies MessageV2.ToolPart)
- },
- async ask(req) {
- await PermissionNext.ask({
- ...req,
- sessionID: sessionID,
- ruleset: PermissionNext.merge(taskAgent.permission, session.permission ?? []),
- })
- },
- }
- const result = await taskTool.execute(taskArgs, taskCtx).catch((error) => {
- executionError = error
- log.error("subtask execution failed", { error, agent: task.agent, description: task.description })
- return undefined
- })
- await Plugin.trigger(
- "tool.execute.after",
- {
- tool: "task",
- sessionID,
- callID: part.id,
- },
- result,
- )
- assistantMessage.finish = "tool-calls"
- assistantMessage.time.completed = Date.now()
- await Session.updateMessage(assistantMessage)
- if (result && part.state.status === "running") {
- const attachments = result.attachments?.map((attachment) => ({
- ...attachment,
- id: Identifier.ascending("part"),
- messageID: assistantMessage.id,
- sessionID: assistantMessage.sessionID,
- }))
- await Session.updatePart({
- ...part,
- state: {
- status: "completed",
- input: part.state.input,
- title: result.title,
- metadata: result.metadata,
- output: result.output,
- attachments,
- time: {
- ...part.state.time,
- end: Date.now(),
- },
- },
- } satisfies MessageV2.ToolPart)
- }
- if (!result) {
- await Session.updatePart({
- ...part,
- state: {
- status: "error",
- error: executionError ? `Tool execution failed: ${executionError.message}` : "Tool execution failed",
- time: {
- start: part.state.status === "running" ? part.state.time.start : Date.now(),
- end: Date.now(),
- },
- metadata: part.metadata,
- input: part.state.input,
- },
- } satisfies MessageV2.ToolPart)
- }
- if (task.command) {
- // Add synthetic user message to prevent certain reasoning models from erroring
- // If we create assistant messages w/ out user ones following mid loop thinking signatures
- // will be missing and it can cause errors for models like gemini for example
- const summaryUserMsg: MessageV2.User = {
- id: Identifier.ascending("message"),
- sessionID,
- role: "user",
- time: {
- created: Date.now(),
- },
- agent: lastUser.agent,
- model: lastUser.model,
- }
- await Session.updateMessage(summaryUserMsg)
- await Session.updatePart({
- id: Identifier.ascending("part"),
- messageID: summaryUserMsg.id,
- sessionID,
- type: "text",
- text: "Summarize the task tool output above and continue with your task.",
- synthetic: true,
- } satisfies MessageV2.TextPart)
- }
- continue
- }
- // pending compaction
- if (task?.type === "compaction") {
- const result = await SessionCompaction.process({
- messages: msgs,
- parentID: lastUser.id,
- abort,
- sessionID,
- auto: task.auto,
- })
- if (result === "stop") break
- continue
- }
- // context overflow, needs compaction
- if (
- lastFinished &&
- lastFinished.summary !== true &&
- (await SessionCompaction.isOverflow({ tokens: lastFinished.tokens, model }))
- ) {
- await SessionCompaction.create({
- sessionID,
- agent: lastUser.agent,
- model: lastUser.model,
- auto: true,
- })
- continue
- }
- // normal processing
- const agent = await Agent.get(lastUser.agent)
- const maxSteps = agent.steps ?? Infinity
- const isLastStep = step >= maxSteps
- msgs = await insertReminders({
- messages: msgs,
- agent,
- session,
- })
- const processor = SessionProcessor.create({
- assistantMessage: (await Session.updateMessage({
- id: Identifier.ascending("message"),
- parentID: lastUser.id,
- role: "assistant",
- mode: agent.name,
- agent: agent.name,
- path: {
- cwd: Instance.directory,
- root: Instance.worktree,
- },
- cost: 0,
- tokens: {
- input: 0,
- output: 0,
- reasoning: 0,
- cache: { read: 0, write: 0 },
- },
- modelID: model.id,
- providerID: model.providerID,
- time: {
- created: Date.now(),
- },
- sessionID,
- })) as MessageV2.Assistant,
- sessionID: sessionID,
- model,
- abort,
- })
- using _ = defer(() => InstructionPrompt.clear(processor.message.id))
- // Check if user explicitly invoked an agent via @ in this turn
- const lastUserMsg = msgs.findLast((m) => m.info.role === "user")
- const bypassAgentCheck = lastUserMsg?.parts.some((p) => p.type === "agent") ?? false
- const tools = await resolveTools({
- agent,
- session,
- model,
- tools: lastUser.tools,
- processor,
- bypassAgentCheck,
- messages: msgs,
- })
- if (step === 1) {
- SessionSummary.summarize({
- sessionID: sessionID,
- messageID: lastUser.id,
- })
- }
- const sessionMessages = clone(msgs)
- // Ephemerally wrap queued user messages with a reminder to stay on track
- if (step > 1 && lastFinished) {
- for (const msg of sessionMessages) {
- if (msg.info.role !== "user" || msg.info.id <= lastFinished.id) continue
- for (const part of msg.parts) {
- if (part.type !== "text" || part.ignored || part.synthetic) continue
- if (!part.text.trim()) continue
- part.text = [
- "<system-reminder>",
- "The user sent the following message:",
- part.text,
- "",
- "Please address this message and continue with your tasks.",
- "</system-reminder>",
- ].join("\n")
- }
- }
- }
- await Plugin.trigger("experimental.chat.messages.transform", {}, { messages: sessionMessages })
- const result = await processor.process({
- user: lastUser,
- agent,
- abort,
- sessionID,
- system: [...(await SystemPrompt.environment(model)), ...(await InstructionPrompt.system())],
- messages: [
- ...MessageV2.toModelMessages(sessionMessages, model),
- ...(isLastStep
- ? [
- {
- role: "assistant" as const,
- content: MAX_STEPS,
- },
- ]
- : []),
- ],
- tools,
- model,
- })
- if (result === "stop") break
- if (result === "compact") {
- await SessionCompaction.create({
- sessionID,
- agent: lastUser.agent,
- model: lastUser.model,
- auto: true,
- })
- }
- continue
- }
- SessionCompaction.prune({ sessionID })
- for await (const item of MessageV2.stream(sessionID)) {
- if (item.info.role === "user") continue
- const queued = state()[sessionID]?.callbacks ?? []
- for (const q of queued) {
- q.resolve(item)
- }
- return item
- }
- throw new Error("Impossible")
- })
- async function lastModel(sessionID: string) {
- for await (const item of MessageV2.stream(sessionID)) {
- if (item.info.role === "user" && item.info.model) return item.info.model
- }
- return Provider.defaultModel()
- }
- async function resolveTools(input: {
- agent: Agent.Info
- model: Provider.Model
- session: Session.Info
- tools?: Record<string, boolean>
- processor: SessionProcessor.Info
- bypassAgentCheck: boolean
- messages: MessageV2.WithParts[]
- }) {
- using _ = log.time("resolveTools")
- const tools: Record<string, AITool> = {}
- const context = (args: any, options: ToolCallOptions): Tool.Context => ({
- sessionID: input.session.id,
- abort: options.abortSignal!,
- messageID: input.processor.message.id,
- callID: options.toolCallId,
- extra: { model: input.model, bypassAgentCheck: input.bypassAgentCheck },
- agent: input.agent.name,
- messages: input.messages,
- metadata: async (val: { title?: string; metadata?: any }) => {
- const match = input.processor.partFromToolCall(options.toolCallId)
- if (match && match.state.status === "running") {
- await Session.updatePart({
- ...match,
- state: {
- title: val.title,
- metadata: val.metadata,
- status: "running",
- input: args,
- time: {
- start: Date.now(),
- },
- },
- })
- }
- },
- async ask(req) {
- await PermissionNext.ask({
- ...req,
- sessionID: input.session.id,
- tool: { messageID: input.processor.message.id, callID: options.toolCallId },
- ruleset: PermissionNext.merge(input.agent.permission, input.session.permission ?? []),
- })
- },
- })
- for (const item of await ToolRegistry.tools(
- { modelID: input.model.api.id, providerID: input.model.providerID },
- input.agent,
- )) {
- const schema = ProviderTransform.schema(input.model, z.toJSONSchema(item.parameters))
- tools[item.id] = tool({
- id: item.id as any,
- description: item.description,
- inputSchema: jsonSchema(schema as any),
- async execute(args, options) {
- const ctx = context(args, options)
- await Plugin.trigger(
- "tool.execute.before",
- {
- tool: item.id,
- sessionID: ctx.sessionID,
- callID: ctx.callID,
- },
- {
- args,
- },
- )
- const result = await item.execute(args, ctx)
- await Plugin.trigger(
- "tool.execute.after",
- {
- tool: item.id,
- sessionID: ctx.sessionID,
- callID: ctx.callID,
- },
- result,
- )
- return result
- },
- })
- }
- for (const [key, item] of Object.entries(await MCP.tools())) {
- const execute = item.execute
- if (!execute) continue
- // Wrap execute to add plugin hooks and format output
- item.execute = async (args, opts) => {
- const ctx = context(args, opts)
- await Plugin.trigger(
- "tool.execute.before",
- {
- tool: key,
- sessionID: ctx.sessionID,
- callID: opts.toolCallId,
- },
- {
- args,
- },
- )
- await ctx.ask({
- permission: key,
- metadata: {},
- patterns: ["*"],
- always: ["*"],
- })
- const result = await execute(args, opts)
- await Plugin.trigger(
- "tool.execute.after",
- {
- tool: key,
- sessionID: ctx.sessionID,
- callID: opts.toolCallId,
- },
- result,
- )
- const textParts: string[] = []
- const attachments: Omit<MessageV2.FilePart, "id" | "messageID" | "sessionID">[] = []
- for (const contentItem of result.content) {
- if (contentItem.type === "text") {
- textParts.push(contentItem.text)
- } else if (contentItem.type === "image") {
- attachments.push({
- type: "file",
- mime: contentItem.mimeType,
- url: `data:${contentItem.mimeType};base64,${contentItem.data}`,
- })
- } else if (contentItem.type === "resource") {
- const { resource } = contentItem
- if (resource.text) {
- textParts.push(resource.text)
- }
- if (resource.blob) {
- attachments.push({
- type: "file",
- mime: resource.mimeType ?? "application/octet-stream",
- url: `data:${resource.mimeType ?? "application/octet-stream"};base64,${resource.blob}`,
- filename: resource.uri,
- })
- }
- }
- }
- const truncated = await Truncate.output(textParts.join("\n\n"), {}, input.agent)
- const metadata = {
- ...(result.metadata ?? {}),
- truncated: truncated.truncated,
- ...(truncated.truncated && { outputPath: truncated.outputPath }),
- }
- return {
- title: "",
- metadata,
- output: truncated.content,
- attachments,
- content: result.content, // directly return content to preserve ordering when outputting to model
- }
- }
- tools[key] = item
- }
- return tools
- }
- async function createUserMessage(input: PromptInput) {
- const agent = await Agent.get(input.agent ?? (await Agent.defaultAgent()))
- const model = input.model ?? agent.model ?? (await lastModel(input.sessionID))
- const variant =
- input.variant ??
- (agent.variant &&
- agent.model &&
- model.providerID === agent.model.providerID &&
- model.modelID === agent.model.modelID
- ? agent.variant
- : undefined)
- const info: MessageV2.Info = {
- id: input.messageID ?? Identifier.ascending("message"),
- role: "user",
- sessionID: input.sessionID,
- time: {
- created: Date.now(),
- },
- tools: input.tools,
- agent: agent.name,
- model,
- system: input.system,
- variant,
- }
- using _ = defer(() => InstructionPrompt.clear(info.id))
- const parts = await Promise.all(
- input.parts.map(async (part): Promise<MessageV2.Part[]> => {
- if (part.type === "file") {
- // before checking the protocol we check if this is an mcp resource because it needs special handling
- if (part.source?.type === "resource") {
- const { clientName, uri } = part.source
- log.info("mcp resource", { clientName, uri, mime: part.mime })
- const pieces: MessageV2.Part[] = [
- {
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "text",
- synthetic: true,
- text: `Reading MCP resource: ${part.filename} (${uri})`,
- },
- ]
- try {
- const resourceContent = await MCP.readResource(clientName, uri)
- if (!resourceContent) {
- throw new Error(`Resource not found: ${clientName}/${uri}`)
- }
- // Handle different content types
- const contents = Array.isArray(resourceContent.contents)
- ? resourceContent.contents
- : [resourceContent.contents]
- for (const content of contents) {
- if ("text" in content && content.text) {
- pieces.push({
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "text",
- synthetic: true,
- text: content.text as string,
- })
- } else if ("blob" in content && content.blob) {
- // Handle binary content if needed
- const mimeType = "mimeType" in content ? content.mimeType : part.mime
- pieces.push({
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "text",
- synthetic: true,
- text: `[Binary content: ${mimeType}]`,
- })
- }
- }
- pieces.push({
- ...part,
- id: part.id ?? Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- })
- } catch (error: unknown) {
- log.error("failed to read MCP resource", { error, clientName, uri })
- const message = error instanceof Error ? error.message : String(error)
- pieces.push({
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "text",
- synthetic: true,
- text: `Failed to read MCP resource ${part.filename}: ${message}`,
- })
- }
- return pieces
- }
- const url = new URL(part.url)
- switch (url.protocol) {
- case "data:":
- if (part.mime === "text/plain") {
- return [
- {
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "text",
- synthetic: true,
- text: `Called the Read tool with the following input: ${JSON.stringify({ filePath: part.filename })}`,
- },
- {
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "text",
- synthetic: true,
- text: Buffer.from(part.url, "base64url").toString(),
- },
- {
- ...part,
- id: part.id ?? Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- },
- ]
- }
- break
- case "file:":
- log.info("file", { mime: part.mime })
- // have to normalize, symbol search returns absolute paths
- // Decode the pathname since URL constructor doesn't automatically decode it
- const filepath = fileURLToPath(part.url)
- const stat = await Bun.file(filepath).stat()
- if (stat.isDirectory()) {
- part.mime = "application/x-directory"
- }
- if (part.mime === "text/plain") {
- let offset: number | undefined = undefined
- let limit: number | undefined = undefined
- const range = {
- start: url.searchParams.get("start"),
- end: url.searchParams.get("end"),
- }
- if (range.start != null) {
- const filePathURI = part.url.split("?")[0]
- let start = parseInt(range.start)
- let end = range.end ? parseInt(range.end) : undefined
- // some LSP servers (eg, gopls) don't give full range in
- // workspace/symbol searches, so we'll try to find the
- // symbol in the document to get the full range
- if (start === end) {
- const symbols = await LSP.documentSymbol(filePathURI)
- for (const symbol of symbols) {
- let range: LSP.Range | undefined
- if ("range" in symbol) {
- range = symbol.range
- } else if ("location" in symbol) {
- range = symbol.location.range
- }
- if (range?.start?.line && range?.start?.line === start) {
- start = range.start.line
- end = range?.end?.line ?? start
- break
- }
- }
- }
- offset = Math.max(start - 1, 0)
- if (end) {
- limit = end - offset
- }
- }
- const args = { filePath: filepath, offset, limit }
- const pieces: MessageV2.Part[] = [
- {
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "text",
- synthetic: true,
- text: `Called the Read tool with the following input: ${JSON.stringify(args)}`,
- },
- ]
- await ReadTool.init()
- .then(async (t) => {
- const model = await Provider.getModel(info.model.providerID, info.model.modelID)
- const readCtx: Tool.Context = {
- sessionID: input.sessionID,
- abort: new AbortController().signal,
- agent: input.agent!,
- messageID: info.id,
- extra: { bypassCwdCheck: true, model },
- messages: [],
- metadata: async () => {},
- ask: async () => {},
- }
- const result = await t.execute(args, readCtx)
- pieces.push({
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "text",
- synthetic: true,
- text: result.output,
- })
- if (result.attachments?.length) {
- pieces.push(
- ...result.attachments.map((attachment) => ({
- ...attachment,
- id: Identifier.ascending("part"),
- synthetic: true,
- filename: attachment.filename ?? part.filename,
- messageID: info.id,
- sessionID: input.sessionID,
- })),
- )
- } else {
- pieces.push({
- ...part,
- id: part.id ?? Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- })
- }
- })
- .catch((error) => {
- log.error("failed to read file", { error })
- const message = error instanceof Error ? error.message : error.toString()
- Bus.publish(Session.Event.Error, {
- sessionID: input.sessionID,
- error: new NamedError.Unknown({
- message,
- }).toObject(),
- })
- pieces.push({
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "text",
- synthetic: true,
- text: `Read tool failed to read ${filepath} with the following error: ${message}`,
- })
- })
- return pieces
- }
- if (part.mime === "application/x-directory") {
- const args = { path: filepath }
- const listCtx: Tool.Context = {
- sessionID: input.sessionID,
- abort: new AbortController().signal,
- agent: input.agent!,
- messageID: info.id,
- extra: { bypassCwdCheck: true },
- messages: [],
- metadata: async () => {},
- ask: async () => {},
- }
- const result = await ListTool.init().then((t) => t.execute(args, listCtx))
- return [
- {
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "text",
- synthetic: true,
- text: `Called the list tool with the following input: ${JSON.stringify(args)}`,
- },
- {
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "text",
- synthetic: true,
- text: result.output,
- },
- {
- ...part,
- id: part.id ?? Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- },
- ]
- }
- const file = Bun.file(filepath)
- FileTime.read(input.sessionID, filepath)
- return [
- {
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "text",
- text: `Called the Read tool with the following input: {\"filePath\":\"${filepath}\"}`,
- synthetic: true,
- },
- {
- id: part.id ?? Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "file",
- url: `data:${part.mime};base64,` + Buffer.from(await file.bytes()).toString("base64"),
- mime: part.mime,
- filename: part.filename!,
- source: part.source,
- },
- ]
- }
- }
- if (part.type === "agent") {
- // Check if this agent would be denied by task permission
- const perm = PermissionNext.evaluate("task", part.name, agent.permission)
- const hint = perm.action === "deny" ? " . Invoked by user; guaranteed to exist." : ""
- return [
- {
- id: Identifier.ascending("part"),
- ...part,
- messageID: info.id,
- sessionID: input.sessionID,
- },
- {
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- type: "text",
- synthetic: true,
- // An extra space is added here. Otherwise the 'Use' gets appended
- // to user's last word; making a combined word
- text:
- " Use the above message and context to generate a prompt and call the task tool with subagent: " +
- part.name +
- hint,
- },
- ]
- }
- return [
- {
- id: Identifier.ascending("part"),
- ...part,
- messageID: info.id,
- sessionID: input.sessionID,
- },
- ]
- }),
- )
- .then((x) => x.flat())
- .then((drafts) =>
- drafts.map(
- (part): MessageV2.Part => ({
- ...part,
- id: Identifier.ascending("part"),
- messageID: info.id,
- sessionID: input.sessionID,
- }),
- ),
- )
- await Plugin.trigger(
- "chat.message",
- {
- sessionID: input.sessionID,
- agent: input.agent,
- model: input.model,
- messageID: input.messageID,
- variant: input.variant,
- },
- {
- message: info,
- parts,
- },
- )
- await Session.updateMessage(info)
- for (const part of parts) {
- await Session.updatePart(part)
- }
- return {
- info,
- parts,
- }
- }
- async function insertReminders(input: { messages: MessageV2.WithParts[]; agent: Agent.Info; session: Session.Info }) {
- const userMessage = input.messages.findLast((msg) => msg.info.role === "user")
- if (!userMessage) return input.messages
- // Original logic when experimental plan mode is disabled
- if (!Flag.OPENCODE_EXPERIMENTAL_PLAN_MODE) {
- if (input.agent.name === "plan") {
- userMessage.parts.push({
- id: Identifier.ascending("part"),
- messageID: userMessage.info.id,
- sessionID: userMessage.info.sessionID,
- type: "text",
- text: PROMPT_PLAN,
- synthetic: true,
- })
- }
- const wasPlan = input.messages.some((msg) => msg.info.role === "assistant" && msg.info.agent === "plan")
- if (wasPlan && input.agent.name === "build") {
- userMessage.parts.push({
- id: Identifier.ascending("part"),
- messageID: userMessage.info.id,
- sessionID: userMessage.info.sessionID,
- type: "text",
- text: BUILD_SWITCH,
- synthetic: true,
- })
- }
- return input.messages
- }
- // New plan mode logic when flag is enabled
- const assistantMessage = input.messages.findLast((msg) => msg.info.role === "assistant")
- // Switching from plan mode to build mode
- if (input.agent.name !== "plan" && assistantMessage?.info.agent === "plan") {
- const plan = Session.plan(input.session)
- const exists = await Bun.file(plan).exists()
- if (exists) {
- const part = await Session.updatePart({
- id: Identifier.ascending("part"),
- messageID: userMessage.info.id,
- sessionID: userMessage.info.sessionID,
- type: "text",
- text:
- BUILD_SWITCH + "\n\n" + `A plan file exists at ${plan}. You should execute on the plan defined within it`,
- synthetic: true,
- })
- userMessage.parts.push(part)
- }
- return input.messages
- }
- // Entering plan mode
- if (input.agent.name === "plan" && assistantMessage?.info.agent !== "plan") {
- const plan = Session.plan(input.session)
- const exists = await Bun.file(plan).exists()
- if (!exists) await fs.mkdir(path.dirname(plan), { recursive: true })
- const part = await Session.updatePart({
- id: Identifier.ascending("part"),
- messageID: userMessage.info.id,
- sessionID: userMessage.info.sessionID,
- type: "text",
- text: `<system-reminder>
- Plan mode is active. The user indicated that they do not want you to execute yet -- you MUST NOT make any edits (with the exception of the plan file mentioned below), run any non-readonly tools (including changing configs or making commits), or otherwise make any changes to the system. This supersedes any other instructions you have received.
- ## Plan File Info:
- ${exists ? `A plan file already exists at ${plan}. You can read it and make incremental edits using the edit tool.` : `No plan file exists yet. You should create your plan at ${plan} using the write tool.`}
- You should build your plan incrementally by writing to or editing this file. NOTE that this is the only file you are allowed to edit - other than this you are only allowed to take READ-ONLY actions.
- ## Plan Workflow
- ### Phase 1: Initial Understanding
- Goal: Gain a comprehensive understanding of the user's request by reading through code and asking them questions. Critical: In this phase you should only use the explore subagent type.
- 1. Focus on understanding the user's request and the code associated with their request
- 2. **Launch up to 3 explore agents IN PARALLEL** (single message, multiple tool calls) to efficiently explore the codebase.
- - Use 1 agent when the task is isolated to known files, the user provided specific file paths, or you're making a small targeted change.
- - Use multiple agents when: the scope is uncertain, multiple areas of the codebase are involved, or you need to understand existing patterns before planning.
- - Quality over quantity - 3 agents maximum, but you should try to use the minimum number of agents necessary (usually just 1)
- - If using multiple agents: Provide each agent with a specific search focus or area to explore. Example: One agent searches for existing implementations, another explores related components, a third investigates testing patterns
- 3. After exploring the code, use the question tool to clarify ambiguities in the user request up front.
- ### Phase 2: Design
- Goal: Design an implementation approach.
- Launch general agent(s) to design the implementation based on the user's intent and your exploration results from Phase 1.
- You can launch up to 1 agent(s) in parallel.
- **Guidelines:**
- - **Default**: Launch at least 1 Plan agent for most tasks - it helps validate your understanding and consider alternatives
- - **Skip agents**: Only for truly trivial tasks (typo fixes, single-line changes, simple renames)
- Examples of when to use multiple agents:
- - The task touches multiple parts of the codebase
- - It's a large refactor or architectural change
- - There are many edge cases to consider
- - You'd benefit from exploring different approaches
- Example perspectives by task type:
- - New feature: simplicity vs performance vs maintainability
- - Bug fix: root cause vs workaround vs prevention
- - Refactoring: minimal change vs clean architecture
- In the agent prompt:
- - Provide comprehensive background context from Phase 1 exploration including filenames and code path traces
- - Describe requirements and constraints
- - Request a detailed implementation plan
- ### Phase 3: Review
- Goal: Review the plan(s) from Phase 2 and ensure alignment with the user's intentions.
- 1. Read the critical files identified by agents to deepen your understanding
- 2. Ensure that the plans align with the user's original request
- 3. Use question tool to clarify any remaining questions with the user
- ### Phase 4: Final Plan
- Goal: Write your final plan to the plan file (the only file you can edit).
- - Include only your recommended approach, not all alternatives
- - Ensure that the plan file is concise enough to scan quickly, but detailed enough to execute effectively
- - Include the paths of critical files to be modified
- - Include a verification section describing how to test the changes end-to-end (run the code, use MCP tools, run tests)
- ### Phase 5: Call plan_exit tool
- At the very end of your turn, once you have asked the user questions and are happy with your final plan file - you should always call plan_exit to indicate to the user that you are done planning.
- This is critical - your turn should only end with either asking the user a question or calling plan_exit. Do not stop unless it's for these 2 reasons.
- **Important:** Use question tool to clarify requirements/approach, use plan_exit to request plan approval. Do NOT use question tool to ask "Is this plan okay?" - that's what plan_exit does.
- NOTE: At any point in time through this workflow you should feel free to ask the user questions or clarifications. Don't make large assumptions about user intent. The goal is to present a well researched plan to the user, and tie any loose ends before implementation begins.
- </system-reminder>`,
- synthetic: true,
- })
- userMessage.parts.push(part)
- return input.messages
- }
- return input.messages
- }
- export const ShellInput = z.object({
- sessionID: Identifier.schema("session"),
- agent: z.string(),
- model: z
- .object({
- providerID: z.string(),
- modelID: z.string(),
- })
- .optional(),
- command: z.string(),
- })
- export type ShellInput = z.infer<typeof ShellInput>
- export async function shell(input: ShellInput) {
- const abort = start(input.sessionID)
- if (!abort) {
- throw new Session.BusyError(input.sessionID)
- }
- using _ = defer(() => cancel(input.sessionID))
- const session = await Session.get(input.sessionID)
- if (session.revert) {
- await SessionRevert.cleanup(session)
- }
- const agent = await Agent.get(input.agent)
- const model = input.model ?? agent.model ?? (await lastModel(input.sessionID))
- const userMsg: MessageV2.User = {
- id: Identifier.ascending("message"),
- sessionID: input.sessionID,
- time: {
- created: Date.now(),
- },
- role: "user",
- agent: input.agent,
- model: {
- providerID: model.providerID,
- modelID: model.modelID,
- },
- }
- await Session.updateMessage(userMsg)
- const userPart: MessageV2.Part = {
- type: "text",
- id: Identifier.ascending("part"),
- messageID: userMsg.id,
- sessionID: input.sessionID,
- text: "The following tool was executed by the user",
- synthetic: true,
- }
- await Session.updatePart(userPart)
- const msg: MessageV2.Assistant = {
- id: Identifier.ascending("message"),
- sessionID: input.sessionID,
- parentID: userMsg.id,
- mode: input.agent,
- agent: input.agent,
- cost: 0,
- path: {
- cwd: Instance.directory,
- root: Instance.worktree,
- },
- time: {
- created: Date.now(),
- },
- role: "assistant",
- tokens: {
- input: 0,
- output: 0,
- reasoning: 0,
- cache: { read: 0, write: 0 },
- },
- modelID: model.modelID,
- providerID: model.providerID,
- }
- await Session.updateMessage(msg)
- const part: MessageV2.Part = {
- type: "tool",
- id: Identifier.ascending("part"),
- messageID: msg.id,
- sessionID: input.sessionID,
- tool: "bash",
- callID: ulid(),
- state: {
- status: "running",
- time: {
- start: Date.now(),
- },
- input: {
- command: input.command,
- },
- },
- }
- await Session.updatePart(part)
- const shell = Shell.preferred()
- const shellName = (
- process.platform === "win32" ? path.win32.basename(shell, ".exe") : path.basename(shell)
- ).toLowerCase()
- const invocations: Record<string, { args: string[] }> = {
- nu: {
- args: ["-c", input.command],
- },
- fish: {
- args: ["-c", input.command],
- },
- zsh: {
- args: [
- "-c",
- "-l",
- `
- [[ -f ~/.zshenv ]] && source ~/.zshenv >/dev/null 2>&1 || true
- [[ -f "\${ZDOTDIR:-$HOME}/.zshrc" ]] && source "\${ZDOTDIR:-$HOME}/.zshrc" >/dev/null 2>&1 || true
- eval ${JSON.stringify(input.command)}
- `,
- ],
- },
- bash: {
- args: [
- "-c",
- "-l",
- `
- shopt -s expand_aliases
- [[ -f ~/.bashrc ]] && source ~/.bashrc >/dev/null 2>&1 || true
- eval ${JSON.stringify(input.command)}
- `,
- ],
- },
- // Windows cmd
- cmd: {
- args: ["/c", input.command],
- },
- // Windows PowerShell
- powershell: {
- args: ["-NoProfile", "-Command", input.command],
- },
- pwsh: {
- args: ["-NoProfile", "-Command", input.command],
- },
- // Fallback: any shell that doesn't match those above
- // - No -l, for max compatibility
- "": {
- args: ["-c", `${input.command}`],
- },
- }
- const matchingInvocation = invocations[shellName] ?? invocations[""]
- const args = matchingInvocation?.args
- const proc = spawn(shell, args, {
- cwd: Instance.directory,
- detached: process.platform !== "win32",
- stdio: ["ignore", "pipe", "pipe"],
- env: {
- ...process.env,
- TERM: "dumb",
- },
- })
- let output = ""
- proc.stdout?.on("data", (chunk) => {
- output += chunk.toString()
- if (part.state.status === "running") {
- part.state.metadata = {
- output: output,
- description: "",
- }
- Session.updatePart(part)
- }
- })
- proc.stderr?.on("data", (chunk) => {
- output += chunk.toString()
- if (part.state.status === "running") {
- part.state.metadata = {
- output: output,
- description: "",
- }
- Session.updatePart(part)
- }
- })
- let aborted = false
- let exited = false
- const kill = () => Shell.killTree(proc, { exited: () => exited })
- if (abort.aborted) {
- aborted = true
- await kill()
- }
- const abortHandler = () => {
- aborted = true
- void kill()
- }
- abort.addEventListener("abort", abortHandler, { once: true })
- await new Promise<void>((resolve) => {
- proc.on("close", () => {
- exited = true
- abort.removeEventListener("abort", abortHandler)
- resolve()
- })
- })
- if (aborted) {
- output += "\n\n" + ["<metadata>", "User aborted the command", "</metadata>"].join("\n")
- }
- msg.time.completed = Date.now()
- await Session.updateMessage(msg)
- if (part.state.status === "running") {
- part.state = {
- status: "completed",
- time: {
- ...part.state.time,
- end: Date.now(),
- },
- input: part.state.input,
- title: "",
- metadata: {
- output,
- description: "",
- },
- output,
- }
- await Session.updatePart(part)
- }
- return { info: msg, parts: [part] }
- }
- export const CommandInput = z.object({
- messageID: Identifier.schema("message").optional(),
- sessionID: Identifier.schema("session"),
- agent: z.string().optional(),
- model: z.string().optional(),
- arguments: z.string(),
- command: z.string(),
- variant: z.string().optional(),
- parts: z
- .array(
- z.discriminatedUnion("type", [
- MessageV2.FilePart.omit({
- messageID: true,
- sessionID: true,
- }).partial({
- id: true,
- }),
- ]),
- )
- .optional(),
- })
- export type CommandInput = z.infer<typeof CommandInput>
- const bashRegex = /!`([^`]+)`/g
- // Match [Image N] as single token, quoted strings, or non-space sequences
- const argsRegex = /(?:\[Image\s+\d+\]|"[^"]*"|'[^']*'|[^\s"']+)/gi
- const placeholderRegex = /\$(\d+)/g
- const quoteTrimRegex = /^["']|["']$/g
- /**
- * Regular expression to match @ file references in text
- * Matches @ followed by file paths, excluding commas, periods at end of sentences, and backticks
- * Does not match when preceded by word characters or backticks (to avoid email addresses and quoted references)
- */
- export async function command(input: CommandInput) {
- log.info("command", input)
- const command = await Command.get(input.command)
- const agentName = command.agent ?? input.agent ?? (await Agent.defaultAgent())
- const raw = input.arguments.match(argsRegex) ?? []
- const args = raw.map((arg) => arg.replace(quoteTrimRegex, ""))
- const templateCommand = await command.template
- const placeholders = templateCommand.match(placeholderRegex) ?? []
- let last = 0
- for (const item of placeholders) {
- const value = Number(item.slice(1))
- if (value > last) last = value
- }
- // Let the final placeholder swallow any extra arguments so prompts read naturally
- const withArgs = templateCommand.replaceAll(placeholderRegex, (_, index) => {
- const position = Number(index)
- const argIndex = position - 1
- if (argIndex >= args.length) return ""
- if (position === last) return args.slice(argIndex).join(" ")
- return args[argIndex]
- })
- const usesArgumentsPlaceholder = templateCommand.includes("$ARGUMENTS")
- let template = withArgs.replaceAll("$ARGUMENTS", input.arguments)
- // If command doesn't explicitly handle arguments (no $N or $ARGUMENTS placeholders)
- // but user provided arguments, append them to the template
- if (placeholders.length === 0 && !usesArgumentsPlaceholder && input.arguments.trim()) {
- template = template + "\n\n" + input.arguments
- }
- const shell = ConfigMarkdown.shell(template)
- if (shell.length > 0) {
- const results = await Promise.all(
- shell.map(async ([, cmd]) => {
- try {
- return await $`${{ raw: cmd }}`.quiet().nothrow().text()
- } catch (error) {
- return `Error executing command: ${error instanceof Error ? error.message : String(error)}`
- }
- }),
- )
- let index = 0
- template = template.replace(bashRegex, () => results[index++])
- }
- template = template.trim()
- const taskModel = await (async () => {
- if (command.model) {
- return Provider.parseModel(command.model)
- }
- if (command.agent) {
- const cmdAgent = await Agent.get(command.agent)
- if (cmdAgent?.model) {
- return cmdAgent.model
- }
- }
- if (input.model) return Provider.parseModel(input.model)
- return await lastModel(input.sessionID)
- })()
- try {
- await Provider.getModel(taskModel.providerID, taskModel.modelID)
- } catch (e) {
- if (Provider.ModelNotFoundError.isInstance(e)) {
- const { providerID, modelID, suggestions } = e.data
- const hint = suggestions?.length ? ` Did you mean: ${suggestions.join(", ")}?` : ""
- Bus.publish(Session.Event.Error, {
- sessionID: input.sessionID,
- error: new NamedError.Unknown({ message: `Model not found: ${providerID}/${modelID}.${hint}` }).toObject(),
- })
- }
- throw e
- }
- const agent = await Agent.get(agentName)
- if (!agent) {
- const available = await Agent.list().then((agents) => agents.filter((a) => !a.hidden).map((a) => a.name))
- const hint = available.length ? ` Available agents: ${available.join(", ")}` : ""
- const error = new NamedError.Unknown({ message: `Agent not found: "${agentName}".${hint}` })
- Bus.publish(Session.Event.Error, {
- sessionID: input.sessionID,
- error: error.toObject(),
- })
- throw error
- }
- const templateParts = await resolvePromptParts(template)
- const isSubtask = (agent.mode === "subagent" && command.subtask !== false) || command.subtask === true
- const parts = isSubtask
- ? [
- {
- type: "subtask" as const,
- agent: agent.name,
- description: command.description ?? "",
- command: input.command,
- model: {
- providerID: taskModel.providerID,
- modelID: taskModel.modelID,
- },
- // TODO: how can we make task tool accept a more complex input?
- prompt: templateParts.find((y) => y.type === "text")?.text ?? "",
- },
- ]
- : [...templateParts, ...(input.parts ?? [])]
- const userAgent = isSubtask ? (input.agent ?? (await Agent.defaultAgent())) : agentName
- const userModel = isSubtask
- ? input.model
- ? Provider.parseModel(input.model)
- : await lastModel(input.sessionID)
- : taskModel
- await Plugin.trigger(
- "command.execute.before",
- {
- command: input.command,
- sessionID: input.sessionID,
- arguments: input.arguments,
- },
- { parts },
- )
- const result = (await prompt({
- sessionID: input.sessionID,
- messageID: input.messageID,
- model: userModel,
- agent: userAgent,
- parts,
- variant: input.variant,
- })) as MessageV2.WithParts
- Bus.publish(Command.Event.Executed, {
- name: input.command,
- sessionID: input.sessionID,
- arguments: input.arguments,
- messageID: result.info.id,
- })
- return result
- }
- async function ensureTitle(input: {
- session: Session.Info
- history: MessageV2.WithParts[]
- providerID: string
- modelID: string
- }) {
- if (input.session.parentID) return
- if (!Session.isDefaultTitle(input.session.title)) return
- // Find first non-synthetic user message
- const firstRealUserIdx = input.history.findIndex(
- (m) => m.info.role === "user" && !m.parts.every((p) => "synthetic" in p && p.synthetic),
- )
- if (firstRealUserIdx === -1) return
- const isFirst =
- input.history.filter((m) => m.info.role === "user" && !m.parts.every((p) => "synthetic" in p && p.synthetic))
- .length === 1
- if (!isFirst) return
- // Gather all messages up to and including the first real user message for context
- // This includes any shell/subtask executions that preceded the user's first prompt
- const contextMessages = input.history.slice(0, firstRealUserIdx + 1)
- const firstRealUser = contextMessages[firstRealUserIdx]
- // For subtask-only messages (from command invocations), extract the prompt directly
- // since toModelMessage converts subtask parts to generic "The following tool was executed by the user"
- const subtaskParts = firstRealUser.parts.filter((p) => p.type === "subtask") as MessageV2.SubtaskPart[]
- const hasOnlySubtaskParts = subtaskParts.length > 0 && firstRealUser.parts.every((p) => p.type === "subtask")
- const agent = await Agent.get("title")
- if (!agent) return
- const model = await iife(async () => {
- if (agent.model) return await Provider.getModel(agent.model.providerID, agent.model.modelID)
- return (
- (await Provider.getSmallModel(input.providerID)) ?? (await Provider.getModel(input.providerID, input.modelID))
- )
- })
- const result = await LLM.stream({
- agent,
- user: firstRealUser.info as MessageV2.User,
- system: [],
- small: true,
- tools: {},
- model,
- abort: new AbortController().signal,
- sessionID: input.session.id,
- retries: 2,
- messages: [
- {
- role: "user",
- content: "Generate a title for this conversation:\n",
- },
- ...(hasOnlySubtaskParts
- ? [{ role: "user" as const, content: subtaskParts.map((p) => p.prompt).join("\n") }]
- : MessageV2.toModelMessages(contextMessages, model)),
- ],
- })
- const text = await result.text.catch((err) => log.error("failed to generate title", { error: err }))
- if (text)
- return Session.update(
- input.session.id,
- (draft) => {
- const cleaned = text
- .replace(/<think>[\s\S]*?<\/think>\s*/g, "")
- .split("\n")
- .map((line) => line.trim())
- .find((line) => line.length > 0)
- if (!cleaned) return
- const title = cleaned.length > 100 ? cleaned.substring(0, 97) + "..." : cleaned
- draft.title = title
- },
- { touch: false },
- )
- }
- }
|