opencode/packages/opencode/src/tool/code-mode.ts at dev · argszero/opencode · GitHub

History

289 lines (263 loc) · 10.7 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

import * as Tool from "./tool"

import { type CallToolResult } from "@modelcontextprotocol/client"

import { Cause, Effect, Schema } from "effect"

import { CodeMode, Tool as SandboxTool, toolError } from "@opencode-ai/codemode"

import { MCP } from "@/mcp"

import { McpCatalog } from "@/mcp/catalog"

import { Agent } from "@/agent/agent"

import { Session } from "@/session/session"

import { Permission } from "@/permission"

import { Plugin } from "@/plugin"

export const CODE_MODE_TOOL = "execute"

const DESCRIPTION = "Run a confined orchestration script with access to connected MCP tools."

export const Parameters = Schema.Struct({

code: Schema.String.annotate({

description: "Script body executed by the confined interpreter.",

}),

})

type CallEntry = { tool: string; status: "running" | "completed" | "error"; input?: Record<string, unknown> }

type Metadata = {

toolCalls: CallEntry[]

error?: boolean

}

type Attachment = NonNullable<Tool.ExecuteResult["attachments"]>[number]

type CatalogEntry = {

path: string

key: string

server: string

local: string

tool: MCP.McpTool

}

function groupByServer(mcpTools: Record<string, MCP.McpTool>, servers: readonly string[]): Map<string, CatalogEntry[]> {

const byLongest = [...servers].sort((a, b) => b.length - a.length)

const groups = new Map<string, CatalogEntry[]>()

for (const key of Object.keys(mcpTools).sort((a, b) => a.localeCompare(b))) {

const server =

byLongest.find((name) => key.startsWith(name + "_")) ?? (key.includes("_") ? key.slice(0, key.indexOf("_")) : key)

const local = server && key.startsWith(server + "_") ? key.slice(server.length + 1) : key

const entry: CatalogEntry = {

path: `${server}.${local}`,

key,

server,

local,

tool: mcpTools[key]!,

}

groups.set(server, [...(groups.get(server) ?? []), entry])

}

return groups

}

export function describeCatalog(mcpTools: Record<string, MCP.McpTool>, servers: readonly string[]): string {

return CodeMode.make({

tools: toolTree(

[...groupByServer(mcpTools, servers).values()].flat(),

() => () => Effect.fail(toolError("Tool preview is not executable.")),

}).instructions()

}

const lastSegment = (uri: string) => {

const trimmed = uri.split(/[?#]/, 1)[0]!.replace(/\/+$/, "")

const segment = trimmed.slice(trimmed.lastIndexOf("/") + 1)

return segment.length > 0 ? segment : undefined

}

const dataUrl = (mime: string, base64: string) => `data:${mime};base64,${base64}`

function projectMcpResult(result: CallToolResult, collect: (attachment: Attachment) => void): unknown {

const text: string[] = []

let files = 0

let images = 0

const push = (attachment: Attachment) => {

files += 1

if (attachment.mime.startsWith("image/")) images += 1

collect(attachment)

}

for (const block of result.content) {

switch (block.type) {

case "text":

text.push(block.text)

break

case "image":

case "audio":

push({ type: "file", mime: block.mimeType, url: dataUrl(block.mimeType, block.data) })

break

case "resource": {

if ("text" in block.resource) {

text.push(block.resource.text)

break

}

const mime = block.resource.mimeType ?? "application/octet-stream"

push({ type: "file", mime, url: dataUrl(mime, block.resource.blob), filename: lastSegment(block.resource.uri) })

break

}

case "resource_link":

// A link is a reference, not fetchable media; hand it to the program instead of the attachment channel.

text.push(`${block.name}: ${block.uri}`)

break

}

if (result.structuredContent !== undefined && result.structuredContent !== null) return result.structuredContent

if (text.length > 0) return text.join("\n")

if (files > 0) {

const noun = files === images ? "image" : "file"

return `[${files} ${noun}${files === 1 ? "" : "s"} attached to the result]`

}

return null

}

type Run = (input: unknown) => Effect.Effect<unknown, unknown>

function toolTree(catalog: readonly CatalogEntry[], run: (entry: CatalogEntry) => Run) {

const tree: Record<string, Record<string, SandboxTool.Definition>> = {}

for (const entry of catalog) {

const namespace = (tree[entry.server] ??= {})

namespace[entry.local] = SandboxTool.make({

description: entry.tool.def.description ?? "",

input: entry.tool.def.inputSchema as SandboxTool.JsonSchema,

output: entry.tool.def.outputSchema as SandboxTool.JsonSchema | undefined,

run: run(entry),

})

}

return tree

}

const invokeChildTool = Effect.fn("CodeMode.invokeChildTool")(function* (input: {

plugin: Plugin.Interface

entry: CatalogEntry

args: Record<string, unknown>

callID: string

ctx: Tool.Context

}) {

yield* input.plugin.trigger(

"tool.execute.before",

{ tool: input.entry.key, sessionID: input.ctx.sessionID, callID: input.callID },

{ args: input.args },

)

const result: CallToolResult = yield* Effect.gen(function* () {

yield* input.ctx.ask({ permission: input.entry.key, metadata: {}, patterns: ["*"], always: ["*"] })

return yield* Effect.promise(() => McpCatalog.callTool(input.entry.tool, input.args, input.ctx.abort))

}).pipe(

Effect.withSpan("Tool.execute", {

attributes: {

"tool.name": input.entry.key,

"tool.call_id": input.callID,

"session.id": input.ctx.sessionID,

"message.id": input.ctx.messageID,

}),

)

yield* input.plugin.trigger(

"tool.execute.after",

{ tool: input.entry.key, sessionID: input.ctx.sessionID, callID: input.callID, args: input.args },

result,

)

return result

})

export const CodeModeTool = Tool.define(

CODE_MODE_TOOL,

Effect.gen(function* () {

const mcp = yield* MCP.Service

const agents = yield* Agent.Service

const sessions = yield* Session.Service

const plugin = yield* Plugin.Service

const init: Tool.DefWithoutID<typeof Parameters, Metadata> = {

description: DESCRIPTION,

parameters: Parameters,

execute: Effect.fn("CodeMode.execute")(function* (params, ctx) {

if (ctx.abort.aborted) {

return {

title: CODE_MODE_TOOL,

metadata: { toolCalls: [], error: true },

output: "Execution cancelled.",

} satisfies Tool.ExecuteResult<Metadata>

}

const agent = yield* agents.get(ctx.agent)

const session = yield* sessions.get(ctx.sessionID).pipe(Effect.orDie)

const ruleset = Permission.merge(agent.permission, session.permission ?? [])

const mcpTools = Permission.visibleTools(yield* mcp.tools(), ruleset)

const servers = Object.keys(yield* mcp.clients()).map(McpCatalog.sanitize)

const catalog = [...groupByServer(mcpTools, servers).values()].flat()

const calls: CallEntry[] = []

const attachments: Attachment[] = []

const publish = () =>

ctx.metadata({ title: CODE_MODE_TOOL, metadata: { toolCalls: calls.map((c) => ({ ...c })) } })

let childCalls = 0

const callTool = (entry: CatalogEntry) => (input: unknown) =>

Effect.gen(function* () {

childCalls += 1

const result = yield* invokeChildTool({

plugin,

entry,

args: (input ?? {}) as Record<string, unknown>,

callID: `${ctx.callID ?? entry.key}/${childCalls}`,

ctx,

})

return projectMcpResult(result, (attachment: Attachment) => void attachments.push(attachment))

}).pipe(

Effect.catchCause((cause) => {

if (Cause.hasInterruptsOnly(cause)) return Effect.interrupt

const error = Cause.squash(cause)

return Effect.fail(toolError(error instanceof Error ? error.message : String(error), error))

}),

)

const runtime = CodeMode.make({

tools: toolTree(catalog, callTool),

onToolCallStart: ({ index, name, input }) =>

Effect.suspend(() => {

const shown = (() => {

if (input === null || input === undefined) return

if (typeof input === "object" && !Array.isArray(input)) {

const value = input as Record<string, unknown>

return Object.keys(value).length > 0 ? value : undefined

}

return { input }

})()

calls[index] = { tool: name, status: "running", ...(shown ? { input: shown } : {}) }

return publish()

}),

onToolCallEnd: ({ index, outcome }) =>

Effect.suspend(() => {

const current = calls[index]

if (current) calls[index] = { ...current, status: outcome === "success" ? "completed" : "error" }

return publish()

}),

})

const abort = Effect.callback<void>((resume) => {

if (ctx.abort.aborted) return resume(Effect.void)

const handler = () => resume(Effect.void)

ctx.abort.addEventListener("abort", handler, { once: true })

return Effect.sync(() => ctx.abort.removeEventListener("abort", handler))

})

const cancelled = (): CodeMode.Result => ({

ok: false,

error: { kind: "ExecutionFailure", message: "Execution cancelled." },

toolCalls: calls.map((call) => ({ name: call.tool })),

})

const result = yield* Effect.raceFirst(runtime.execute(params.code), abort.pipe(Effect.map(cancelled)))

const logs = result.logs ?? []

const withLogs = (text: string) => {

if (logs.length === 0) return text

return text.length > 0 ? `${text}\n\nLogs:\n${logs.join("\n")}` : `Logs:\n${logs.join("\n")}`

}

if (!result.ok) {

if (ctx.abort.aborted) {

return {

title: CODE_MODE_TOOL,

metadata: { toolCalls: calls, error: true },

output: "Execution cancelled.",

} satisfies Tool.ExecuteResult<Metadata>

}

const hints = (result.error.suggestions ?? []).filter((hint) => !result.error.message.includes(hint))

return yield* Effect.fail(new Error(withLogs([result.error.message, ...hints].join("\n"))))

}

// The interpreter validates returned values as plain JSON, so stringify cannot throw;

// it yields undefined only for a program that returns undefined.

const output =

typeof result.value === "string"

? result.value

: (JSON.stringify(result.value, null, 2) ?? String(result.value))

return {

title: CODE_MODE_TOOL,

metadata: { toolCalls: calls },

output: withLogs(output),

...(attachments.length > 0 ? { attachments } : {}),

} satisfies Tool.ExecuteResult<Metadata>

}, Effect.orDie),

}

return init

}),

)

opencode/packages/opencode/src/tool/code-mode.ts at dev · argszero/opencode · GitHub

Expand file tree

Breadcrumbs

code-mode.ts

Latest commit

History

Breadcrumbs

code-mode.ts

File metadata and controls