useSendToolListChanged - sunpeak

sunpeak API

Overview

Returns a function to notify the host that a custom app-side tool list has changed, so the host runs tools/list again. Do not call this after useRegisterTool operations. The MCP Apps dynamic registry sends the notification automatically after registerTool(), update(), enable(), disable(), and remove().

Import

import { useSendToolListChanged } from 'sunpeak';

Signature

function useSendToolListChanged(): () => Promise<void>

Returns

() => Promise<void>

Function that sends a tools/list_changed notification to the host.

Usage

import { useAppTools, useSendToolListChanged } from 'sunpeak';
import { useEffect, useState } from 'react';

function DynamicTools() {
  const [canPing, setCanPing] = useState(false);
  const sendToolListChanged = useSendToolListChanged();

  useAppTools({
    tools: canPing ? [{ name: 'ping', description: 'Return pong.' }] : [],
    onCallTool: async () => ({
      content: [{ type: 'text', text: 'pong' }],
    }),
  });

  useEffect(() => {
    if (canPing) void sendToolListChanged();
  }, [canPing, sendToolListChanged]);

  return <button onClick={() => setCanPing(true)}>Add ping tool</button>;
}