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

    Interface MCPToolWithParamsMetadata

    Combined decorator for tool with parameters

    interface MCPToolWithParamsMetadata {
        name: string;
        description: string;
        version?: string;
        deprecation?: DeprecationInfo;
        parameters?: MCPToolParameter[];
        schema?: ZodObject<
            ZodRawShape,
            UnknownKeysParam,
            ZodTypeAny,
            { [key: string]: any },
            { [key: string]: any },
        >;
    }

    Hierarchy (View Summary)

    Index

    Properties

    name description version? deprecation? parameters? schema?

    Properties

    name: string
    description: string
    version?: string

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

    deprecation?: DeprecationInfo

    Deprecation information

    parameters?: MCPToolParameter[]

    Manual parameter definitions Use 'schema' instead for Zod-based validation

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

    Zod schema for validating tool input parameters Preferred over 'parameters' for type-safe validation

    Settings

    Member Visibility

    On This Page

    Properties