mcp-use TypeScript API
    Preparing search index...

    Class Telemetry

    Shared telemetry singleton for node and browser.

    Usage: Tel.getInstance().trackMCPClientInit(...)

    Index
    isEnabled runtimeEnvironment storageCapability userId
    capture flush getSource identify reset setProductVersion setSource shutdown trackAgentExecution trackClientAddServer trackClientRemoveServer trackConnectorInit trackMCPClientInit trackUseMcpConnection trackUseMcpResourceRead trackUseMcpToolCall getInstance
    • get isEnabled(): boolean

      Returns boolean

    • get runtimeEnvironment(): RuntimeEnvironment

      Returns RuntimeEnvironment

    • get storageCapability(): StorageCapability

      Returns StorageCapability

    • get userId(): string

      Returns string

    • Parameters

      • event: BaseTelemetryEvent

      Returns Promise<void>

    • Returns void

    • Returns string

    • Parameters

      • userId: string
      • Optionalproperties: Record<string, unknown>

      Returns void

    • Returns void

    • Parameters

      • version: string

      Returns void

    • Parameters

      • source: string

      Returns void

    • Returns Promise<void>

    • Parameters

      • data: MCPAgentExecutionEventData

      Returns Promise<void>

    • Parameters

      • serverName: string
      • serverConfig: Record<string, any>

      Returns Promise<void>

    • Parameters

      • serverName: string

      Returns Promise<void>

    • Parameters

      • data: ConnectorInitEventData

      Returns Promise<void>

    • Parameters

      • data: MCPClientInitEventData

      Returns Promise<void>

    • Parameters

      • data: {
            connectionTimeMs?: number | null;
            errorType?: string | null;
            hasElicitation: boolean;
            hasOAuth: boolean;
            hasSampling: boolean;
            success: boolean;
            transportType: string;
            url: string;
        }

      Returns Promise<void>

    • Parameters

      • data: { errorType?: string | null; resourceUri: string; success: boolean }

      Returns Promise<void>

    • Parameters

      • data: {
            errorType?: string | null;
            executionTimeMs?: number | null;
            success: boolean;
            toolName: string;
        }

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Accessors
    Methods