mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-15 14:03:49 +00:00
BREAKING CHANGE: ToolDefinition.execute parameter order changed from (id, params, onUpdate, ctx, signal) to (id, params, signal, onUpdate, ctx). This aligns with AgentTool.execute so wrapping built-in tools no longer requires parameter reordering. Update extensions by swapping signal and onUpdate parameters.
63 lines
2 KiB
TypeScript
63 lines
2 KiB
TypeScript
/**
|
|
* Shutdown Command Extension
|
|
*
|
|
* Adds a /quit command that allows extensions to trigger clean shutdown.
|
|
* Demonstrates how extensions can use ctx.shutdown() to exit pi cleanly.
|
|
*/
|
|
|
|
import type { ExtensionAPI } from "@mariozechner/pi-coding-agent";
|
|
import { Type } from "@sinclair/typebox";
|
|
|
|
export default function (pi: ExtensionAPI) {
|
|
// Register a /quit command that cleanly exits pi
|
|
pi.registerCommand("quit", {
|
|
description: "Exit pi cleanly",
|
|
handler: async (_args, ctx) => {
|
|
ctx.shutdown();
|
|
},
|
|
});
|
|
|
|
// You can also create a tool that shuts down after completing work
|
|
pi.registerTool({
|
|
name: "finish_and_exit",
|
|
label: "Finish and Exit",
|
|
description: "Complete a task and exit pi",
|
|
parameters: Type.Object({}),
|
|
async execute(_toolCallId, _params, _signal, _onUpdate, ctx) {
|
|
// Do any final work here...
|
|
// Request graceful shutdown (deferred until agent is idle)
|
|
ctx.shutdown();
|
|
|
|
// This return is sent to the LLM before shutdown occurs
|
|
return {
|
|
content: [{ type: "text", text: "Shutdown requested. Exiting after this response." }],
|
|
details: {},
|
|
};
|
|
},
|
|
});
|
|
|
|
// You could also create a more complex tool with parameters
|
|
pi.registerTool({
|
|
name: "deploy_and_exit",
|
|
label: "Deploy and Exit",
|
|
description: "Deploy the application and exit pi",
|
|
parameters: Type.Object({
|
|
environment: Type.String({ description: "Target environment (e.g., production, staging)" }),
|
|
}),
|
|
async execute(_toolCallId, params, _signal, onUpdate, ctx) {
|
|
onUpdate?.({ content: [{ type: "text", text: `Deploying to ${params.environment}...` }], details: {} });
|
|
|
|
// Example deployment logic
|
|
// const result = await pi.exec("npm", ["run", "deploy", params.environment], { signal });
|
|
|
|
// On success, request graceful shutdown
|
|
onUpdate?.({ content: [{ type: "text", text: "Deployment complete, exiting..." }], details: {} });
|
|
ctx.shutdown();
|
|
|
|
return {
|
|
content: [{ type: "text", text: "Done! Shutdown requested." }],
|
|
details: { environment: params.environment },
|
|
};
|
|
},
|
|
});
|
|
}
|