useToolInfo - sunpeak

sunpeak API

Overview

The useToolInfo hook returns metadata about the tool call that instantiated the current app. It is a convenience wrapper around useHostContext.

Wraps onhostcontextchanged

MCP Apps SDK reference

Import

import { useToolInfo } from 'sunpeak';

Signature

function useToolInfo(): ToolInfo | undefined

Returns

return

ToolInfo | undefined

Metadata about the tool call, or undefined if not available.

{
  id?: RequestId;   // JSON-RPC id of the tools/call request
  tool: Tool;       // Tool definition including name, inputSchema, etc.
}

Usage

import { useToolInfo } from 'sunpeak';

function MyResource() {
  const toolInfo = useToolInfo();

  return (
    <div>
      <p>Rendered by: {toolInfo?.tool.name ?? 'unknown tool'}</p>
    </div>
  );
}

The tool info comes from McpUiHostContext.toolInfo.

useUpdateModelContextSend model context updates to the host.

​Overview

Wraps onhostcontextchanged

​Import

​Signature

​Returns

​Usage

Overview

Import

Signature

Returns

Usage