Introducing Socket Firewall: Free, Proactive Protection for Your Software Supply Chain.Learn More
Socket
Book a DemoInstallSign in
Socket

wopee-mcp

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

wopee-mcp

MCP server for Wopee.io autonomous testing platform

latest
Source
npmnpm
Version
1.0.3
Version published
Maintainers
1
Created
Source

Wopee MCP Server

A Model Context Protocol (MCP) server for integrating with the Wopee testing platform. This server provides tools for dispatching analysis, generating app context, user stories, test cases, and running test executions through GraphQL API calls.

Features

  • Dispatch Analysis: Start analysis of web applications to understand their structure and behavior
  • Dispatch Agent: Execute tests for specific projects and suites
  • Generate App Context: Create detailed application context based on analysis results
  • Generate General User Stories: Generate high-level user stories from analysis data
  • Generate User Stories: Generate detailed user stories and acceptance criteria from analysis data
  • Generate Test Cases: Generate comprehensive test cases from analysis and user stories
  • Get App Context: Retrieve existing app context for a project and suite
  • Get User Stories: Retrieve existing user stories for a project and suite
  • Get Test Cases: Retrieve existing test cases for a project and suite
  • Fetch Analysis Suites: Fetch all analysis suites for a project

Installation

For VS Code:

  • Open VS Code
  • Press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
  • Type "MCP: Install Server" and select it
  • Enter: wopee-mcp
  • Configure your API key when prompted

For Cursor:

  • Open Cursor
  • Press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
  • Type "MCP: Install Server" and select it
  • Enter: wopee-mcp
  • Configure your API key when prompted

Option 2: Manual Installation

  • Install the package globally:
npm install -g wopee-mcp
  • Set up environment variables using a .env file:
# Create a .env file in the project root
cp env.example .env

# Edit the .env file with your API key
# WOPEE_API_KEY=your_api_key_here
# WOPEE_API_URL=https://api.wopee.io/

Alternative: Set system environment variables:

export WOPEE_API_KEY=your_api_key_here
export WOPEE_API_URL=https://api.wopee.io/

Option 3: Development Installation

  • Clone the repository:
git clone <repository-url>
cd wopee-mcp
  • Install dependencies:
npm install
  • Set up environment variables:
cp env.example .env
  • Edit .env file with your Wopee API credentials:
WOPEE_API_KEY=your_api_key_here
WOPEE_API_URL=https://api.wopee.io/

VS Code & Cursor Integration

Prerequisites

Before using the Wopee MCP server, ensure you have:

  • VS Code with the MCP extension installed, or Cursor (which has built-in MCP support)
  • A Wopee API key from wopee.io
  • Node.js 18+ installed on your system

VS Code Setup

Method 1: One-Click Installation (Easiest)

  • Open VS Code and ensure you have the MCP extension installed
  • Open Command Palette: Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac)
  • Type: MCP: Install Server
  • Enter package name: wopee-mcp
  • Configure API key when prompted

Method 2: Manual Configuration

  • Install the package globally:

    npm install -g wopee-mcp
    
  • Open VS Code settings (Ctrl+, or Cmd+,)

  • Search for "MCP" and find the MCP settings

  • Add server configuration:

    {
      "mcp.servers": {
        "wopee": {
          "command": "wopee-mcp",
          "args": [],
          "env": {
            "WOPEE_API_KEY": "your_api_key_here",
            "WOPEE_API_URL": "https://api.wopee.io/"
          }
        }
      }
    }
    
  • Restart VS Code to load the new MCP server

Cursor Setup

Method 1: One-Click Installation (Easiest)

  • Open Cursor (MCP support is built-in)
  • Open Command Palette: Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac)
  • Type: MCP: Install Server
  • Enter package name: wopee-mcp
  • Configure API key when prompted

Method 2: Manual Configuration

  • Install the package globally:

    npm install -g wopee-mcp
    
  • Open Cursor settings (Ctrl+, or Cmd+,)

  • Navigate to MCP settings in the sidebar

  • Add server configuration:

    {
      "mcp.servers": {
        "wopee": {
          "command": "wopee-mcp",
          "args": [],
          "env": {
            "WOPEE_API_KEY": "your_api_key_here",
            "WOPEE_API_URL": "https://api.wopee.io/"
          }
        }
      }
    }
    
  • Restart Cursor to load the new MCP server

Using the Tools

Once configured, you can use the Wopee tools in your chat interface:

Dispatch Analysis

@wopee wopee_dispatch_analysis
Project UUID: project-123
Iterations: 5
Suite Analysis Config:
  - Starting URL: https://example.com
  - Username: testuser
  - Password: testpass
  - Cookies Preference: ACCEPT_ALL

Dispatch Agent

@wopee wopee_dispatch_agent
Project UUID: project-123
Suite UUID: suite-123
Analysis Identifier: analysis-123
Test Cases: [{"testCaseId": "test-1", "userStoryId": "story-1"}]

Generate App Context

@wopee wopee_generate_app_context
Project UUID: project-123
Suite UUID: suite-123
Extra Prompt: Focus on user authentication flows

Generate General User Stories

@wopee wopee_generate_general_user_stories
Project UUID: project-123
Suite UUID: suite-123
Extra Prompt: Include high-level business requirements

Generate User Stories

@wopee wopee_generate_user_stories
Project UUID: project-123
Suite UUID: suite-123
Extra Prompt: Include edge cases and error scenarios

Generate Test Cases

@wopee wopee_generate_test_cases
Project UUID: project-123
Suite UUID: suite-123
Extra Prompt: Generate comprehensive test coverage
Selected User Stories: ["story-1", "story-2"]

7. wopee_get_app_context

Get existing app context for a project and suite.

Parameters:

  • projectUuid (string, required): UUID of the project
  • suiteUuid (string, required): UUID of the test suite

Example:

{
  "projectUuid": "project-123",
  "suiteUuid": "suite-123"
}

8. wopee_get_user_stories

Get existing user stories for a project and suite.

Parameters:

  • projectUuid (string, required): UUID of the project
  • suiteUuid (string, required): UUID of the test suite

Example:

{
  "projectUuid": "project-123",
  "suiteUuid": "suite-123"
}

9. wopee_get_test_cases

Get existing test cases for a project and suite.

Parameters:

  • projectUuid (string, required): UUID of the project
  • suiteUuid (string, required): UUID of the test suite

Example:

{
  "projectUuid": "project-123",
  "suiteUuid": "suite-123"
}

10. wopee_fetch_analysis_suites

Fetch all analysis suites for a given project.

Parameters:

  • projectUuid (string, required): UUID of the project

Example:

{
  "projectUuid": "project-123"
}

Response: Returns an array of analysis suites with detailed information including:

  • Suite UUID, name, and type
  • Upload and execution status
  • Analysis identifier
  • Suite running status
  • Generation state for app context, user stories, and test cases
  • Creation and update timestamps

Troubleshooting

Common Issues

  • "Command not found" error:

    • Ensure the package is installed globally: npm install -g wopee-mcp
    • Check that Node.js is in your PATH
  • "API key not configured" error:

    • Verify your API key is set in the environment variables
    • Check the MCP server configuration in VS Code/Cursor settings
  • "Connection failed" error:

    • Verify your internet connection
    • Check if the Wopee API URL is correct
    • Ensure your API key is valid
  • Tools not appearing:

    • Restart VS Code/Cursor after configuration
    • Check the MCP server logs for errors
    • Verify the server is running: wopee-mcp --version

Getting Help

  • Check logs: Look in the MCP server output panel
  • Verify installation: Run wopee-mcp --help in terminal
  • Test connection: Use the wopee_start_analysis tool with a simple URL

Configuration

The server loads configuration from a .env file in the project root directory (where package.json is located).

Environment Variables

  • WOPEE_API_KEY (required): Your Wopee API key
  • WOPEE_PROJECT_UUID (required): Your Wopee project UUID
  • WOPEE_API_URL (optional): Wopee API endpoint (defaults to https://api.wopee.io/)

Setting up .env file

  • Copy the example file:

    cp env.example .env
    
  • Edit the .env file in the project root:

    # Wopee API Configuration
    WOPEE_API_KEY=your_actual_api_key_here
    WOPEE_PROJECT_UUID=your_project_uuid_here
    WOPEE_API_URL=https://api.dev.wopee.io/
    
  • For MCP integration, update your mcp.json:

    {
      "mcpServers": {
        "wopee": {
          "command": "node",
          "args": ["/path/to/wopee-mcp/dist/index.js"],
          "env": {}
        }
      }
    }
    

    Note: The server automatically loads API keys from the .env file in the project root. No need to hardcode them in the MCP configuration.

Usage

Development

Run the server in development mode:

npm run dev

Production

Build and run the server:

npm run build
npm start

Testing

Run the test suite:

npm test

Run tests in watch mode:

npm run test:watch

Run tests with coverage:

npm run test:coverage

Package Management

Building the Package

Clean build (removes dist and rebuilds):

npm run build:clean

Validate the package:

npm run validate

Publishing to npm

Prerequisites:

  • Create an npm account at npmjs.com
  • Login to npm: npm login
  • Ensure you have publish permissions for the package

Publishing Workflow:

  • Prepare for release:

    ./scripts/prepare-release.sh
    
  • Publish the package:

    ./scripts/publish.sh
    
  • Or use npm scripts directly:

    # Dry run (test without publishing)
    npm run publish:dry-run
    
    # Publish patch version (1.0.0 -> 1.0.1)
    npm run publish:patch
    
    # Publish minor version (1.0.0 -> 1.1.0)
    npm run publish:minor
    
    # Publish major version (1.0.0 -> 2.0.0)
    npm run publish:major
    

Manual Publishing:

# 1. Update version
npm version patch  # or minor, major

# 2. Publish
npm publish

Available Tools

1. wopee_start_analysis

Start a new analysis for a given URL.

Parameters:

  • url (string, required): URL of the application to analyze

Example:

{
  "url": "https://example.com"
}

2. wopee_generate_app_context

Generate application context based on analysis results.

Parameters:

  • analysisId (string, required): ID of the analysis to generate context from
  • prompt (string, optional): Optional prompt to modify the app context generation

Example:

{
  "analysisId": "analysis-123",
  "prompt": "Focus on user authentication flows"
}

3. wopee_generate_user_stories

Generate user stories based on analysis results.

Parameters:

  • analysisId (string, required): ID of the analysis to generate user stories from
  • prompt (string, optional): Optional prompt to modify the user story generation

Example:

{
  "analysisId": "analysis-123",
  "prompt": "Include edge cases and error scenarios"
}

4. wopee_generate_tests

Generate test files by fetching generated scenarios from the Wopee platform.

Parameters:

  • projectUuid (string, required): UUID of the project
  • suiteUuid (string, required): UUID of the test suite
  • bucket (string, required): Bucket name containing the generated scenarios

Example:

{
  "projectUuid": "e70d893f-b70a-4e45-a93a-7c08ef289aa9",
  "suiteUuid": "f0cd35a5-0e11-4d33-995b-433706e10542",
  "bucket": "project-suite-generated-scenarios"
}

5. wopee_run_tests

Run tests either by analysis ID or specific test IDs.

Parameters:

  • analysisId (string, optional): ID of the analysis to run tests for
  • testIds (array of strings, optional): Array of specific test IDs to run

Note: Either analysisId or testIds must be provided.

Example with analysis ID:

{
  "analysisId": "analysis-123"
}

Example with test IDs:

{
  "testIds": ["test-1", "test-2", "test-3"]
}

Response Format

All tools return responses in the following format:

{
  "success": true,
  "data": { /* tool-specific data */ },
  "message": "Success message",
  "error": "Error message (only present if success is false)"
}

Error Handling

The server provides detailed error messages for:

  • Invalid parameters
  • GraphQL API errors
  • Network connectivity issues
  • Configuration problems

Development

Project Structure

src/
├── config.ts              # Configuration management
├── graphql/
│   └── client.ts          # GraphQL client implementation
├── tools/                 # Individual tool implementations
│   ├── wopee_start_analysis.ts
│   ├── wopee_generate_app_context.ts
│   ├── wopee_generate_user_stories.ts
│   ├── wopee_generate_tests.ts
│   └── wopee_run_tests.ts
├── types/
│   └── index.ts           # TypeScript type definitions
└── index.ts               # Main MCP server implementation

tests/
├── config.test.ts         # Configuration tests
└── tools/                 # Tool-specific tests
    ├── wopee_start_analysis.test.ts
    ├── wopee_generate_tests.test.ts
    └── wopee_run_tests.test.ts

Adding New Tools

  • Create a new tool file in src/tools/
  • Define the tool's parameters using Zod schemas in src/types/index.ts
  • Implement the tool function with proper error handling
  • Add the tool to the MCP server in src/index.ts
  • Write tests for the new tool

Code Quality

The project includes:

  • TypeScript for type safety
  • ESLint for code linting
  • Jest for testing
  • Comprehensive error handling
  • JSDoc documentation

License

MIT License

Contributing

  • Fork the repository
  • Create a feature branch
  • Make your changes
  • Add tests for new functionality
  • Ensure all tests pass
  • Submit a pull request

GitHub Automation

This repository includes comprehensive GitHub Actions workflows for:

  • CI/CD Pipeline - Automated testing and validation
  • npm Publishing - Automated package publishing
  • Release Management - Version management and releases
  • Security Scanning - Vulnerability and security checks
  • Performance Testing - Performance monitoring
  • Dependency Updates - Automated dependency management

See AUTOMATION.md for detailed information about the automation setup.

Quick Publishing

To publish a new version:

  • Automatic (recommended):

    git tag v1.0.0
    git push origin v1.0.0
    
  • Manual via GitHub Actions:

    • Go to Actions → Release Management
    • Click "Run workflow"
    • Select version bump type
    • Run workflow

Support

For issues and questions, please create an issue in the repository.

Keywords

mcp

FAQs

Package last updated on 23 Sep 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts