PlatformMcpSettings

@tsed/platform-mcp

Usage

import { PlatformMcpSettings } from "@tsed/platform-mcp";

See /packages/platform/platform-mcp/src/common/interfaces/PlatformMcpSettings.ts.

Overview

interface PlatformMcpSettings {
    path?: string;
    enabled?: boolean;
    name?: string;
    version?: string;
    title?: Implementation["title"];
    description?: Implementation["description"];
    websiteUrl?: Implementation["websiteUrl"];
    icons?: Implementation["icons"];
    tools?: TokenProvider[];
    resources?: TokenProvider[];
    prompts?: TokenProvider[];
    serverOptions?: ServerOptions;
    transportOptions?: StreamableHTTPServerTransportOptions;
    upstream?: PlatformMcpUpstreamSettings;
    auth?: PlatformMcpAuthSettings | PlatformMcpPreAuthSettings;
}

Description

Configuration fragment accepted under configuration.mcp to wire the Platform MCP module.

path

path?: string;

Mount path for the MCP endpoint. Defaults to /mcp.

enabled

enabled?: boolean;

Whether the HTTP endpoint should be enabled. Defaults to true.

name

name?: string;

Optional name reported to MCP clients. Falls back to the Ts.ED app name.

version

version?: string;

Optional version reported to MCP clients. Falls back to the Ts.ED app version.

title

title?: Implementation["title"];

Optional human-readable server title exposed to MCP clients.

description

description?: Implementation["description"];

Optional server description exposed to MCP clients.

websiteUrl

websiteUrl?: Implementation["websiteUrl"];

Optional canonical website URL exposed to MCP clients.

icons

icons?: Implementation["icons"];

Optional icon descriptors exposed to MCP clients.

tools

tools?: TokenProvider[];

Optional tokens registered through configuration.

resources

resources?: TokenProvider[];

prompts

prompts?: TokenProvider[];

serverOptions

serverOptions?: ServerOptions;

Optional low-level MCP server options forwarded to new McpServer(serverInfo, options).

transportOptions

transportOptions?: StreamableHTTPServerTransportOptions;

Optional transport options for the MCP server.

upstream

upstream?: PlatformMcpUpstreamSettings;

Third-party MCP server exposed through this endpoint (gateway mode).

auth

auth?: PlatformMcpAuthSettings | PlatformMcpPreAuthSettings;

Protect the HTTP endpoint: with an OAuth authorization server (issuer, resource, ...), with a custom check (preAuth), or with both.