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

    Interface MCPPromptMetadata

    Metadata for MCP prompt

    interface MCPPromptMetadata {
        name: string;
        description?: string;
        arguments?: { name: string; description?: string; required?: boolean }[];
        schema?: ZodObject<
            ZodRawShape,
            UnknownKeysParam,
            ZodTypeAny,
            { [key: string]: any },
            { [key: string]: any },
        >;
        version?: string;
        deprecation?: DeprecationInfo;
    }
    Index

    Properties

    name description? arguments? schema? version? deprecation?

    Properties

    name: string
    description?: string
    arguments?: { name: string; description?: string; required?: boolean }[]

    Manual argument definitions (legacy approach) Use 'schema' instead for Zod-based validation

    schema?: ZodObject<
        ZodRawShape,
        UnknownKeysParam,
        ZodTypeAny,
        { [key: string]: any },
        { [key: string]: any },
    >

    Zod schema for validating prompt arguments Preferred over 'arguments' for type-safe validation

    version?: string

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

    deprecation?: DeprecationInfo

    Deprecation information

    Settings

    Member Visibility

    On This Page

    Properties