Skip to content

gsoc-borgy: implemented core mcp app workbench with active (requests …#1711

Open
AbdelrahmanELBORGY wants to merge 1 commit into
foss42:mainfrom
AbdelrahmanELBORGY:MCP-APP-PR
Open

gsoc-borgy: implemented core mcp app workbench with active (requests …#1711
AbdelrahmanELBORGY wants to merge 1 commit into
foss42:mainfrom
AbdelrahmanELBORGY:MCP-APP-PR

Conversation

@AbdelrahmanELBORGY

Copy link
Copy Markdown
Contributor

API Dash MCP App & Studio Workbench

This PR introduces API Dash MCP Server and Interactive Studio Workbench SPA.

It allows AI assistants inside editors execute requests against the API Dash core engine and instantly launching a fully interactive, stateful webview workbench directly within the editor.

Highlights of this PR

  • Interactive Master Workbench: A single-page application (SPA) featuring 4 dedicated navigation tabs (Requests, Variables, History, Logs) that users can seamlessly click through without losing state.
  • Bi-Directional Agent Control: The UI can be completely driven by natural language prompts (e.g., "Test this endpoint and check auth"). Once the AI executes the pre-flight check and fires the request, the user can manually edit parameters, modify headers, and re-send the payload directly from the UI canvas.
  • Client-Aware Native Styling: Bypasses sluggish runtime RPC theme handshakes by embedding native IDE CSS variable fallbacks directly into the stylesheet:
    --bg-canvas: var(--vscode-editor-background, #0e1117);
    --text-main: var(--vscode-editor-foreground, #f1f5f9);
    --border-color: var(--vscode-input-border, #242b3b);
    --btn-send-bg: var(--vscode-button-background, #93c5fd);
  • Persistent Hive Execution Ledger: All network traffic and session states are permanently written to an isolated local Hive database (agent_history), enabling seamless historical auditing and instant run re-hydration.

Visual preview

Workbench Testing with prompt
image image

VS Code MCP Server Setup -- only with windows for now

this is the same setup as the previous PR.

Prerequisites

  1. Node.js: You must have Node.js installed on your system to run the MCP server wrapper.
  2. Build the Desktop App: * Because this headless engine relies on API Dash's Flutter native plugins (local database and networking), you must compile the app for your desktop operating system at least once.
    • Run flutter build windows --release in the root directory to generate the required native build artifacts before starting the server.

Workspace Configuration

To connect this engine to your VS Code AI assistant, create a .vscode folder in the root of your workspace containing an mcp.json file.

Add the following configuration, replacing <PATH_TO_APIDASH_REPO> with the absolute path to your cloned repository:

{
  "servers": {
    "apidash-mcp": {
      "command": "node",
      "args": [
        "<PATH_TO_APIDASH_REPO>/scripts/apidash-mcp.js"
      ]
    }
  }
}

Example of a valid path:

  • Windows: "C:/Users/Username/Documents/apidash/scripts/apidash-mcp.js"

Non changed files -- from previous PR

  • apidash-mcp.js
  • mcp_engine.dart
  • mcp_service.dart
  • main.dart

Newly Modified files

  • html_templates.dart
  • tool_handler.dart
  • resource_handler.dart

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant