@metamask/client-mcp-core 0.1.0

package/dist/mcp-server/knowledge-store.d.mts

@@ -0,0 +1,249 @@
+import type { StepRecordTool, StepRecordObservation, StepRecordOutcome, TestIdItem, A11yNodeTrimmed, KnowledgeStepSummary, RecipeStep, SessionMetadata, KnowledgeScope, KnowledgeFilters, SessionSummary, PriorKnowledgeV1, PriorKnowledgeContext } from "./types/index.mjs";
+import type { ExtensionState } from "../capabilities/types.mjs";
+/**
+ * Configuration options for KnowledgeStore initialization
+ */
+export type KnowledgeStoreConfig = {
+    /**
+     * Root directory for storing knowledge artifacts
+     */
+    rootDir?: string;
+    /**
+     * Prefix for session IDs (default: 'mm-')
+     */
+    sessionIdPrefix?: string;
+    /**
+     * Prefix for tool names (default: 'mm')
+     */
+    toolPrefix?: string;
+};
+/**
+ * Persistent cross-session knowledge store for recording and querying tool invocations.
+ */
+export declare class KnowledgeStore {
+    #private;
+    /**
+     * Initialize KnowledgeStore with optional configuration
+     *
+     * @param config - Configuration options for the store
+     */
+    constructor(config?: KnowledgeStoreConfig);
+    /**
+     * Write session metadata to disk
+     *
+     * @param metadata - Session metadata to persist
+     * @returns Path to the written metadata file
+     */
+    writeSessionMetadata(metadata: SessionMetadata): Promise<string>;
+    /**
+     * List sessions with optional filtering and limit
+     *
+     * @param limit - Maximum number of sessions to return
+     * @param filters - Optional filters for sessions
+     * @returns Array of session summaries
+     */
+    listSessions(limit: number, filters?: KnowledgeFilters): Promise<SessionSummary[]>;
+    /**
+     * Resolve session IDs based on scope and filters
+     *
+     * @param scope - Scope for session resolution (current, all, or specific sessionId)
+     * @param currentSessionId - Current session ID for scope resolution
+     * @param filters - Optional filters to apply to sessions
+     * @returns Array of resolved session IDs
+     */
+    resolveSessionIds(scope: KnowledgeScope, currentSessionId: string | undefined, filters?: KnowledgeFilters): Promise<string[]>;
+    /**
+     * Record a tool execution step with context and artifacts
+     *
+     * @param params - Step recording parameters
+     * @param params.sessionId - Session ID for this step
+     * @param params.toolName - Name of the tool executed
+     * @param params.input - Tool input parameters
+     * @param params.target - Target element information
+     * @param params.outcome - Execution outcome (success/failure)
+     * @param params.observation - Observed state after execution
+     * @param params.durationMs - Execution duration in milliseconds
+     * @param params.screenshotPath - Path to screenshot artifact
+     * @param params.screenshotDimensions - Screenshot dimensions
+     * @param params.screenshotDimensions.width - Screenshot width in pixels
+     * @param params.screenshotDimensions.height - Screenshot height in pixels
+     * @param params.context - Execution context (e2e or prod)
+     * @returns Path to the recorded step file
+     */
+    recordStep(params: {
+        sessionId: string;
+        toolName: string;
+        input?: Record<string, unknown>;
+        target?: StepRecordTool['target'];
+        outcome: StepRecordOutcome;
+        observation: StepRecordObservation;
+        durationMs?: number;
+        screenshotPath?: string;
+        screenshotDimensions?: {
+            /**
+             * Screenshot width in pixels
+             */
+            width: number;
+            /**
+             * Screenshot height in pixels
+             */
+            height: number;
+        };
+        context?: 'e2e' | 'prod';
+    }): Promise<string>;
+    /**
+     * Get the last N steps from the knowledge store
+     *
+     * @param n - Number of steps to retrieve
+     * @param scope - Scope for step retrieval (current, all, or specific sessionId)
+     * @param currentSessionId - Current session ID for scope resolution
+     * @param filters - Optional filters to apply to steps
+     * @returns Array of step summaries
+     */
+    getLastSteps(n: number, scope: KnowledgeScope, currentSessionId: string | undefined, filters?: KnowledgeFilters): Promise<KnowledgeStepSummary[]>;
+    /**
+     * Search steps by query across sessions
+     *
+     * @param query - Search query string
+     * @param limit - Maximum number of results to return
+     * @param scope - Scope for search (current, all, or specific sessionId)
+     * @param currentSessionId - Current session ID for scope resolution
+     * @param filters - Optional filters to apply to steps
+     * @returns Array of matching step summaries
+     */
+    searchSteps(query: string, limit: number, scope: KnowledgeScope, currentSessionId: string | undefined, filters?: KnowledgeFilters): Promise<KnowledgeStepSummary[]>;
+    /**
+     * Generate a recipe summary of steps in a session
+     *
+     * @param sessionId - Session ID to summarize
+     * @returns Session summary with recipe steps
+     */
+    summarizeSession(sessionId: string): Promise<{
+        /**
+         * Session ID
+         */
+        sessionId: string;
+        /**
+         * Total number of steps in session
+         */
+        stepCount: number;
+        /**
+         * Recipe steps describing the session flow
+         */
+        recipe: RecipeStep[];
+    }>;
+    /**
+     * Get all session IDs from the knowledge store
+     *
+     * @returns Array of all session IDs
+     */
+    getAllSessionIds(): Promise<string[]>;
+    /**
+     * Generate prior knowledge from historical sessions
+     *
+     * @param context - Current context for knowledge generation
+     * @param currentSessionId - Current session ID to exclude from results
+     * @returns Prior knowledge object or undefined if no relevant data found
+     */
+    generatePriorKnowledge(context: PriorKnowledgeContext, currentSessionId?: string): Promise<PriorKnowledgeV1 | undefined>;
+}
+/**
+ * Create a default observation object with state and optional artifacts
+ *
+ * @param state - Extension state snapshot
+ * @param testIds - Array of visible test IDs
+ * @param a11yNodes - Array of accessibility nodes
+ * @param priorKnowledge - Optional prior knowledge from history
+ * @returns Observation object for step recording
+ */
+export declare function createDefaultObservation(state: ExtensionState, testIds?: TestIdItem[], a11yNodes?: A11yNodeTrimmed[], priorKnowledge?: PriorKnowledgeV1): StepRecordObservation;
+/**
+ * Create a new KnowledgeStore instance
+ *
+ * @param config - Optional configuration for the store
+ * @returns New KnowledgeStore instance
+ */
+export declare function createKnowledgeStore(config?: KnowledgeStoreConfig): KnowledgeStore;
+/**
+ * Set the global knowledge store instance
+ *
+ * @param store - KnowledgeStore instance to set as global
+ */
+export declare function setKnowledgeStore(store: KnowledgeStore): void;
+/**
+ * Get the global knowledge store instance
+ *
+ * @returns The global KnowledgeStore instance
+ */
+export declare function getKnowledgeStore(): KnowledgeStore;
+/**
+ * Check if a knowledge store has been initialized
+ *
+ * @returns True if knowledge store is initialized
+ */
+export declare function hasKnowledgeStore(): boolean;
+export declare const knowledgeStore: {
+    /**
+     * Record a tool execution step
+     *
+     * @param params - Step recording parameters
+     * @returns Path to the recorded step file
+     */
+    recordStep: (params: Parameters<KnowledgeStore["recordStep"]>[0]) => Promise<string>;
+    /**
+     * Get the last N steps from the knowledge store
+     *
+     * @param args - Arguments for getLastSteps
+     * @returns Array of step summaries
+     */
+    getLastSteps: (n: number, scope: KnowledgeScope, currentSessionId: string | undefined, filters?: KnowledgeFilters | undefined) => Promise<KnowledgeStepSummary[]>;
+    /**
+     * Search steps by query
+     *
+     * @param args - Arguments for searchSteps
+     * @returns Array of matching step summaries
+     */
+    searchSteps: (query: string, limit: number, scope: KnowledgeScope, currentSessionId: string | undefined, filters?: KnowledgeFilters | undefined) => Promise<KnowledgeStepSummary[]>;
+    /**
+     * Generate a recipe summary of a session
+     *
+     * @param args - Arguments for summarizeSession
+     * @returns Session summary with recipe steps
+     */
+    summarizeSession: (sessionId: string) => Promise<{
+        /**
+         * Session ID
+         */
+        sessionId: string;
+        /**
+         * Total number of steps in session
+         */
+        stepCount: number;
+        /**
+         * Recipe steps describing the session flow
+         */
+        recipe: RecipeStep[];
+    }>;
+    /**
+     * List sessions with optional filtering
+     *
+     * @param args - Arguments for listSessions
+     * @returns Array of session summaries
+     */
+    listSessions: (limit: number, filters?: KnowledgeFilters | undefined) => Promise<SessionSummary[]>;
+    /**
+     * Generate prior knowledge from historical sessions
+     *
+     * @param args - Arguments for generatePriorKnowledge
+     * @returns Prior knowledge object or undefined
+     */
+    generatePriorKnowledge: (context: PriorKnowledgeContext, currentSessionId?: string | undefined) => Promise<PriorKnowledgeV1 | undefined>;
+    /**
+     * Write session metadata to disk
+     *
+     * @param metadata - Session metadata to persist
+     * @returns Path to the written metadata file
+     */
+    writeSessionMetadata: (metadata: SessionMetadata) => Promise<string>;
+};
+//# sourceMappingURL=knowledge-store.d.mts.map

package/dist/mcp-server/knowledge-store.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowledge-store.d.mts","sourceRoot":"","sources":["../../src/mcp-server/knowledge-store.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAEV,cAAc,EACd,qBAAqB,EACrB,iBAAiB,EACjB,UAAU,EACV,eAAe,EACf,oBAAoB,EACpB,UAAU,EACV,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,qBAAqB,EAMtB,0BAAgB;AAOjB,OAAO,KAAK,EAAE,cAAc,EAAE,kCAAiC;AAiD/D;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAoBF;;GAEG;AACH,qBAAa,cAAc;;IAmBzB;;;;OAIG;gBACS,MAAM,GAAE,oBAAyB;IA+B7C;;;;;OAKG;IACG,oBAAoB,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAuCtE;;;;;;OAMG;IACG,YAAY,CAChB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,cAAc,EAAE,CAAC;IAoE5B;;;;;;;OAOG;IACG,iBAAiB,CACrB,KAAK,EAAE,cAAc,EACrB,gBAAgB,EAAE,MAAM,GAAG,SAAS,EACpC,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,MAAM,EAAE,CAAC;IA4BpB;;;;;;;;;;;;;;;;;OAiBG;IACG,UAAU,CAAC,MAAM,EAAE;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,MAAM,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;QAClC,OAAO,EAAE,iBAAiB,CAAC;QAC3B,WAAW,EAAE,qBAAqB,CAAC;QACnC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,oBAAoB,CAAC,EAAE;YACrB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YACd;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,OAAO,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;KAC1B,GAAG,OAAO,CAAC,MAAM,CAAC;IAuGnB;;;;;;;;OAQG;IACG,YAAY,CAChB,CAAC,EAAE,MAAM,EACT,KAAK,EAAE,cAAc,EACrB,gBAAgB,EAAE,MAAM,GAAG,SAAS,EACpC,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAoClC;;;;;;;;;OASG;IACG,WAAW,CACf,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,cAAc,EACrB,gBAAgB,EAAE,MAAM,GAAG,SAAS,EACpC,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,oBAAoB,EAAE,CAAC;IA8HlC;;;;;OAKG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QACjD;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAClB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAClB;;WAEG;QACH,MAAM,EAAE,UAAU,EAAE,CAAC;KACtB,CAAC;IAsBF;;;;OAIG;IACG,gBAAgB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAyZ3C;;;;;;OAMG;IACG,sBAAsB,CAC1B,OAAO,EAAE,qBAAqB,EAC9B,gBAAgB,CAAC,EAAE,MAAM,GACxB,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;CA0jBzC;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,cAAc,EACrB,OAAO,GAAE,UAAU,EAAO,EAC1B,SAAS,GAAE,eAAe,EAAO,EACjC,cAAc,CAAC,EAAE,gBAAgB,GAChC,qBAAqB,CAYvB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,CAAC,EAAE,oBAAoB,GAC5B,cAAc,CAEhB;AAID;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,cAAc,CAOlD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAE3C;AAED,eAAO,MAAM,cAAc;IACzB;;;;;OAKG;yBACwB,UAAU,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAGtE;;;;;OAKG;;IAIH;;;;;OAKG;;IAIH;;;;;OAKG;;QAjnCD;;WAEG;mBACQ,MAAM;QACjB;;WAEG;mBACQ,MAAM;QACjB;;WAEG;gBACK,UAAU,EAAE;;IA4mCtB;;;;;OAKG;;IAIH;;;;;OAKG;;IAMH;;;;;OAKG;qCACoC,eAAe;CAGvD,CAAC"}