useHostInfo

sunpeak API

Overview

Returns information about the host application, including its name, version, and supported capabilities.

Wraps getHostVersion · getHostCapabilities

MCP Apps SDK reference

Import

import { useHostInfo } from 'sunpeak';

Signature

function useHostInfo(): {
  hostVersion: HostVersion | undefined;
  hostCapabilities: HostCapabilities | undefined;
}

Returns

HostVersion | undefined

Host application name and version.

HostCapabilities | undefined

Host-supported capabilities.

HostVersion

string

Host application name.

string

Host application version.

HostCapabilities

boolean

Whether the host supports calling server tools.

boolean

Whether the host supports opening external links.

boolean

Whether the host supports structured logging.

boolean

Whether the host supports sending messages.

boolean

Whether the host supports display mode changes.

Usage

import { useHostInfo } from 'sunpeak';

function MyResource() {
  const { hostVersion, hostCapabilities } = useHostInfo();

  return (
    <div>
      <p>Host: {hostVersion?.name} {hostVersion?.version}</p>
      <p>Can call tools: {hostCapabilities?.serverTools ? 'Yes' : 'No'}</p>
    </div>
  );
}

See McpUiHostCapabilities for the full protocol-level capabilities type.

Getting Started

CLI

Components

Functions

Hooks

Resources

Tools

Guides

Overview

Wraps getHostVersion · getHostCapabilities

Import

Signature

Returns

HostVersion

HostCapabilities

Usage

​Overview

Wraps getHostVersion · getHostCapabilities

​Import

​Signature

​Returns

​HostVersion

​HostCapabilities

​Usage

Overview

Import

Signature

Returns

HostVersion

HostCapabilities

Usage