NestJS MCP - v1.0.1
    Preparing search index...

    Interface MCPToolDefinition

    interface MCPToolDefinition {
        name: string;
        description: string;
        parameters: MCPToolParameter[];
        handler: (params: JSONObject) => JSONValue | Promise<JSONValue>;
        schema?: ZodObject<
            ZodRawShape,
            UnknownKeysParam,
            ZodTypeAny,
            { [key: string]: any },
            { [key: string]: any },
        >;
        version?: string;
        deprecated?: boolean;
        deprecationMessage?: string;
        guards?: unknown[];
        interceptors?: unknown[];
        instance?: unknown;
        methodName?: string;
    }
    Index

    Properties

    name description parameters handler schema? version? deprecated? deprecationMessage? guards? interceptors? instance? methodName?

    Properties

    name: string
    description: string
    parameters: MCPToolParameter[]
    handler: (params: JSONObject) => JSONValue | Promise<JSONValue>
    schema?: ZodObject<
        ZodRawShape,
        UnknownKeysParam,
        ZodTypeAny,
        { [key: string]: any },
        { [key: string]: any },
    >

    Optional Zod schema for runtime validation If provided, input will be validated before calling the handler

    version?: string

    Version of the tool (e.g., '1.0.0', 'v2', '2023-11-01')

    deprecated?: boolean

    Deprecation status - true if deprecated

    deprecationMessage?: string

    Deprecation message with migration guidance

    guards?: unknown[]

    Guards to apply to this tool

    interceptors?: unknown[]

    Interceptors to apply to this tool

    instance?: unknown

    Handler instance (for context)

    methodName?: string

    Handler method name (for context)

    Settings

    Member Visibility

    On This Page

    Properties