API Tester

API Tester MCP Server

A comprehensive Model Context Protocol (MCP) server for QA/SDET engineers that provides API testing capabilities with Swagger/OpenAPI and Postman collection support.

🎉 Now available on NPM! Install with npx @kirti676/api-tester-mcp@latest

🆕 What's New

• ✅ Enhanced Progress Tracking - Real-time progress with completion percentages and ETA
• ✅ Visual Progress Bars - ASCII progress bars with milestone notifications
• ✅ Performance Metrics - Throughput calculations and execution summaries
• ✅ Published on NPM - Install instantly with NPX
• ✅ VS Code Integration - One-click installation buttons
• ✅ Simplified Setup - No manual Python installation required
• ✅ Cross-Platform - Works on Windows, macOS, and Linux
• ✅ Auto-Updates - Always get the latest version with @latest

🚀 Getting Started

📦 Installation

The API Tester MCP server can be used directly with npx without any installation:

npx @kirti676/api-tester-mcp@latest

⚡ Quick Install:

🤖 Claude Desktop

Follow the MCP install guide, use the standard config below:

{
  "mcpServers": {
    "api-tester": {
      "command": "npx",
      "args": ["@kirti676/api-tester-mcp@latest"]
    }
  }
}

🔗 Other MCP Clients

The standard configuration works with most MCP clients:

{
  "mcpServers": {
    "api-tester": {
      "command": "npx",
      "args": ["@kirti676/api-tester-mcp@latest"]
    }
  }
}

🖥️ Supported Clients:

• 🤖 Claude Desktop
• 💻 VS Code with MCP extension
• ⚡ Cursor
• 🌊 Windsurf
• 🪿 Goose
• 🔧 Any other MCP-compatible client

🐍 Python Installation (Alternative)

pip install api-tester-mcp

💻 From Source

git clone https://github.com/kirti676/api_tester_mcp.git
cd api_tester_mcp
npm install

⚡ Quick Start

Try the API Tester MCP server immediately:

# Run the server
npx @kirti676/api-tester-mcp@latest

# Check version
npx @kirti676/api-tester-mcp@latest --version

# Get help
npx @kirti676/api-tester-mcp@latest --help

For MCP clients like Claude Desktop, use this configuration:

{
  "mcpServers": {
    "api-tester": {
      "command": "npx",
      "args": ["@kirti676/api-tester-mcp@latest"]
    }
  }
}

✨ Features

• 📥 Input Support: OpenAPI/Swagger documents, Postman collections, and GraphQL schemas
• 🔄 Test Generation: Automatic API and Load test scenario generation
• 🌐 Multi-Language Support: Generate tests in TypeScript/Playwright, JavaScript/Jest, Python/pytest, and more
• ⚡ Test Execution: Run generated tests with detailed reporting
• 🔐 Smart Auth Detection: Automatic environment variable analysis and setup guidance
• 🔐 Authentication: Bearer token and API key support via set_env_vars
• 📊 HTML Reports: Beautiful, accessible reports via MCP resources
• 📈 Real-time Progress: Live updates with progress bars and completion percentages
• ⏱️ ETA Calculations: Estimated time to completion for all operations
• 🎯 Milestone Tracking: Special notifications at key progress milestones (25%, 50%, 75%, etc.)
• 📊 Performance Metrics: Throughput calculations and execution summaries
• ✅ Schema Validation: Request body generation from schema examples
• 🎯 Assertions: Per-endpoint status code assertions (2xx, 4xx, 5xx)
• 📦 Project Generation: Complete project scaffolding with dependencies and configuration

🌐 Multi-Language Test Generation

The API Tester MCP now supports generating test code in multiple programming languages and testing frameworks:

🔧 Supported Language/Framework Combinations

Language	Framework	Description	Use Case
📘 TypeScript	🎭 Playwright	Modern E2E testing with excellent API support	🏢 Enterprise web applications
📘 TypeScript	🚀 Supertest	Express.js focused API testing	🟢 Node.js backend services
📙 JavaScript	🃏 Jest	Popular testing framework with good ecosystem	🔧 General API testing
📙 JavaScript	🌲 Cypress	E2E testing with great developer experience	🌐 Full-stack applications
🐍 Python	🧪 pytest	Comprehensive testing with fixtures & plugins	📊 Data-heavy APIs & ML services
🐍 Python	📡 requests	Simple HTTP testing for quick validation	⚡ Rapid prototyping & scripts

🎯 Language Selection Workflow

// 1. Get available languages and frameworks
const languages = await mcp.call("get_supported_languages");

// 2. Choose your preferred combination
await mcp.call("ingest_spec", {
  spec_type: "openapi",
  file_path: "./path/to/your/api-spec.json",
  preferred_language: "typescript",    // python, typescript, javascript
  preferred_framework: "playwright"     // varies by language
});

// 3. Generate test cases with code
await mcp.call("generate_test_cases", {
  language: "typescript",
  framework: "playwright"
});

// 4. Get complete project setup
await mcp.call("generate_project_files", {
  language: "typescript",
  framework: "playwright",
  project_name: "my-api-tests",
  include_examples: true
});

📁 Generated Project Structure

The generate_project_files tool creates a complete, ready-to-run project:

📘 TypeScript + Playwright:

my-api-tests/
├── 📦 package.json          # Dependencies & scripts
├── ⚙️ playwright.config.ts  # Playwright configuration
├── 📂 tests/
│   └── 🧪 api.spec.ts      # Generated test code
└── 📖 README.md            # Setup instructions

🐍 Python + pytest:

my-api-tests/
├── 📋 requirements.txt     # Python dependencies
├── ⚙️ pytest.ini         # pytest configuration
├── 📂 tests/
│   └── 🧪 test_api.py    # Generated test code
└── 📖 README.md          # Setup instructions

📙 JavaScript + Jest:

my-api-tests/
├── 📦 package.json       # Dependencies & scripts
├── ⚙️ jest.config.js     # Jest configuration
├── 📂 tests/
│   └── 🧪 api.test.js   # Generated test code
└── 📖 README.md         # Setup instructions

🎯 Framework-Specific Features

• 🎭 Playwright: Browser automation, parallel execution, detailed reporting
• 🃏 Jest: Snapshot testing, mocking, watch mode for development
• 🧪 pytest: Fixtures, parametrized tests, extensive plugin ecosystem
• 🌲 Cypress: Interactive debugging, time-travel debugging, real browser testing
• 🚀 Supertest: Express.js integration, middleware testing
• 📡 requests: Simple API calls, session management, authentication helpers

📈 Progress Tracking

The API Tester MCP includes comprehensive progress tracking for all operations:

📊 Visual Progress Indicators

🎯 API Test Execution: [██████████░░░░░░░░░░] 50.0% (5/10) | ETA: 2.5s - GET /api/users ✅

🔥 Features:

• 📊 Progress Bars: ASCII progress bars with filled/empty indicators
• 📈 Completion Percentages: Real-time percentage completion
• ⏰ ETA Calculations: Estimated time to completion based on current performance
• 🎯 Milestone Notifications: Special highlighting at key progress points
• ⚡ Performance Metrics: Throughput and timing statistics
• 📋 Operation Context: Detailed information about current step being executed

✅ Available for:

• 🎬 Scenario generation
• 🧪 Test case generation
• 🚀 API test execution
• ⚡ Load test execution
• 🔄 All long-running operations

🛠️ MCP Tools

The server provides 11 comprehensive MCP tools with detailed parameter specifications:

1. 📥 ingest_spec - Load API Specifications

Load OpenAPI/Swagger, Postman collections, or GraphQL schemas with language/framework preferences

{
  "spec_type": "openapi",           // openapi, swagger, postman, graphql (optional, auto-detected)
  "file_path": "./api-spec.json",   // Path to JSON, YAML, or GraphQL schema file (required)
  "preferred_language": "python",   // python, typescript, javascript (optional, default: python)
  "preferred_framework": "requests" // pytest, requests, playwright, jest, cypress, supertest (optional, default: requests)
}

2. 🔧 set_env_vars - Configure Authentication & Environment

Set environment variables with automatic validation and guidance

{
  "variables": {},                  // Dictionary of custom environment variables (optional)
  "baseUrl": null,                 // API base URL (optional)
  "auth_bearer": null,             // Bearer/JWT token (optional)
  "auth_apikey": null,             // API key (optional)
  "auth_basic

---

*README truncated. [View full README on GitHub](https://github.com/kirti676/api_tester_mcp).*