PlatformMcpModule

@tsed/platform-mcp

Usage

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

See /packages/platform/platform-mcp/src/http/services/PlatformMcpModule.ts.

Overview

class PlatformMcpModule implements OnRoutesInit {
    protected settings: PlatformMcpSettings | PlatformMcpSettings[];
    protected app: import("@tsed/platform-http").PlatformApplication<TsED.Application>;
    protected mcps: PlatformRouteDetails[];
    protected platformAuthService: PlatformMcpAuthService;
    $onRoutesInit(): void;
    $logRoutes(routes: PlatformRouteDetails[]): PlatformRouteDetails[];
    protected validate(path: string, opts: PlatformMcpSettings): void;
    protected methodNotAllowed($ctx: PlatformContext): import("@tsed/platform-http").PlatformResponse<any>;
    protected metadata(settings: CreateMcpServerOpts, $ctx: PlatformContext): import("@tsed/platform-http").PlatformResponse<any>;
    protected dispatch(settings: CreateMcpServerOpts, $ctx: PlatformContext): Promise<import("@tsed/platform-http").PlatformResponse<any> | undefined>;
}

Description

Platform module that mounts the MCP HTTP endpoint and forwards requests to the configured server instance.

protected settings

protected settings: PlatformMcpSettings | PlatformMcpSettings[];

protected app: import

protected app: import("@tsed/platform-http").PlatformApplication<TsED.Application>;

protected mcps

protected mcps: PlatformRouteDetails[];

protected platformAuthService

protected platformAuthService: PlatformMcpAuthService;

$onRoutesInit

$onRoutesInit(): void;

$logRoutes

$logRoutes(routes: PlatformRouteDetails[]): PlatformRouteDetails[];

protected validate

protected validate(path: string, opts: PlatformMcpSettings): void;

Rejects a configuration that cannot work or would be unsafe, before any route is mounted.

protected methodNotAllowed

protected methodNotAllowed($ctx: PlatformContext): import("@tsed/platform-http").PlatformResponse<any>;

Answers the methods of the Streamable HTTP transport that a stateless endpoint does not serve, so MCP clients know there is no event stream instead of receiving the application's 404 page.

protected metadata

protected metadata(settings: CreateMcpServerOpts, $ctx: PlatformContext): import("@tsed/platform-http").PlatformResponse<any>;

protected dispatch

protected dispatch(settings: CreateMcpServerOpts, $ctx: PlatformContext): Promise<import("@tsed/platform-http").PlatformResponse<any> | undefined>;