@mcp-weave/webui 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 mcp-weave
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,99 @@
+# @mcp-weave/webui
+
+Web UI dashboard for testing MCP servers interactively.
+
+## Installation
+
+```bash
+pnpm add @mcp-weave/webui
+```
+
+## Usage
+
+### Quick Start
+
+```typescript
+import { McpServer, McpTool } from '@mcp-weave/nestjs';
+import { McpWebUI } from '@mcp-weave/webui';
+
+@McpServer({ name: 'my-server', version: '1.0.0' })
+class MyServer {
+  @McpTool({ name: 'add', description: 'Add two numbers' })
+  add(input: { a: number; b: number }) {
+    return { result: input.a + input.b };
+  }
+}
+
+// Start the Web UI
+const webui = new McpWebUI(MyServer, {
+  port: 3000,
+  title: 'My MCP Server Dashboard',
+});
+
+await webui.start();
+// Dashboard available at http://localhost:3000
+```
+
+### Features
+
+- **Interactive Tool Testing**: Call tools with custom inputs and see results
+- **Resource Browser**: Browse and read resources
+- **Prompt Tester**: Test prompts with different arguments
+- **Real-time Logs**: View server logs and messages
+- **JSON Editor**: Edit complex inputs with syntax highlighting
+- **Schema Validation**: Automatic validation based on tool schemas
+
+### CLI Usage
+
+```bash
+# Start dashboard for your server
+mcp-weave webui --port 3000
+
+# With custom title
+mcp-weave webui --port 3000 --title "My Dashboard"
+```
+
+### Dashboard Components
+
+1. **Server Info Panel**: Shows server name, version, and capabilities
+2. **Tools Panel**: List all tools with input forms
+3. **Resources Panel**: Browse and read resources
+4. **Prompts Panel**: Test prompts with argument inputs
+5. **History Panel**: View call history and responses
+6. **Logs Panel**: Real-time server logs
+
+## API Reference
+
+### McpWebUI
+
+```typescript
+interface McpWebUIOptions {
+  port?: number;         // Default: 3000
+  host?: string;         // Default: 'localhost'
+  title?: string;        // Dashboard title
+  theme?: 'light' | 'dark';  // UI theme
+  enableLogs?: boolean;  // Show server logs
+}
+
+class McpWebUI {
+  constructor(serverClass: any, options?: McpWebUIOptions);
+  
+  start(): Promise<void>;
+  stop(): Promise<void>;
+  
+  getUrl(): string;
+}
+```
+
+### Events
+
+```typescript
+webui.on('tool:call', (toolName, input) => { ... });
+webui.on('tool:result', (toolName, result) => { ... });
+webui.on('resource:read', (uri) => { ... });
+webui.on('prompt:get', (name, args) => { ... });
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,178 @@
+import { EventEmitter } from 'events';
+
+/**
+ * Web UI configuration options
+ */
+interface McpWebUIOptions {
+    /** Port to run the dashboard (default: 3000) */
+    port?: number;
+    /** Host to bind to (default: 'localhost') */
+    host?: string;
+    /** Dashboard title */
+    title?: string;
+    /** UI theme */
+    theme?: 'light' | 'dark';
+    /** Enable server logs panel */
+    enableLogs?: boolean;
+}
+/**
+ * Server information for the dashboard
+ */
+interface ServerInfo {
+    name: string;
+    version: string;
+    description?: string;
+    tools: ToolInfo[];
+    resources: ResourceInfo[];
+    prompts: PromptInfo[];
+}
+/**
+ * Tool information for display
+ */
+interface ToolInfo {
+    name: string;
+    description?: string;
+    method: string;
+    inputSchema?: Record<string, unknown>;
+}
+/**
+ * Resource information for display
+ */
+interface ResourceInfo {
+    uri: string;
+    name: string;
+    description?: string;
+    mimeType?: string;
+    method: string;
+}
+/**
+ * Prompt information for display
+ */
+interface PromptInfo {
+    name: string;
+    description?: string;
+    method: string;
+    arguments?: Array<{
+        name: string;
+        description?: string;
+        required?: boolean;
+    }>;
+}
+/**
+ * Call history entry
+ */
+interface CallHistoryEntry {
+    id: string;
+    type: 'tool' | 'resource' | 'prompt';
+    name: string;
+    input?: unknown;
+    output?: unknown;
+    error?: string;
+    timestamp: Date;
+    duration: number;
+}
+/**
+ * McpWebUI - Web dashboard for testing MCP servers
+ */
+declare class McpWebUI extends EventEmitter {
+    private serverClass;
+    private serverInstance;
+    private options;
+    private httpServer;
+    private serverInfo;
+    private callHistory;
+    private logs;
+    constructor(serverClass: new (...args: unknown[]) => unknown, options?: McpWebUIOptions);
+    /**
+     * Initialize server instance and extract metadata
+     */
+    private initialize;
+    /**
+     * Start the Web UI server
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the Web UI server
+     */
+    stop(): Promise<void>;
+    /**
+     * Get the URL of the dashboard
+     */
+    getUrl(): string;
+    /**
+     * Get server information
+     */
+    getServerInfo(): ServerInfo | null;
+    /**
+     * Get call history
+     */
+    getCallHistory(): CallHistoryEntry[];
+    /**
+     * Log a message
+     */
+    private log;
+    /**
+     * Handle HTTP requests
+     */
+    private handleRequest;
+    /**
+     * Serve the main dashboard HTML
+     */
+    private serveDashboard;
+    /**
+     * Serve server info as JSON
+     */
+    private serveServerInfo;
+    /**
+     * Serve tools list
+     */
+    private serveTools;
+    /**
+     * Serve resources list
+     */
+    private serveResources;
+    /**
+     * Serve prompts list
+     */
+    private servePrompts;
+    /**
+     * Serve call history
+     */
+    private serveHistory;
+    /**
+     * Serve server logs
+     */
+    private serveLogs;
+    /**
+     * Handle tool call request
+     */
+    private handleCallTool;
+    /**
+     * Handle resource read request
+     */
+    private handleReadResource;
+    /**
+     * Handle prompt get request
+     */
+    private handleGetPrompt;
+    /**
+     * Read request body
+     */
+    private readBody;
+    /**
+     * Extract parameters from URI template
+     */
+    private extractUriParams;
+    /**
+     * Generate unique ID
+     */
+    private generateId;
+    /**
+     * Generate the dashboard HTML
+     */
+    private generateDashboardHTML;
+}
+
+declare const VERSION = "0.1.0";
+
+export { type CallHistoryEntry, McpWebUI, type McpWebUIOptions, type PromptInfo, type ResourceInfo, type ServerInfo, type ToolInfo, VERSION };

package/dist/index.d.ts

@@ -0,0 +1,178 @@
+import { EventEmitter } from 'events';
+
+/**
+ * Web UI configuration options
+ */
+interface McpWebUIOptions {
+    /** Port to run the dashboard (default: 3000) */
+    port?: number;
+    /** Host to bind to (default: 'localhost') */
+    host?: string;
+    /** Dashboard title */
+    title?: string;
+    /** UI theme */
+    theme?: 'light' | 'dark';
+    /** Enable server logs panel */
+    enableLogs?: boolean;
+}
+/**
+ * Server information for the dashboard
+ */
+interface ServerInfo {
+    name: string;
+    version: string;
+    description?: string;
+    tools: ToolInfo[];
+    resources: ResourceInfo[];
+    prompts: PromptInfo[];
+}
+/**
+ * Tool information for display
+ */
+interface ToolInfo {
+    name: string;
+    description?: string;
+    method: string;
+    inputSchema?: Record<string, unknown>;
+}
+/**
+ * Resource information for display
+ */
+interface ResourceInfo {
+    uri: string;
+    name: string;
+    description?: string;
+    mimeType?: string;
+    method: string;
+}
+/**
+ * Prompt information for display
+ */
+interface PromptInfo {
+    name: string;
+    description?: string;
+    method: string;
+    arguments?: Array<{
+        name: string;
+        description?: string;
+        required?: boolean;
+    }>;
+}
+/**
+ * Call history entry
+ */
+interface CallHistoryEntry {
+    id: string;
+    type: 'tool' | 'resource' | 'prompt';
+    name: string;
+    input?: unknown;
+    output?: unknown;
+    error?: string;
+    timestamp: Date;
+    duration: number;
+}
+/**
+ * McpWebUI - Web dashboard for testing MCP servers
+ */
+declare class McpWebUI extends EventEmitter {
+    private serverClass;
+    private serverInstance;
+    private options;
+    private httpServer;
+    private serverInfo;
+    private callHistory;
+    private logs;
+    constructor(serverClass: new (...args: unknown[]) => unknown, options?: McpWebUIOptions);
+    /**
+     * Initialize server instance and extract metadata
+     */
+    private initialize;
+    /**
+     * Start the Web UI server
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the Web UI server
+     */
+    stop(): Promise<void>;
+    /**
+     * Get the URL of the dashboard
+     */
+    getUrl(): string;
+    /**
+     * Get server information
+     */
+    getServerInfo(): ServerInfo | null;
+    /**
+     * Get call history
+     */
+    getCallHistory(): CallHistoryEntry[];
+    /**
+     * Log a message
+     */
+    private log;
+    /**
+     * Handle HTTP requests
+     */
+    private handleRequest;
+    /**
+     * Serve the main dashboard HTML
+     */
+    private serveDashboard;
+    /**
+     * Serve server info as JSON
+     */
+    private serveServerInfo;
+    /**
+     * Serve tools list
+     */
+    private serveTools;
+    /**
+     * Serve resources list
+     */
+    private serveResources;
+    /**
+     * Serve prompts list
+     */
+    private servePrompts;
+    /**
+     * Serve call history
+     */
+    private serveHistory;
+    /**
+     * Serve server logs
+     */
+    private serveLogs;
+    /**
+     * Handle tool call request
+     */
+    private handleCallTool;
+    /**
+     * Handle resource read request
+     */
+    private handleReadResource;
+    /**
+     * Handle prompt get request
+     */
+    private handleGetPrompt;
+    /**
+     * Read request body
+     */
+    private readBody;
+    /**
+     * Extract parameters from URI template
+     */
+    private extractUriParams;
+    /**
+     * Generate unique ID
+     */
+    private generateId;
+    /**
+     * Generate the dashboard HTML
+     */
+    private generateDashboardHTML;
+}
+
+declare const VERSION = "0.1.0";
+
+export { type CallHistoryEntry, McpWebUI, type McpWebUIOptions, type PromptInfo, type ResourceInfo, type ServerInfo, type ToolInfo, VERSION };