Skip to main content

​
Overview

The useToolResponseMetadata hook provides access to metadata returned from MCP tool responses.

​
Import

import { useToolResponseMetadata } from 'sunpeak';

​
Signature

function useToolResponseMetadata<T = Record<string, unknown>>(): T | null

​
Parameters

​
T
type parameter
Optional TypeScript type for the metadata.

​
Returns

​
return
T | null
The tool response metadata object, or null if not available.

​
Usage

import { useToolResponseMetadata } from 'sunpeak';

interface ResponseMetadata {
  timestamp: string;
  cached: boolean;
}

function DataWidget() {
  const metadata = useToolResponseMetadata<ResponseMetadata>();

  return (
    <div>
      {metadata?.cached && <span>Cached result</span>}
      {metadata?.timestamp && <time>{metadata.timestamp}</time>}
    </div>
  );
}