Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/builtin-tools/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export { FileEditTool } from './tools/FileEditTool/FileEditTool.js'
export { FileReadTool } from './tools/FileReadTool/FileReadTool.js'
export { FileWriteTool } from './tools/FileWriteTool/FileWriteTool.js'
export { GlobTool } from './tools/GlobTool/GlobTool.js'
export { GoalTool } from './tools/GoalTool/GoalTool.js'
export { GrepTool } from './tools/GrepTool/GrepTool.js'
export { LSPTool } from './tools/LSPTool/LSPTool.js'
export { ListMcpResourcesTool } from './tools/ListMcpResourcesTool/ListMcpResourcesTool.js'
Expand Down
253 changes: 253 additions & 0 deletions packages/builtin-tools/src/tools/GoalTool/GoalTool.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,253 @@
import { z } from 'zod/v4'
import { buildTool, type ToolDef } from 'src/Tool.js'
import { jsonStringify } from 'src/utils/slowOperations.js'
import { lazySchema } from 'src/utils/lazySchema.js'
import {
completeGoal,
formatGoalElapsed,
formatGoalStatusLabel,
getGoal,
recordBlockedAttempt,
} from 'src/services/goal/goalState.js'
import { persistCurrentGoal } from 'src/services/goal/goalStorage.js'
import { GOAL_TOOL_NAME } from './constants.js'
import { DESCRIPTION, generatePrompt } from './prompt.js'

function toolLog(msg: string): void {
try {
const { logForDebugging } =
require('src/utils/debug.js') as typeof import('src/utils/debug.js')
logForDebugging(`[goal] tool: ${msg}`)
} catch {
/* debug not available */
}
}

const inputSchema = lazySchema(() =>
z.strictObject({
action: z
.enum(['get', 'update'])
.optional()
.describe(
'Action to perform: "get" to read status, "update" to mark complete or blocked. Defaults to "update" if status is provided, otherwise "get".',
),
status: z
.enum(['complete', 'blocked'])
.optional()
.describe(
'Required for "update". Only "complete" or "blocked" are accepted.',
),
reason: z
.string()
.optional()
.describe('Explanation for the status change. Required for "update".'),
}),
)
type InputSchema = ReturnType<typeof inputSchema>

const outputSchema = lazySchema(() =>
z.object({
success: z.boolean(),
goal: z
.object({
objective: z.string(),
status: z.string(),
tokensUsed: z.number(),
tokenBudget: z.number().nullable(),
elapsed: z.string(),
turnsExecuted: z.number(),
})
.optional(),
message: z.string().optional(),
report: z.string().optional(),
error: z.string().optional(),
}),
)
type OutputSchema = ReturnType<typeof outputSchema>

export type Input = z.infer<InputSchema>
export type Output = z.infer<OutputSchema>

function buildGoalSnapshot() {
const goal = getGoal()
if (!goal) return undefined
return {
objective: goal.objective,
status: formatGoalStatusLabel(goal.status),
tokensUsed: goal.tokensUsed,
tokenBudget: goal.tokenBudget,
elapsed: formatGoalElapsed(goal),
turnsExecuted: goal.turnsExecuted,
}
}

function buildCompletionReport(): string {
const goal = getGoal()
if (!goal) return ''
const budget =
goal.tokenBudget !== null
? `Token usage: ${goal.tokensUsed} / ${goal.tokenBudget}`
: `Token usage: ${goal.tokensUsed}`
return [
'Goal achieved — usage report:',
` ${budget}`,
` Active time: ${formatGoalElapsed(goal)}`,
` Continuation turns: ${goal.turnsExecuted}`,
].join('\n')
}

export const GoalTool = buildTool({
name: GOAL_TOOL_NAME,
searchHint: 'get or update the active goal (complete/blocked)',
maxResultSizeChars: 10_000,
async description() {
return DESCRIPTION
},
async prompt() {
return generatePrompt()
},
get inputSchema(): InputSchema {
return inputSchema()
},
get outputSchema(): OutputSchema {
return outputSchema()
},
userFacingName() {
return 'Goal'
},
shouldDefer: true,
isConcurrencySafe() {
return true
},
isReadOnly(input: Input) {
const action = input.action ?? (input.status ? 'update' : 'get')
return action === 'get'
},
toAutoClassifierInput(input: Input) {
const action = input.action ?? (input.status ? 'update' : 'get')
if (action === 'get') return 'get goal status'
return `update goal: ${input.status} — ${input.reason ?? ''}`
},
async checkPermissions(input: Input) {
return { behavior: 'allow' as const, updatedInput: input }
},
renderToolUseMessage(input: Input) {
const action = input.action ?? (input.status ? 'update' : 'get')
if (action === 'get') return 'Checking goal status…'
return `Updating goal: ${input.status}${input.reason ? ` — ${input.reason}` : ''}`
},
renderToolResultMessage(output: Output) {
if (output.error) return `Goal error: ${output.error}`
if (output.report) return output.report
if (output.goal) {
return `Goal "${output.goal.objective}" — ${output.goal.status}`
}
return output.message ?? 'Done'
},
renderToolUseRejectedMessage() {
return 'Goal operation rejected'
},
async call(input: Input): Promise<{ data: Output }> {
const action = input.action ?? (input.status ? 'update' : 'get')
toolLog(
`called: action=${action}${input.status ? ` status=${input.status}` : ''}${input.reason ? ` reason="${input.reason.slice(0, 60)}"` : ''}`,
)
if (action === 'get') {
const snapshot = buildGoalSnapshot()
if (!snapshot) {
return {
data: {
success: true,
message:
'No active goal. The user can set one with `/goal <objective>`.',
},
}
}
return { data: { success: true, goal: snapshot } }
}

// action === 'update'
if (!input.status) {
return {
data: {
success: false,
error:
'The "status" field is required for update. Use "complete" or "blocked".',
},
}
}

const goal = getGoal()
if (!goal) {
return {
data: {
success: false,
error: 'No active goal to update.',
},
}
}

if (input.status === 'complete') {
const report = buildCompletionReport()
completeGoal()
persistCurrentGoal()
return {
data: {
success: true,
goal: buildGoalSnapshot(),
report,
},
}
}

// status === 'blocked'
const reason = input.reason ?? 'unspecified blocker'
const result = recordBlockedAttempt(reason)
if (!result) {
return {
data: {
success: false,
error: 'Goal is not in a state that accepts blocked attempts.',
},
}
}
persistCurrentGoal()

if (result.status === 'blocked') {
return {
data: {
success: true,
goal: buildGoalSnapshot(),
message: `Goal marked as blocked after ${result.attempts} consecutive attempts. Reason: ${reason}`,
},
}
}

return {
data: {
success: true,
goal: buildGoalSnapshot(),
message: `Blocked attempt ${result.attempts} recorded. The goal remains active — the same condition must persist for 3 consecutive turns before it is marked blocked.`,
},
}
},
mapToolResultToToolResultBlockParam(content: Output, toolUseID: string) {
if (content.error) {
return {
tool_use_id: toolUseID,
type: 'tool_result' as const,
content: `Error: ${content.error}`,
is_error: true,
}
}
const parts: string[] = []
if (content.message) parts.push(content.message)
if (content.report) parts.push(content.report)
if (content.goal) parts.push(jsonStringify(content.goal))
return {
tool_use_id: toolUseID,
type: 'tool_result' as const,
content: parts.join('\n') || 'Done',
}
},
} satisfies ToolDef<InputSchema, Output>)
1 change: 1 addition & 0 deletions packages/builtin-tools/src/tools/GoalTool/constants.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export const GOAL_TOOL_NAME = 'GoalTool'
38 changes: 38 additions & 0 deletions packages/builtin-tools/src/tools/GoalTool/prompt.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
export const DESCRIPTION =
'Get or update the active goal status. The model may only mark a goal as "complete" or "blocked".'

export function generatePrompt(): string {
return `Use this tool to interact with the active thread goal.

## Actions

### get
Returns the current goal state (objective, status, token usage, elapsed time, turns executed).
No input required beyond \`action: "get"\`.

### update
Transition the goal to a terminal status. Only two values are accepted:
- **complete** — All requirements are verified (see Completion Audit below).
- **blocked** — An insurmountable obstacle has persisted for 3+ consecutive turns (see Blocked Audit below).

When marking complete, provide a brief \`reason\` summarising what was achieved.
When marking blocked, provide a \`reason\` describing the specific blocker.

## Completion Audit (required before marking complete)
1. Derive concrete requirements from the objective.
2. Preserve the original scope — do not redefine success around existing work.
3. For every requirement, identify authoritative evidence (test output, file content, command result).
4. Treat tests and manifests as evidence only after confirming they cover the requirement.
5. Treat uncertain or indirect evidence as "not achieved".
6. The audit must PROVE completion, not merely fail to find remaining work.

## Blocked Audit (required before marking blocked)
1. The same blocking condition must persist across at least 3 consecutive continuation turns.
2. "Difficult", "slow", or "partially incomplete" is NOT blocked.
3. Only genuinely insurmountable obstacles qualify (missing credentials, external service down, etc.).

## Important
- You cannot pause, resume, or clear a goal — only the user can do that via \`/goal\`.
- If no goal is active, \`get\` returns a message saying so; \`update\` returns an error.
- On completion, the tool result includes a usage report (tokens, time, turns).`
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}
3 changes: 3 additions & 0 deletions scripts/defines.ts
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,7 @@ export const DEFAULT_BUILD_FEATURES = [
'SSH_REMOTE', // SSH 远程连接,本地 REPL + 远端工具执行
// Autofix PR
'AUTOFIX_PR', // /autofix-pr 命令(fork 引入;docs/jira/AUTOFIX-PR-001.md 承诺默认开启)
// Persistent thread goal command — auto-continuation, JSONL persistence,
// strict completion/blocked audit. See src/services/goal.
'GOAL',
] as const
6 changes: 6 additions & 0 deletions src/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,11 @@ const poor = feature('POOR')
require('./commands/poor/index.js') as typeof import('./commands/poor/index.js')
).default
: null
const goalCmd = feature('GOAL')
? (
require('./commands/goal/index.js') as typeof import('./commands/goal/index.js')
).default
: null
/* eslint-enable @typescript-eslint/no-require-imports */
import thinkback from './commands/thinkback/index.js'
import thinkbackPlay from './commands/thinkback-play/index.js'
Expand Down Expand Up @@ -362,6 +367,7 @@ const COMMANDS = memoize((): Command[] => [
...(forkCmd ? [forkCmd] : []),
...(buddy ? [buddy] : []),
...(poor ? [poor] : []),
...(goalCmd ? [goalCmd] : []),
...(proactive ? [proactive] : []),
...(monitorCmd ? [monitorCmd] : []),
...(coordinatorCmd ? [coordinatorCmd] : []),
Expand Down
Loading