Files
devclaw-gitea/lib/tools/task-update.ts
Lauren ten Hoor a9e5b9ef3e feat: add task_update and task_comment tools (#33)
Closes #26

This PR adds two new DevClaw tools for better task lifecycle management:

- task_update: Change issue state programmatically without full pickup/complete flow
- task_comment: Add review comments or notes to issues with optional role attribution
2026-02-10 09:20:27 +08:00

145 lines
4.4 KiB
TypeScript

/**
* task_update — Change issue state programmatically.
*
* Use cases:
* - Orchestrator or worker needs to change state without full pickup/complete flow
* - Manual status adjustments (e.g., Planning → To Do after approval)
* - Failed auto-transitions that need correction
*/
import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
import { jsonResult } from "openclaw/plugin-sdk";
import type { ToolContext } from "../types.js";
import { readProjects } from "../projects.js";
import { createProvider } from "../task-managers/index.js";
import { log as auditLog } from "../audit.js";
import type { StateLabel } from "../task-managers/task-manager.js";
const STATE_LABELS: StateLabel[] = [
"Planning",
"To Do",
"Doing",
"To Test",
"Testing",
"Done",
"To Improve",
"Refining",
];
export function createTaskUpdateTool(api: OpenClawPluginApi) {
return (ctx: ToolContext) => ({
name: "task_update",
label: "Task Update",
description: `Change issue state programmatically. Use this when you need to update an issue's status without going through the full pickup/complete flow.
Use cases:
- Orchestrator or worker needs to change state manually
- Manual status adjustments (e.g., Planning → To Do after approval)
- Failed auto-transitions that need correction
- Bulk state changes
Examples:
- Simple: { projectGroupId: "-123456789", issueId: 42, state: "To Do" }
- With reason: { projectGroupId: "-123456789", issueId: 42, state: "To Do", reason: "Approved for development" }`,
parameters: {
type: "object",
required: ["projectGroupId", "issueId", "state"],
properties: {
projectGroupId: {
type: "string",
description: "Telegram/WhatsApp group ID (key in projects.json)",
},
issueId: {
type: "number",
description: "Issue ID to update",
},
state: {
type: "string",
enum: STATE_LABELS,
description: `New state for the issue. One of: ${STATE_LABELS.join(", ")}`,
},
reason: {
type: "string",
description: "Optional audit log reason for the state change",
},
},
},
async execute(_id: string, params: Record<string, unknown>) {
const groupId = params.projectGroupId as string;
const issueId = params.issueId as number;
const newState = params.state as StateLabel;
const reason = (params.reason as string) ?? undefined;
const workspaceDir = ctx.workspaceDir;
if (!workspaceDir) {
throw new Error("No workspace directory available in tool context");
}
// 1. Resolve project
const data = await readProjects(workspaceDir);
const project = data.projects[groupId];
if (!project) {
throw new Error(
`Project not found for groupId ${groupId}. Run project_register first.`,
);
}
// 2. Create provider
const { provider, type: providerType } = createProvider({
repo: project.repo,
});
// 3. Fetch current issue to get current state
const issue = await provider.getIssue(issueId);
const currentState = provider.getCurrentStateLabel(issue);
if (!currentState) {
throw new Error(
`Issue #${issueId} has no recognized state label. Cannot perform transition.`,
);
}
if (currentState === newState) {
return jsonResult({
success: true,
issueId,
state: newState,
changed: false,
message: `Issue #${issueId} is already in state "${newState}".`,
project: project.name,
provider: providerType,
});
}
// 4. Perform the transition
await provider.transitionLabel(issueId, currentState, newState);
// 5. Audit log
await auditLog(workspaceDir, "task_update", {
project: project.name,
groupId,
issueId,
fromState: currentState,
toState: newState,
reason: reason ?? null,
provider: providerType,
});
// 6. Build response
const result = {
success: true,
issueId,
issueTitle: issue.title,
state: newState,
changed: true,
labelTransition: `${currentState}${newState}`,
project: project.name,
provider: providerType,
announcement: `🔄 Updated #${issueId}: "${currentState}" → "${newState}"${reason ? ` (${reason})` : ""}`,
};
return jsonResult(result);
},
});
}