Use the sidebar menu to navigate between documentation pages

Quick Start

Quick Start Guides

Quick Start Guides

Framework-specific Quick Start Guides

Choose your framework and get started in minutes with minimal setup!

React Integration

npm install @web-interact-mcp/client
// App.tsx
import React, { useEffect } from 'react';
import { createWebInteractMCPController } from '@web-interact-mcp/client';

function App() {
  useEffect(() => {
    const initMCP = async () => {
      const controller = createWebInteractMCPController();
      await controller.loadTools('/mcp-tools.json');
      await controller.createSession('http://localhost:8080'); // Connect to WebInteractMCPServer
    };
    initMCP();
  }, []);

  return (
    <div className="App">
      <h1>My React App with WebInteractMCP</h1>
      <button data-testid="submit-btn">Click Me</button>
    </div>
  );
}

→ Full React Guide

Angular Integration

npm install @web-interact-mcp/client
// mcp.service.ts
import { Injectable } from '@angular/core';
import { createWebInteractMCPController } from '@web-interact-mcp/client';

@Injectable({ providedIn: 'root' })
export class McpService {
  async initialize() {
    const controller = createWebInteractMCPController();
    await controller.loadTools('/assets/mcp-tools.json');
    await controller.createSession('http://localhost:8080'); // Connect to WebInteractMCPServer
  }
}

// app.component.ts
export class AppComponent implements OnInit {
  constructor(private mcpService: McpService) {}
  async ngOnInit() { await this.mcpService.initialize(); }
}

→ Full Angular Guide

Vue.js Integration

npm install @web-interact-mcp/client
<!-- App.vue -->
<template>
  <div id="app">
    <h1>My Vue App with WebInteractMCP</h1>
    <button data-testid="submit-btn">Click Me</button>
  </div>
</template>

<script setup>
import { onMounted } from 'vue';
import { createWebInteractMCPController } from '@web-interact-mcp/client';

onMounted(async () => {
  const controller = createWebInteractMCPController();
  await controller.loadTools('/mcp-tools.json');
  await controller.createSession('http://localhost:8080'); // Connect to WebInteractMCPServer
});
</script>

→ Full Vue Guide

Basic MCP Tools Configuration

Create your tools configuration file:

React/Vue: public/mcp-tools.json
Angular: src/assets/mcp-tools.json

[
  {
    "toolId": "click-button",
    "title": "Click Button",
    "description": "Clicks a button on the page",
    "mode": "silent",
    "steps": [
      {
        "targetElement": "[data-testid='submit-btn']",
        "action": {
          "type": "click",
          "element": "[data-testid='submit-btn']"
        }
      }
    ]
  }
]

Environment Configuration

# .env
REACT_APP_MCP_SERVER_URL=http://localhost:8080    # React
VITE_MCP_SERVER_URL=http://localhost:8080         # Vue
# Angular: use environment.ts

Next Steps