@mcp-b/global 1.0.13 → 1.0.15

package/dist/index.d.ts

@@ -0,0 +1,206 @@
+import { CallToolResult, Server, ToolAnnotations } from "@mcp-b/webmcp-ts-sdk";
+import { z } from "zod";
+
+//#region src/global.d.ts
+/**
+ * Initialize the Web Model Context API (window.navigator.modelContext)
+ */
+declare function initializeWebModelContext(): void;
+/**
+ * Cleanup function (for testing/development)
+ */
+declare function cleanupWebModelContext(): void;
+//#endregion
+//#region src/types.d.ts
+/**
+ * JSON Schema definition for tool input parameters
+ */
+interface InputSchema {
+  type: string;
+  properties?: Record<string, {
+    type: string;
+    description?: string;
+    [key: string]: unknown;
+  }>;
+  required?: string[];
+  [key: string]: unknown;
+}
+/**
+ * Zod schema object type (Record<string, ZodType>)
+ * Used for type-safe tool definitions
+ */
+type ZodSchemaObject = Record<string, z.ZodTypeAny>;
+/**
+ * Tool response format (Web API version)
+ * This is compatible with MCP SDK's CallToolResult
+ */
+type ToolResponse = CallToolResult;
+/**
+ * Tool descriptor for Web Model Context API
+ * Extended with full MCP protocol support
+ *
+ * Supports both JSON Schema (Web standard) and Zod schemas (type-safe)
+ *
+ * @template TInputSchema - If using Zod, the schema object type for type inference
+ * @template TOutputSchema - If using Zod, the output schema object type
+ */
+interface ToolDescriptor<TInputSchema extends ZodSchemaObject = Record<string, never>, TOutputSchema extends ZodSchemaObject = Record<string, never>> {
+  /**
+   * Unique identifier for the tool
+   */
+  name: string;
+  /**
+   * Natural language description of what the tool does
+   */
+  description: string;
+  /**
+   * Input schema - accepts EITHER:
+   * - JSON Schema object (Web standard): { type: "object", properties: {...}, required: [...] }
+   * - Zod schema object (type-safe): { text: z.string(), priority: z.enum(...) }
+   *
+   * When using Zod, TypeScript will infer the execute parameter types automatically
+   */
+  inputSchema: InputSchema | TInputSchema;
+  /**
+   * Optional output schema - accepts EITHER:
+   * - JSON Schema object (Web standard): { type: "object", properties: {...} }
+   * - Zod schema object (type-safe): { result: z.string(), success: z.boolean() }
+   */
+  outputSchema?: InputSchema | TOutputSchema;
+  /**
+   * Optional annotations providing hints about tool behavior
+   */
+  annotations?: ToolAnnotations;
+  /**
+   * Function that executes the tool logic
+   *
+   * When using Zod schemas, the args parameter type is automatically inferred from TInputSchema
+   * When using JSON Schema, args is Record<string, unknown>
+   */
+  execute: (args: TInputSchema extends Record<string, never> ? Record<string, unknown> : z.infer<z.ZodObject<TInputSchema>>) => Promise<ToolResponse>;
+}
+/**
+ * Internal validated tool descriptor (used internally by the bridge)
+ * Always stores JSON Schema format for MCP protocol
+ * Plus Zod validators for runtime validation
+ */
+interface ValidatedToolDescriptor {
+  name: string;
+  description: string;
+  inputSchema: InputSchema;
+  outputSchema?: InputSchema;
+  annotations?: ToolAnnotations;
+  execute: (args: Record<string, unknown>) => Promise<ToolResponse>;
+  inputValidator: z.ZodType;
+  outputValidator?: z.ZodType;
+}
+/**
+ * Context provided to models via provideContext()
+ * Contains the base set of tools (Bucket A)
+ */
+interface ModelContextInput {
+  /**
+   * Array of tool descriptors
+   * Supports both JSON Schema and Zod schema formats
+   */
+  tools: ToolDescriptor<any, any>[];
+}
+/**
+ * Tool call event
+ */
+interface ToolCallEvent extends Event {
+  /**
+   * Name of the tool being called
+   */
+  name: string;
+  /**
+   * Arguments passed to the tool
+   */
+  arguments: Record<string, unknown>;
+  /**
+   * Respond with a result
+   */
+  respondWith: (response: ToolResponse) => void;
+}
+/**
+ * ModelContext interface on window.navigator
+ * Implements the W3C Web Model Context API proposal
+ */
+interface ModelContext {
+  /**
+   * Provide context (tools) to AI models
+   * Clears base tools (Bucket A) and replaces with the provided array.
+   * Dynamic tools (Bucket B) registered via registerTool() persist.
+   */
+  provideContext(context: ModelContextInput): void;
+  /**
+   * Register a single tool dynamically
+   * Returns an object with an unregister function to remove the tool
+   * Supports both JSON Schema and Zod schema formats
+   */
+  registerTool<TInputSchema extends ZodSchemaObject = Record<string, never>, TOutputSchema extends ZodSchemaObject = Record<string, never>>(tool: ToolDescriptor<TInputSchema, TOutputSchema>): {
+    unregister: () => void;
+  };
+  /**
+   * Add event listener for tool calls
+   */
+  addEventListener(type: 'toolcall', listener: (event: ToolCallEvent) => void | Promise<void>, options?: boolean | AddEventListenerOptions): void;
+  /**
+   * Remove event listener
+   */
+  removeEventListener(type: 'toolcall', listener: (event: ToolCallEvent) => void | Promise<void>, options?: boolean | EventListenerOptions): void;
+  /**
+   * Dispatch an event
+   */
+  dispatchEvent(event: Event): boolean;
+  /**
+   * Get the list of all registered tools
+   * Returns tools from both buckets (provideContext and registerTool)
+   */
+  listTools(): Array<{
+    name: string;
+    description: string;
+    inputSchema: InputSchema;
+    outputSchema?: InputSchema;
+    annotations?: ToolAnnotations;
+  }>;
+}
+/**
+ * Internal ModelContext interface with additional methods for MCP bridge
+ * Not exposed as part of the public Web Model Context API
+ */
+interface InternalModelContext extends ModelContext {
+  /**
+   * Execute a tool (internal use only by MCP bridge)
+   * @internal
+   */
+  executeTool(toolName: string, args: Record<string, unknown>): Promise<ToolResponse>;
+}
+/**
+ * Internal MCP Bridge state
+ */
+interface MCPBridge {
+  server: Server;
+  tools: Map<string, ValidatedToolDescriptor>;
+  modelContext: InternalModelContext;
+  isInitialized: boolean;
+}
+declare global {
+  interface Navigator {
+    /**
+     * Web Model Context API
+     * Provides tools and context to AI agents
+     */
+    modelContext: ModelContext;
+  }
+  interface Window {
+    /**
+     * Internal MCP server instance (for debugging/advanced use)
+     */
+    __mcpBridge?: MCPBridge;
+  }
+}
+//# sourceMappingURL=types.d.ts.map
+//#endregion
+export { type CallToolResult, InputSchema, InternalModelContext, MCPBridge, ModelContext, ModelContextInput, type ToolAnnotations, ToolCallEvent, ToolDescriptor, ToolResponse, ValidatedToolDescriptor, ZodSchemaObject, cleanupWebModelContext, initializeWebModelContext };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/global.ts","../src/types.ts"],"sourcesContent":[],"mappings":";;;;;;;iBAifgB,yBAAA,CAAA;AAAhB;AAyCA;;iBAAgB,sBAAA,CAAA;;;;;AAzChB;AAyCgB,UCjhBC,WAAA,CDihBqB;;eC/gBvB;;IAFE,WAAW,CAAA,EAAA,MAAA;IAkBhB,CAAA,GAAA,EAAA,MAAA,CAAA,EAAe,OAAA;EAgBf,CAAA,CAAA;EAWK,QAAA,CAAA,EAAA,MAAc,EAAA;EACR,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,OAAA;;;;;;AA2BN,KAvDL,eAAA,GAAkB,MAuDb,CAAA,MAAA,EAvD4B,CAAA,CAAE,UAuD9B,CAAA;;;;AAyBjB;AAGe,KAnEH,YAAA,GAAe,cAmEZ;;;;;;;;;AAcf;AAWiB,UAjFA,cAiFc,CAAA,qBAhFR,eAgFQ,GAhFU,MAgFV,CAAA,MAAA,EAAA,KAAA,CAAA,EAAA,sBA/EP,eA+EO,GA/EW,MA+EX,CAAA,MAAA,EAAA,KAAA,CAAA,CAAA,CAAA;EASlB;;;EAT+B,IAAA,EAAA,MAAA;EAqB3B;;;EAc0B,WAAA,EAAA,MAAA;EACjB;;;;;;;EAaF,WAAA,EA7GT,WA6GS,GA7GK,YA6GL;EAQF;;;;;EAiBH,YAAA,CAAA,EA/HF,WA+HE,GA/HY,aA+HZ;EACD;;;EAQD,WAAA,CAAA,EAnID,eAmIsB;EAKA;;;;;AAMtC;EACU,OAAA,EAAA,CAAA,IAAA,EAtIA,YAsIA,SAtIqB,MAsIrB,CAAA,MAAA,EAAA,KAAA,CAAA,GArIF,MAqIE,CAAA,MAAA,EAAA,OAAA,CAAA,GApIF,CAAA,CAAE,KAoIA,CApIM,CAAA,CAAE,SAoIR,CApIkB,YAoIlB,CAAA,CAAA,EAAA,GAnIH,OAmIG,CAnIK,YAmIL,CAAA;;;;;AAIT;;AAAA,UA/HgB,uBAAA,CA8IU;EAAA,IAAA,EAAA,MAAA;EAAA,WAAA,EAAA,MAAA;eA3IZ;iBACE;gBACD;kBACE,4BAA4B,QAAQ;kBAGpC,CAAA,CAAE;oBACA,CAAA,CAAE;;;;;;UAOL,iBAAA;;;;;SAKR;;;;;UAMQ,aAAA,SAAsB;;;;;;;;aAS1B;;;;0BAKa;;;;;;UAOT,YAAA;;;;;;0BAMS;;;;;;oCAQD,kBAAkB,6CACjB,kBAAkB,6BAElC,eAAe,cAAc;;;;;;uDAUjB,yBAAyB,mCACvB;;;;0DAQF,yBAAyB,mCACvB;;;;uBAMD;;;;;eAMR;;;iBAGE;mBACE;kBACD;;;;;;;UAQD,oBAAA,SAA6B;;;;;sCAKR,0BAA0B,QAAQ;;;;;UAMvD,SAAA;UACP;SACD,YAAY;gBACL;;;;;;;;;kBAUE;;;;;;kBAOA"}