Skip to main content

Documentation Index

Fetch the complete documentation index at: https://sunpeak.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

MCP Apps SDK 
import { App } from "@modelcontextprotocol/ext-apps";

​
Overview

The ontoolcancelled notification handler is called when tool execution is cancelled. Cancellation can occur for several reasons: the user manually stops the tool, a timeout is reached, or a host-side classifier intervenes. Use this handler to clean up in-progress state, stop animations, and display appropriate feedback to the user. Like all notification handlers, ontoolcancelled should be registered before calling connect().
Register handlers before calling connect() to avoid missing notifications during the initialization handshake.

​
Signature

app.ontoolcancelled = (params) => void;

​
Parameters

​
params.reason
string
Optional reason for the cancellation. May describe the cause (e.g., user action, timeout, or classifier intervention).

​
Usage

​
Basic cancellation handling

const app = new App({ name: "MyApp", version: "1.0.0" });

app.ontoolcancelled = (params) => {
  console.log("Cancelled:", params.reason);
};

await app.connect();

​
Cleaning up in-progress state

app.ontoolcancelled = (params) => {
  // Stop any ongoing animations or processes
  cancelAnimationFrame(currentFrame);
  clearInterval(pollingInterval);

  // Reset UI to idle state
  const status = document.querySelector("#status")!;
  status.textContent = params.reason
    ? `Cancelled: ${params.reason}`
    : "Tool execution was cancelled";
  status.classList.add("cancelled");
};

​
Combining with the full tool lifecycle

app.ontoolinputpartial = (params) => {
  renderPreview(params.arguments);
};

app.ontoolinput = (params) => {
  renderFinalInput(params.arguments);
};

app.ontoolresult = (params) => {
  if (params.isError) {
    renderError(params.content);
  } else {
    renderResult(params.structuredContent);
  }
};

app.ontoolcancelled = (params) => {
  clearPreview();
  showCancelledNotice(params.reason);
};

​
Using with the sunpeak framework

The sunpeak framework provides the useToolData hook, which manages the full tool lifecycle including cancellation as a reactive value. 
import { useToolData } from "sunpeak";

function MyComponent() {
  const toolData = useToolData();
  // toolData.cancelled indicates whether the tool was cancelled
}