Frodo Library - v4.0.0-42
    Preparing search index...

    Type Alias McpCapabilityDescriptor

    Canonical capability descriptor produced by inventory/registry builders.

    type McpCapabilityDescriptor = {
        annotations: McpToolAnnotations;
        argumentMode?: McpCapabilityArgumentMode;
        deploymentTypes: McpDeploymentType[];
        destructive: boolean;
        domain: string;
        id: string;
        identitySurface?: McpIdentitySurface;
        kind: McpCapabilityKind;
        methodName: string;
        modulePath: string[];
        mutating: boolean;
        notes?: string;
        objectType: string;
        objectTypePatterns?: string[];
        operationType: McpCapabilityOperationType;
        parameters?: McpCapabilityParameter[];
        preferredDeploymentTypes?: McpDeploymentType[];
        requiredScopes: string[];
        riskClass: McpCapabilityRiskClass;
        scope?: McpCapabilityScope;
        supportsIncludeTotal?: boolean;
        supportsPaging?: boolean;
        supportsRealm?: boolean;
        toolName: string;
    }
    Index

    Properties

    annotations argumentMode? deploymentTypes destructive domain id identitySurface? kind methodName modulePath mutating notes? objectType objectTypePatterns? operationType parameters? preferredDeploymentTypes? requiredScopes riskClass scope? supportsIncludeTotal? supportsPaging? supportsRealm? toolName

    Properties

    annotations: McpToolAnnotations
    argumentMode?: McpCapabilityArgumentMode

    Optional MCP-facing argument contract for this capability.

    deploymentTypes: McpDeploymentType[]

    Deployment families where this capability is functional. Defaults to ['any'].

    destructive: boolean
    domain: string
    id: string
    identitySurface?: McpIdentitySurface

    Identity surface this capability operates on. Set from OperationCapabilityMeta.identitySurface when available.

    kind: McpCapabilityKind
    methodName: string
    modulePath: string[]
    mutating: boolean
    notes?: string

    Optional human-readable note surfaced in discovery and validation output.

    objectType: string
    objectTypePatterns?: string[]

    Glob-style object type patterns this capability applies to. Set from OperationCapabilityMeta.objectTypePatterns when available.

    operationType: McpCapabilityOperationType
    parameters?: McpCapabilityParameter[]

    Optional ordered/named parameter metadata for this capability.

    preferredDeploymentTypes?: McpDeploymentType[]

    Deployment families where this capability is the preferred/optimal choice. Set from OperationCapabilityMeta.preferredDeploymentTypes when available; absent when no explicit preference has been declared.

    requiredScopes: string[]
    riskClass: McpCapabilityRiskClass
    scope?: McpCapabilityScope

    Optional selector value used to disambiguate generic capabilities.

    supportsIncludeTotal?: boolean

    Whether the generic tool supports includeTotal for this capability.

    supportsPaging?: boolean

    Whether the generic tool supports paging hints for this capability.

    supportsRealm?: boolean

    Whether the generic tool supports realm override for this capability.

    toolName: string

    Settings

    Member Visibility

    On This Page

    Properties