refactor(athena): extract tool helpers and improve type safety
- Extract helper functions from tools.ts into dedicated tool-helpers.ts - Replace getToolContextProperty workaround with typed AthenaCouncilToolContext - Remove dead code path in formatCouncilLaunchFailure - Add logging for council member launch and session resolution - Update tool description to reflect notification-based workflow Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
This commit is contained in:
parent
ef74577ccb
commit
c8af90715a
@ -3,7 +3,8 @@ export const ATHENA_COUNCIL_TOOL_DESCRIPTION_TEMPLATE = `Execute Athena's multi-
|
|||||||
Pass members as a single-item array containing one member name or model ID. Athena should call this tool once per selected member.
|
Pass members as a single-item array containing one member name or model ID. Athena should call this tool once per selected member.
|
||||||
|
|
||||||
This tool launches the selected member as a background task and returns task/session metadata immediately.
|
This tool launches the selected member as a background task and returns task/session metadata immediately.
|
||||||
Use background_output(task_id=..., block=true) to collect each member result.
|
After launching ALL members, STOP and wait — the system will notify you when tasks complete.
|
||||||
|
Only then call background_output(task_id=...) once per member to collect results. Do NOT poll in a loop.
|
||||||
|
|
||||||
{members}
|
{members}
|
||||||
|
|
||||||
|
|||||||
95
src/tools/athena-council/tool-helpers.ts
Normal file
95
src/tools/athena-council/tool-helpers.ts
Normal file
@ -0,0 +1,95 @@
|
|||||||
|
import type { CouncilConfig, CouncilMemberConfig } from "../../agents/athena/types"
|
||||||
|
import { ATHENA_COUNCIL_TOOL_DESCRIPTION_TEMPLATE } from "./constants"
|
||||||
|
|
||||||
|
function isCouncilConfigured(councilConfig: CouncilConfig | undefined): councilConfig is CouncilConfig {
|
||||||
|
return Boolean(councilConfig && councilConfig.members.length > 0)
|
||||||
|
}
|
||||||
|
|
||||||
|
interface FilterCouncilMembersResult {
|
||||||
|
members: CouncilMemberConfig[]
|
||||||
|
error?: string
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildSingleMemberSelectionError(members: CouncilMemberConfig[]): string {
|
||||||
|
const availableNames = members.map((member) => member.name ?? member.model).join(", ")
|
||||||
|
return `athena_council runs one member per call. Pass exactly one member in members (single-item array). Available members: ${availableNames}.`
|
||||||
|
}
|
||||||
|
|
||||||
|
function filterCouncilMembers(
|
||||||
|
members: CouncilMemberConfig[],
|
||||||
|
selectedNames: string[] | undefined
|
||||||
|
): FilterCouncilMembersResult {
|
||||||
|
if (!selectedNames || selectedNames.length === 0) {
|
||||||
|
return {
|
||||||
|
members: [],
|
||||||
|
error: buildSingleMemberSelectionError(members),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const memberLookup = new Map<string, CouncilMemberConfig>()
|
||||||
|
members.forEach((member) => {
|
||||||
|
memberLookup.set(member.model.toLowerCase(), member)
|
||||||
|
if (member.name) {
|
||||||
|
memberLookup.set(member.name.toLowerCase(), member)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
const unresolved: string[] = []
|
||||||
|
const filteredMembers: CouncilMemberConfig[] = []
|
||||||
|
const includedMembers = new Set<CouncilMemberConfig>()
|
||||||
|
|
||||||
|
selectedNames.forEach((selectedName) => {
|
||||||
|
const selectedKey = selectedName.toLowerCase()
|
||||||
|
const matchedMember = memberLookup.get(selectedKey)
|
||||||
|
if (!matchedMember) {
|
||||||
|
unresolved.push(selectedName)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if (includedMembers.has(matchedMember)) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
includedMembers.add(matchedMember)
|
||||||
|
filteredMembers.push(matchedMember)
|
||||||
|
})
|
||||||
|
|
||||||
|
if (unresolved.length > 0) {
|
||||||
|
const availableDescriptions = members
|
||||||
|
.map((member) => {
|
||||||
|
if (member.name) {
|
||||||
|
return `${member.name} (${member.model})`
|
||||||
|
}
|
||||||
|
return member.model
|
||||||
|
})
|
||||||
|
.join(", ")
|
||||||
|
return {
|
||||||
|
members: [],
|
||||||
|
error: `Unknown council members: ${unresolved.join(", ")}. Available: ${availableDescriptions}.`,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return { members: filteredMembers }
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildToolDescription(councilConfig: CouncilConfig | undefined): string {
|
||||||
|
const memberList = councilConfig?.members.length
|
||||||
|
? councilConfig.members.map((m) => `- ${m.name ?? m.model}`).join("\n")
|
||||||
|
: "No members configured."
|
||||||
|
|
||||||
|
return ATHENA_COUNCIL_TOOL_DESCRIPTION_TEMPLATE.replace("{members}", `Available council members:\n${memberList}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatCouncilLaunchFailure(
|
||||||
|
failures: Array<{ member: { name?: string; model: string }; error: string }>
|
||||||
|
): string {
|
||||||
|
const failureLines = failures
|
||||||
|
.map((failure) => `- **${failure.member.name ?? failure.member.model}**: ${failure.error}`)
|
||||||
|
.join("\n")
|
||||||
|
|
||||||
|
return failureLines
|
||||||
|
? `Failed to launch council member.\n\n### Launch Failures\n\n${failureLines}`
|
||||||
|
: "Failed to launch council member."
|
||||||
|
}
|
||||||
|
|
||||||
|
export { isCouncilConfigured, filterCouncilMembers, buildSingleMemberSelectionError, buildToolDescription, formatCouncilLaunchFailure }
|
||||||
@ -3,7 +3,8 @@
|
|||||||
import { describe, expect, test } from "bun:test"
|
import { describe, expect, test } from "bun:test"
|
||||||
import type { BackgroundManager } from "../../features/background-agent"
|
import type { BackgroundManager } from "../../features/background-agent"
|
||||||
import type { BackgroundTask } from "../../features/background-agent/types"
|
import type { BackgroundTask } from "../../features/background-agent/types"
|
||||||
import { createAthenaCouncilTool, filterCouncilMembers } from "./tools"
|
import { createAthenaCouncilTool } from "./tools"
|
||||||
|
import { filterCouncilMembers } from "./tool-helpers"
|
||||||
|
|
||||||
const mockManager = {
|
const mockManager = {
|
||||||
getTask: () => undefined,
|
getTask: () => undefined,
|
||||||
|
|||||||
@ -1,98 +1,19 @@
|
|||||||
import { tool, type ToolDefinition } from "@opencode-ai/plugin"
|
import { tool, type ToolDefinition } from "@opencode-ai/plugin"
|
||||||
import { executeCouncil } from "../../agents/athena/council-orchestrator"
|
import { executeCouncil } from "../../agents/athena/council-orchestrator"
|
||||||
import type { CouncilConfig, CouncilMemberConfig } from "../../agents/athena/types"
|
import type { CouncilConfig } from "../../agents/athena/types"
|
||||||
import type { BackgroundManager } from "../../features/background-agent"
|
import type { BackgroundManager } from "../../features/background-agent"
|
||||||
import { ATHENA_COUNCIL_TOOL_DESCRIPTION_TEMPLATE } from "./constants"
|
|
||||||
import { createCouncilLauncher } from "./council-launcher"
|
import { createCouncilLauncher } from "./council-launcher"
|
||||||
import { waitForCouncilSessions } from "./session-waiter"
|
import { waitForCouncilSessions } from "./session-waiter"
|
||||||
import type { AthenaCouncilToolArgs } from "./types"
|
import type { AthenaCouncilToolArgs, AthenaCouncilToolContext } from "./types"
|
||||||
import { storeToolMetadata } from "../../features/tool-metadata-store"
|
import { storeToolMetadata } from "../../features/tool-metadata-store"
|
||||||
|
import { log } from "../../shared/logger"
|
||||||
function getToolContextProperty(toolContext: unknown, key: string): unknown {
|
import {
|
||||||
if (typeof toolContext === "object" && toolContext !== null && key in toolContext) {
|
isCouncilConfigured,
|
||||||
return (toolContext as Record<string, unknown>)[key]
|
filterCouncilMembers,
|
||||||
}
|
buildSingleMemberSelectionError,
|
||||||
return undefined
|
buildToolDescription,
|
||||||
}
|
formatCouncilLaunchFailure,
|
||||||
|
} from "./tool-helpers"
|
||||||
function isCouncilConfigured(councilConfig: CouncilConfig | undefined): councilConfig is CouncilConfig {
|
|
||||||
return Boolean(councilConfig && councilConfig.members.length > 0)
|
|
||||||
}
|
|
||||||
|
|
||||||
interface FilterCouncilMembersResult {
|
|
||||||
members: CouncilMemberConfig[]
|
|
||||||
error?: string
|
|
||||||
}
|
|
||||||
|
|
||||||
function buildSingleMemberSelectionError(members: CouncilMemberConfig[]): string {
|
|
||||||
const availableNames = members.map((member) => member.name ?? member.model).join(", ")
|
|
||||||
return `athena_council runs one member per call. Pass exactly one member in members (single-item array). Available members: ${availableNames}.`
|
|
||||||
}
|
|
||||||
|
|
||||||
export function filterCouncilMembers(
|
|
||||||
members: CouncilMemberConfig[],
|
|
||||||
selectedNames: string[] | undefined
|
|
||||||
): FilterCouncilMembersResult {
|
|
||||||
if (!selectedNames || selectedNames.length === 0) {
|
|
||||||
return {
|
|
||||||
members: [],
|
|
||||||
error: buildSingleMemberSelectionError(members),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const memberLookup = new Map<string, CouncilMemberConfig>()
|
|
||||||
members.forEach((member) => {
|
|
||||||
memberLookup.set(member.model.toLowerCase(), member)
|
|
||||||
if (member.name) {
|
|
||||||
memberLookup.set(member.name.toLowerCase(), member)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
const unresolved: string[] = []
|
|
||||||
const filteredMembers: CouncilMemberConfig[] = []
|
|
||||||
const includedMembers = new Set<CouncilMemberConfig>()
|
|
||||||
|
|
||||||
selectedNames.forEach((selectedName) => {
|
|
||||||
const selectedKey = selectedName.toLowerCase()
|
|
||||||
const matchedMember = memberLookup.get(selectedKey)
|
|
||||||
if (!matchedMember) {
|
|
||||||
unresolved.push(selectedName)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if (includedMembers.has(matchedMember)) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
includedMembers.add(matchedMember)
|
|
||||||
filteredMembers.push(matchedMember)
|
|
||||||
})
|
|
||||||
|
|
||||||
if (unresolved.length > 0) {
|
|
||||||
const availableDescriptions = members
|
|
||||||
.map((member) => {
|
|
||||||
if (member.name) {
|
|
||||||
return `${member.name} (${member.model})`
|
|
||||||
}
|
|
||||||
return member.model
|
|
||||||
})
|
|
||||||
.join(", ")
|
|
||||||
return {
|
|
||||||
members: [],
|
|
||||||
error: `Unknown council members: ${unresolved.join(", ")}. Available: ${availableDescriptions}.`,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return { members: filteredMembers }
|
|
||||||
}
|
|
||||||
|
|
||||||
function buildToolDescription(councilConfig: CouncilConfig | undefined): string {
|
|
||||||
const memberList = councilConfig?.members.length
|
|
||||||
? councilConfig.members.map((m) => `- ${m.name ?? m.model}`).join("\n")
|
|
||||||
: "No members configured."
|
|
||||||
|
|
||||||
return ATHENA_COUNCIL_TOOL_DESCRIPTION_TEMPLATE.replace("{members}", `Available council members:\n${memberList}`)
|
|
||||||
}
|
|
||||||
|
|
||||||
export function createAthenaCouncilTool(args: {
|
export function createAthenaCouncilTool(args: {
|
||||||
backgroundManager: BackgroundManager
|
backgroundManager: BackgroundManager
|
||||||
@ -110,7 +31,7 @@ export function createAthenaCouncilTool(args: {
|
|||||||
.optional()
|
.optional()
|
||||||
.describe("Single-item list containing exactly one council member name or model ID."),
|
.describe("Single-item list containing exactly one council member name or model ID."),
|
||||||
},
|
},
|
||||||
async execute(toolArgs: AthenaCouncilToolArgs, toolContext) {
|
async execute(toolArgs: AthenaCouncilToolArgs, toolContext: AthenaCouncilToolContext) {
|
||||||
if (!isCouncilConfigured(councilConfig)) {
|
if (!isCouncilConfigured(councilConfig)) {
|
||||||
return "Athena council is not configured. Add council members to agents.athena.council.members in .opencode/oh-my-opencode.jsonc."
|
return "Athena council is not configured. Add council members to agents.athena.council.members in .opencode/oh-my-opencode.jsonc."
|
||||||
}
|
}
|
||||||
@ -141,14 +62,22 @@ export function createAthenaCouncilTool(args: {
|
|||||||
const launchedMemberModel = launched?.member.model ?? "unknown"
|
const launchedMemberModel = launched?.member.model ?? "unknown"
|
||||||
const launchedTaskId = launched?.taskId ?? "unknown"
|
const launchedTaskId = launched?.taskId ?? "unknown"
|
||||||
|
|
||||||
|
log("[athena-council] Launching council member", { member: launchedMemberName, model: launchedMemberModel, taskId: launchedTaskId })
|
||||||
|
|
||||||
const waitResult = await waitForCouncilSessions(execution.launched, backgroundManager, toolContext.abort)
|
const waitResult = await waitForCouncilSessions(execution.launched, backgroundManager, toolContext.abort)
|
||||||
const launchedSession = waitResult.sessions.find((session) => session.taskId === launchedTaskId)
|
const launchedSession = waitResult.sessions.find((session) => session.taskId === launchedTaskId)
|
||||||
const sessionId = launchedSession?.sessionId ?? "pending"
|
const sessionId = launchedSession?.sessionId ?? "pending"
|
||||||
|
|
||||||
const metadataFn = getToolContextProperty(toolContext, "metadata") as
|
let statusNote = ""
|
||||||
| ((input: { title?: string; metadata?: Record<string, unknown> }) => Promise<void>)
|
if (waitResult.timedOut) {
|
||||||
| undefined
|
statusNote = "\nNote: Session creation timed out. The task is still running — use background_output to check status."
|
||||||
if (metadataFn) {
|
} else if (waitResult.aborted) {
|
||||||
|
statusNote = "\nNote: Session wait was aborted. The task may still be running."
|
||||||
|
}
|
||||||
|
|
||||||
|
log("[athena-council] Session resolved", { taskId: launchedTaskId, sessionId })
|
||||||
|
|
||||||
|
if (toolContext.metadata) {
|
||||||
const memberMetadata = {
|
const memberMetadata = {
|
||||||
title: `Council: ${launchedMemberName}`,
|
title: `Council: ${launchedMemberName}`,
|
||||||
metadata: {
|
metadata: {
|
||||||
@ -159,14 +88,13 @@ export function createAthenaCouncilTool(args: {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
try {
|
try {
|
||||||
await metadataFn(memberMetadata)
|
await toolContext.metadata(memberMetadata)
|
||||||
|
|
||||||
const callID = getToolContextProperty(toolContext, "callID")
|
if (toolContext.callID) {
|
||||||
if (typeof callID === "string") {
|
storeToolMetadata(toolContext.sessionID, toolContext.callID, memberMetadata)
|
||||||
storeToolMetadata(toolContext.sessionID, callID, memberMetadata)
|
|
||||||
}
|
}
|
||||||
} catch {
|
} catch (error) {
|
||||||
// Metadata storage is best-effort — don't mask successful council launch
|
log("[athena-council] Metadata storage failed (best-effort)", { error: error instanceof Error ? error.message : String(error) })
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -176,7 +104,7 @@ Task ID: ${launchedTaskId}
|
|||||||
Session ID: ${sessionId}
|
Session ID: ${sessionId}
|
||||||
Member: ${launchedMemberName}
|
Member: ${launchedMemberName}
|
||||||
Model: ${launchedMemberModel}
|
Model: ${launchedMemberModel}
|
||||||
Status: running
|
Status: running${statusNote}
|
||||||
|
|
||||||
Use \`background_output\` with task_id="${launchedTaskId}" to collect this member's result.
|
Use \`background_output\` with task_id="${launchedTaskId}" to collect this member's result.
|
||||||
- block=true: Wait for completion and return the result
|
- block=true: Wait for completion and return the result
|
||||||
@ -188,17 +116,3 @@ session_id: ${sessionId}
|
|||||||
},
|
},
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
function formatCouncilLaunchFailure(
|
|
||||||
failures: Array<{ member: { name?: string; model: string }; error: string }>
|
|
||||||
): string {
|
|
||||||
if (failures.length === 0) {
|
|
||||||
return "Failed to launch council member."
|
|
||||||
}
|
|
||||||
|
|
||||||
const failureLines = failures
|
|
||||||
.map((failure) => `- **${failure.member.name ?? failure.member.model}**: ${failure.error}`)
|
|
||||||
.join("\n")
|
|
||||||
|
|
||||||
return `Failed to launch council member.\n\n### Launch Failures\n\n${failureLines}`
|
|
||||||
}
|
|
||||||
|
|||||||
@ -2,3 +2,12 @@ export interface AthenaCouncilToolArgs {
|
|||||||
question: string
|
question: string
|
||||||
members?: string[]
|
members?: string[]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface AthenaCouncilToolContext {
|
||||||
|
sessionID: string
|
||||||
|
messageID: string
|
||||||
|
agent: string
|
||||||
|
abort: AbortSignal
|
||||||
|
metadata?: (input: { title?: string; metadata?: Record<string, unknown> }) => void | Promise<void>
|
||||||
|
callID?: string
|
||||||
|
}
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user