@mcp-web/client 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Fritz Lekschas
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,146 @@
+# MCP Client
+
+An MCP (Model Context Protocol) client that connects AI applications like Claude Desktop to the MCP bridge server, enabling AI-powered control of web applications.
+
+## Overview
+
+This package provides the MCP client that acts as a bridge between AI applications (like Claude Desktop) and web applications. It should be installed and configured in your AI application to connect to the MCP bridge server that communicates with your web application.
+
+## Installation
+
+The MCP client is typically installed via npm when configuring your AI application:
+
+```bash
+npx @mcp-web/client
+```
+
+## Configuration
+
+### For Claude Desktop
+
+The MCP client is configured through Claude Desktop's configuration file. **However, you should not manually configure this**. Instead, the configuration is automatically generated by your web application using the `@mcp-web/core` library.
+
+### Getting Configuration from Your Web App
+
+When you integrate `@mcp-web/core` into your web application, it automatically generates the correct MCP configuration. Your web application should expose this configuration to users (typically through a help dialog or setup page).
+
+Here's how a web application typically exposes the configuration:
+
+```typescript
+// In your web application
+import { MCPWeb } from '@mcp-web/core';
+
+const mcp = new MCPWeb({
+  name: 'My Web App',
+  description: 'Control my web application',
+});
+
+// Get the MCP configuration for Claude Desktop
+const mcpConfig = mcp.mcpConfig;
+
+// Display this to users so they can copy it to Claude Desktop
+console.log(JSON.stringify(mcpConfig, null, 2));
+```
+
+### Example Configuration
+
+The generated configuration will look like this:
+
+```json
+{
+  "My Web App": {
+    "command": "npx",
+    "args": ["@mcp-web/client"],
+    "env": {
+      "MCP_SERVER_URL": "http://localhost:3002",
+      "AUTH_TOKEN": "your-unique-auth-token"
+    }
+  }
+}
+```
+
+This configuration should be added to your Claude Desktop config file at:
+- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
+- **Windows**: `%APPDATA%/Claude/claude_desktop_config.json`
+
+Under the `mcpServers` section:
+
+```json
+{
+  "mcpServers": {
+    "My Web App": {
+      "command": "npx",
+      "args": ["@mcp-web/client"],
+      "env": {
+        "MCP_SERVER_URL": "http://localhost:3002",
+        "AUTH_TOKEN": "your-unique-auth-token"
+      }
+    }
+  }
+}
+```
+
+## Environment Variables
+
+The MCP client uses these environment variables (automatically set by the configuration):
+
+- `MCP_SERVER_URL`: URL of the bridge server (typically `http://localhost:3002`)
+- `AUTH_TOKEN`: Authentication token for secure communication (automatically generated by your web app)
+
+## How It Works
+
+1. **Web Application**: Uses `@mcp-web/core` to register tools and connect to the bridge server
+2. **Bridge Server**: Mediates communication between the web app and MCP clients  
+3. **MCP Client** (this package): Connects Claude Desktop to the bridge server
+4. **Claude Desktop**: Uses the MCP client to access tools from your web application
+
+```
+Claude Desktop ↔ MCP Client ↔ Bridge Server ↔ Web Application
+```
+
+## Setup Process
+
+1. **Install the web library** in your web application:
+   ```bash
+   npm install @mcp-web/core
+   ```
+
+2. **Integrate MCP tools** in your web application using `@mcp-web/core`
+
+3. **Get the configuration** from your web app (usually shown in a help dialog)
+
+4. **Copy the configuration** to Claude Desktop's config file
+
+5. **Restart Claude Desktop** to load the new MCP server
+
+6. **Start using** your web application through Claude Desktop!
+
+## Troubleshooting
+
+- **Connection refused**: Make sure your web application is running and the bridge server is active
+- **Authentication failed**: The auth token in Claude Desktop config must match the one generated by your web app
+- **Tools not available**: Ensure your web application has registered tools using `mcp.addTool()`
+
+## Security
+
+The MCP client uses secure authentication tokens that are:
+- Automatically generated by your web application
+- Unique per application instance
+- Required for all bridge server communications
+
+## Development
+
+This package is part of the MCP Frontend Integration System. For development:
+
+```bash
+npm run build    # Build the client
+npm run dev      # Watch mode for development
+```
+
+## Examples
+
+See the [HiGlass demo](../../demos/higlass) for a complete example of:
+- Setting up `@mcp-web/core` in a React application
+- Registering various types of tools
+- Displaying the MCP configuration to users
+- Complete integration workflow

package/dist/client.d.ts

@@ -0,0 +1,216 @@
+#!/usr/bin/env node
+import { type ErroredListPromptsResult, type ErroredListResourcesResult, type ErroredListToolsResult, type Query } from '@mcp-web/types';
+import { type CallToolResult, type ListPromptsResult, type ListResourcesResult, type ListToolsResult } from '@modelcontextprotocol/sdk/types.js';
+import type { MCPWebClientConfig } from './types.js';
+/**
+ * MCP client that connects AI agents (like Claude Desktop) to the bridge server.
+ *
+ * MCPWebClient implements the MCP protocol and can run as a stdio server for
+ * AI host applications, or be used programmatically in agent server code.
+ *
+ * @example Running as MCP server for Claude Desktop
+ * ```typescript
+ * const client = new MCPWebClient({
+ *   serverUrl: 'http://localhost:3001',
+ *   authToken: 'your-auth-token',
+ * });
+ * await client.run(); // Starts stdio transport
+ * ```
+ *
+ * @example Programmatic usage in agent code
+ * ```typescript
+ * const client = new MCPWebClient({
+ *   serverUrl: 'http://localhost:3001',
+ *   authToken: 'your-auth-token',
+ * });
+ *
+ * // List available tools
+ * const { tools } = await client.listTools();
+ *
+ * // Call a tool
+ * const result = await client.callTool('get_todos');
+ * ```
+ *
+ * @example With query context (for agent servers)
+ * ```typescript
+ * const contextualClient = client.contextualize(query);
+ * const result = await contextualClient.callTool('update_todo', { id: '1' });
+ * await contextualClient.complete('Todo updated successfully');
+ * ```
+ */
+export declare class MCPWebClient {
+    #private;
+    /**
+     * Creates a new MCPWebClient instance.
+     *
+     * @param config - Client configuration with server URL and auth token
+     * @param query - Optional query for contextualized instances (internal use)
+     */
+    constructor(config: MCPWebClientConfig, query?: Query);
+    private getMetaParams;
+    private getParams;
+    private makeToolCallRequest;
+    private makeListToolsRequest;
+    private makeListResourcesRequest;
+    private makeListPromptsRequest;
+    private makeReadResourceRequest;
+    private setupHandlers;
+    /**
+     * Creates a contextualized client for a specific query.
+     *
+     * All tool calls made through the returned client will be tagged with the
+     * query UUID, enabling the bridge to track tool calls for that query.
+     *
+     * @param query - The query object containing uuid and optional responseTool
+     * @returns A new MCPWebClient instance bound to the query context
+     *
+     * @example
+     * ```typescript
+     * const contextualClient = client.contextualize(query);
+     * await contextualClient.callTool('analyze_data');
+     * await contextualClient.complete('Analysis complete');
+     * ```
+     */
+    contextualize(query: Query): MCPWebClient;
+    /**
+     * Calls a tool on the connected frontend.
+     *
+     * Automatically includes query context if this is a contextualized client.
+     * If the query has tool restrictions, only allowed tools can be called.
+     *
+     * @param name - Name of the tool to call
+     * @param args - Optional arguments to pass to the tool
+     * @param sessionId - Optional session ID for multi-session scenarios
+     * @returns Tool execution result
+     * @throws {Error} If query is already done or tool is not allowed
+     *
+     * @example
+     * ```typescript
+     * const result = await client.callTool('create_todo', {
+     *   title: 'New task',
+     *   priority: 'high',
+     * });
+     * ```
+     */
+    callTool(name: string, args?: Record<string, unknown>, sessionId?: string): Promise<CallToolResult>;
+    /**
+     * Lists all available tools from the connected frontend.
+     *
+     * If this is a contextualized client with restricted tools, returns only
+     * those tools. Otherwise fetches all tools from the bridge.
+     *
+     * @param sessionId - Optional session ID for multi-session scenarios
+     * @returns List of available tools
+     * @throws {Error} If query is already done
+     */
+    listTools(sessionId?: string): Promise<ListToolsResult | ErroredListToolsResult>;
+    /**
+     * Lists all available resources from the connected frontend.
+     *
+     * @param sessionId - Optional session ID for multi-session scenarios
+     * @returns List of available resources
+     * @throws {Error} If query is already done
+     */
+    listResources(sessionId?: string): Promise<ListResourcesResult | ErroredListResourcesResult>;
+    /**
+     * Lists all available prompts from the connected frontend.
+     *
+     * @param sessionId - Optional session ID for multi-session scenarios
+     * @returns List of available prompts
+     * @throws {Error} If query is already done
+     */
+    listPrompts(sessionId?: string): Promise<ListPromptsResult | ErroredListPromptsResult>;
+    /**
+     * Sends a progress update for the current query.
+     *
+     * Use this to provide intermediate updates during long-running operations.
+     * Can only be called on a contextualized client instance.
+     *
+     * @param message - Progress message to send to the frontend
+     * @throws {Error} If not a contextualized client or query is done
+     *
+     * @example
+     * ```typescript
+     * await contextualClient.sendProgress('Processing step 1 of 3...');
+     * // ... do work ...
+     * await contextualClient.sendProgress('Processing step 2 of 3...');
+     * ```
+     */
+    sendProgress(message: string): Promise<void>;
+    /**
+     * Marks the current query as complete with a message.
+     *
+     * Can only be called on a contextualized client instance.
+     * If the query specified a responseTool, call that tool instead - calling
+     * this method will result in an error.
+     *
+     * @param message - Completion message to send to the frontend
+     * @throws {Error} If not a contextualized client, query is done, or responseTool was specified
+     *
+     * @example
+     * ```typescript
+     * await contextualClient.complete('Analysis complete: found 5 issues');
+     * ```
+     */
+    complete(message: string): Promise<void>;
+    /**
+     * Marks the current query as failed with an error message.
+     *
+     * Can only be called on a contextualized client instance.
+     * Use this when the query encounters an unrecoverable error.
+     *
+     * @param error - Error message or Error object describing the failure
+     * @throws {Error} If not a contextualized client or query is already done
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   await contextualClient.callTool('risky_operation');
+     * } catch (e) {
+     *   await contextualClient.fail(e);
+     * }
+     * ```
+     */
+    fail(error: string | Error): Promise<void>;
+    /**
+     * Cancels the current query.
+     *
+     * Can only be called on a contextualized client instance.
+     * Use this when the user or system needs to abort query processing.
+     *
+     * @param reason - Optional reason for the cancellation
+     * @throws {Error} If not a contextualized client or query is already done
+     *
+     * @example
+     * ```typescript
+     * // User requested cancellation
+     * await contextualClient.cancel('User cancelled operation');
+     * ```
+     */
+    cancel(reason?: string): Promise<void>;
+    private makeRequest;
+    /**
+     * Fetches server identity (name, version, icon) from the bridge.
+     * Falls back to defaults if the bridge is unreachable.
+     */
+    private fetchBridgeInfo;
+    /**
+     * Starts the MCP server using stdio transport.
+     *
+     * This method is intended for running as a subprocess of an AI host like
+     * Claude Desktop. It connects to stdin/stdout for MCP communication.
+     *
+     * Cannot be called on contextualized client instances.
+     *
+     * @throws {Error} If called on a contextualized client or server not initialized
+     *
+     * @example
+     * ```typescript
+     * // In your entry point script
+     * const client = new MCPWebClient(config);
+     * await client.run();
+     * ```
+     */
+    run(): Promise<void>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";AAEA,OAAO,EAEL,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,sBAAsB,EAK3B,KAAK,KAAK,EAKX,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAGL,KAAK,cAAc,EAEnB,KAAK,iBAAiB,EAEtB,KAAK,mBAAmB,EAExB,KAAK,eAAe,EAKrB,MAAM,oCAAoC,CAAC;AAM5C,OAAO,KAAK,EAEV,kBAAkB,EAEnB,MAAM,YAAY,CAAC;AAMpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,qBAAa,YAAY;;IAMvB;;;;;OAKG;gBACS,MAAM,EAAE,kBAAkB,EAAE,KAAK,CAAC,EAAE,KAAK;IAQrD,OAAO,CAAC,aAAa;IAcrB,OAAO,CAAC,SAAS;YAQH,mBAAmB;YA0HnB,oBAAoB;YAUpB,wBAAwB;YAUxB,sBAAsB;YAUtB,uBAAuB;IAgBrC,OAAO,CAAC,aAAa;IAmBrB;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,YAAY;IAIzC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAoCzG;;;;;;;;;OASG;IACG,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,sBAAsB,CAAC;IAoBtF;;;;;;OAMG;IACG,aAAa,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,0BAA0B,CAAC;IAQlG;;;;;;OAMG;IACG,WAAW,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,wBAAwB,CAAC;IAQ5F;;;;;;;;;;;;;;;OAeG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAyBlD;;;;;;;;;;;;;;OAcG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiC9C;;;;;;;;;;;;;;;;;OAiBG;IACG,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAkChD;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAiC9B,WAAW;IAyDzB;;;OAGG;YACW,eAAe;IAqC7B;;;;;;;;;;;;;;;;OAgBG;IACG,GAAG;CA4BV"}