Skip to main content
Glama
kirti676

API Tester MCP

by kirti676
README.md
# API Tester MCP Server

[![npm (scoped)](https://img.shields.io/npm/v/@kirti676/api-tester-mcp.svg)](https://img.shields.io/npm/v/@kirti676/api-tester-mcp.svg)
[![npm downloads](https://img.shields.io/npm/dt/@kirti676/api-tester-mcp.svg)](https://www.npmjs.com/package/@kirti676/api-tester-mcp)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

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:

```bash
npx @kirti676/api-tester-mcp@latest
```

**โšก Quick Install:**

[![Install in VS Code](https://img.shields.io/badge/Install%20in-VS%20Code-blue?style=for-the-badge&logo=visual-studio-code)](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22api-tester%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22%40kirti676%2Fapi-tester-mcp%40latest%22%5D%7D)
[![Install in VS Code Insiders](https://img.shields.io/badge/Install%20in-VS%20Code%20Insiders-blue?style=for-the-badge&logo=visual-studio-code)](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%7B%22name%22%3A%22API-tester%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22%40kirti676%2Fapi-tester-mcp%40latest%22%5D%7D)

### ๐Ÿค– Claude Desktop

Follow the MCP install [guide](https://modelcontextprotocol.io/quickstart/user), use the standard config below:

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

### ๐Ÿ”— Other MCP Clients

The standard configuration works with most MCP clients:

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

**๐Ÿ–ฅ๏ธ Supported Clients:**
- ๐Ÿค– [Claude Desktop](https://claude.ai/desktop)
- ๐Ÿ’ป [VS Code](https://code.visualstudio.com/) with MCP extension
- โšก [Cursor](https://cursor.sh/)
- ๐ŸŒŠ [Windsurf](https://codeium.com/windsurf)
- ๐Ÿชฟ [Goose](https://github.com/Codium-ai/goose)
- ๐Ÿ”ง Any other MCP-compatible client

### ๐Ÿ Python Installation (Alternative)

```bash
pip install api-tester-mcp
```

### ๐Ÿ’ป From Source

```bash
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:

```bash
# 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:

```json
{
  "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

```javascript
// 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
```javascript
{
  "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
```javascript
{
  "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": null,              // Base64 encoded credentials (optional)
  "auth_username": null,           // Username for basic auth (optional)
  "auth_password": null            // Password for basic auth (optional)
}
```

### 3. ๐ŸŽฌ **`generate_scenarios`** - Create Test Scenarios
Generate test scenarios from ingested specifications
```javascript
{
  "include_negative_tests": true,   // Generate failure scenarios (default: true)
  "include_edge_cases": true        // Generate boundary conditions (default: true)
}
```

### 4. ๐Ÿงช **`generate_test_cases`** - Convert to Executable Tests
Convert scenarios to executable test cases in preferred language/framework
```javascript
{
  "scenario_ids": null              // Array of scenario IDs or null for all (optional)
}
```

### 5. ๐Ÿš€ **`run_api_tests`** - Execute API Tests
Execute API tests with detailed results and reporting
```javascript
{
  "test_case_ids": null,           // Array of test case IDs or null for all (optional)
  "max_concurrent": 10             // Number of concurrent requests 1-50 (default: 10)
}
```

### 6. โšก **`run_load_tests`** - Execute Performance Tests
Execute load/performance tests with configurable parameters
```javascript
{
  "test_case_ids": null,           // Array of test case IDs or null for all (optional)
  "duration": 60,                  // Test duration in seconds (default: 60)
  "users": 10,                     // Number of concurrent virtual users (default: 10)
  "ramp_up": 10                    // Ramp up time in seconds (default: 10)
}
```

### 7. ๐ŸŒ **`get_supported_languages`** - List Language/Framework Options
Get list of supported programming languages and testing frameworks
```javascript
// No parameters required
{}
```

### 8. ๐Ÿ“ฆ **`generate_project_files`** - Generate Complete Projects
Generate complete project structure with dependencies and configuration
```javascript
{
  "project_name": null,            // Project folder name (optional, auto-generated if null)
  "include_examples": true         // Include example test files (default: true)
}
```

### 9. ๐Ÿ“ **`get_workspace_info`** - Workspace Information
Get information about workspace directory and file generation locations
```javascript
// No parameters required
{}
```

### 10. ๐Ÿ” **`debug_file_system`** - File System Diagnostics
Get comprehensive workspace information and file system diagnostics
```javascript
// No parameters required
{}
```

### 11. ๐Ÿ“Š **`get_session_status`** - Session Status & Progress
Retrieve current session information with progress details
```javascript
// No parameters required
{}
```

## ๐Ÿ“š MCP Resources

- **`file://reports`** - List all available test reports
- **`file://reports/{report_id}`** - Access individual HTML test reports

## ๐Ÿ’ก MCP Prompts

- **`create_api_test_plan`** - Generate comprehensive API test plans
- **`analyze_test_failures`** - Analyze test failures and provide recommendations

## ๐Ÿ” Smart Environment Variable Analysis

The API Tester MCP now automatically analyzes your API specifications to detect required environment variables and provides helpful setup guidance:

### ๐ŸŽฏ Automatic Detection
- **๐Ÿ” Authentication Schemes**: Bearer tokens, API keys, Basic auth, OAuth2
- **๐ŸŒ Base URLs**: Extracted from specification servers/hosts
- **๐Ÿ”— Template Variables**: Postman collection variables like `{{baseUrl}}`, `{{authToken}}`
- **๐Ÿ“ Path Parameters**: Dynamic values in paths like `/users/{userId}`

### ๐Ÿ’ก Smart Suggestions
```javascript
// 1. Ingest specification - automatic analysis included
const result = await mcp.call("ingest_spec", {
  spec_type: "openapi",
  file_path: "./api-specification.json"
});

// Check the setup message for immediate guidance
console.log(result.setup_message);
// "โš ๏ธ 2 required environment variable(s) detected..."

// 2. Get detailed setup instructions
const suggestions = await mcp.call("get_env_var_suggestions");
console.log(suggestions.setup_instructions);
// Provides copy-paste ready configuration examples
```

## ๐ŸŽฏ Default Parameter Keys

All MCP tools now provide helpful default parameter keys to guide users on what values they can set:

### ๐Ÿ”ง Environment Variables (`set_env_vars`)
**๐Ÿ”‘ ALL PARAMETERS ARE OPTIONAL** - Provide only what you need:
```javascript
// Option 1: Just the base URL
await mcp.call("set_env_vars", {
  baseUrl: "https://api.example.com/v1"
});

// Option 2: Just authentication
await mcp.call("set_env_vars", {
  auth_bearer: "your-jwt-token-here"
});

// Option 3: Multiple parameters
await mcp.call("set_env_vars", {
  baseUrl: "https://api.example.com/v1",
  auth_bearer: "your-jwt-token",
  auth_apikey: "your-api-key"
});

// Option 4: Using variables dict for custom values
await mcp.call("set_env_vars", {
  variables: {
    "baseUrl": "https://api.example.com/v1",
    "custom_header": "custom-value"
  }
});
```

### ๐ŸŒ Language & Framework Selection
Default values help you understand available options:
```javascript
// Ingest with defaults shown
await mcp.call("ingest_spec", {
  spec_type: "openapi",        // openapi, swagger, postman
  file_path: "./api-spec.json", // Path to JSON or YAML specification file
  preferred_language: "python", // python, typescript, javascript
  preferred_framework: "requests" // pytest, requests, playwright, jest, cypress, supertest
});

// Project generation with defaults
await mcp.call("generate_project_files", {
  language: "python",          // python, typescript, javascript
  framework: "requests",       // Framework matching the language
  project_name: "api-tests",   // Project folder name
  include_examples: true       // Include example test files
});
```

### โšก Test Execution Parameters
Clear defaults for performance tuning:
```javascript
// API tests with concurrency control
await mcp.call("run_api_tests", {
  test_case_ids: null,        // ["test_1", "test_2"] or null for all
  max_concurrent: 10          // Number of concurrent requests (1-50)
});

// Load tests with performance parameters  
await mcp.call("run_load_tests", {
  test_case_ids: null,        // ["test_1", "test_2"] or null for all
  duration: 60,               // Test duration in seconds
  users: 10,                  // Number of concurrent virtual users
  ramp_up: 10                 // Ramp up time in seconds
});
```

## ๐Ÿ”ง Configuration Example

```javascript
// NEW: Check supported languages and frameworks
const languages = await mcp.call("get_supported_languages");
console.log(languages.supported_combinations);

// Ingest specification with language preferences
await mcp.call("ingest_spec", {
  spec_type: "openapi",
  file_path: "./openapi-specification.json",
  preferred_language: "typescript",
  preferred_framework: "playwright"
});

// Set environment variables for authentication
await mcp.call("set_env_vars", {
  variables: {
    "baseUrl": "https://api.example.com",
    "auth_bearer": "your-bearer-token",
    "auth_apikey": "your-api-key"
  }
});

// Generate test scenarios
await mcp.call("generate_scenarios", {
  include_negative_tests: true,
  include_edge_cases: true
});

// Generate test cases in TypeScript/Playwright
await mcp.call("generate_test_cases", {
  language: "typescript",
  framework: "playwright"
});

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

// Run API tests (still works with existing execution engine)
await mcp.call("run_api_tests", {
  max_concurrent: 5
});
```

## ๐Ÿš€ Complete Workflow Example

Here's a complete example of testing the Petstore API:

```bash
# 1. Start the MCP server
npx @kirti676/api-tester-mcp@latest
```

Then in your MCP client (like Claude Desktop):

```javascript
// 1. Load the Petstore OpenAPI spec
await mcp.call("ingest_spec", {
  spec_type: "openapi",
  file_path: "./examples/petstore_openapi.json"
});

// 2. Set environment variables
await mcp.call("set_env_vars", {
  pairs: {
    "baseUrl": "https://petstore.swagger.io/v2",
    "auth_apikey": "special-key"
  }
});

// 3. Generate test cases
const tests = await mcp.call("get_generated_tests");

// 4. Run API tests
const result = await mcp.call("run_api_tests");

// 5. View results in HTML report
const reports = await mcp.call("list_resources", {
  uri: "file://reports"
});
```

## ๐Ÿ“– Usage Examples

### ๐Ÿ”„ Basic API Testing Workflow

1. **๐Ÿ“ฅ Ingest API Specification**
   ```json
   {
     "tool": "ingest_spec",
     "params": {
       "spec_type": "openapi",
       "content": "{ ... your OpenAPI spec ... }"
     }
   }
   ```

2. **๐Ÿ” Configure Authentication**
   ```json
   {
     "tool": "set_env_vars", 
     "params": {
       "variables": {
         "auth_bearer": "your-token",
         "baseUrl": "https://api.example.com"
       }
     }
   }
   ```

3. **๐Ÿš€ Generate and Run Tests**
   ```json
   {
     "tool": "generate_scenarios",
     "params": {
       "include_negative_tests": true
     }
   }
   ```

4. **๐Ÿ“Š View Results**
   - ๐Ÿ“„ Access HTML reports via MCP resources
   - ๐Ÿ“ˆ Get session status and statistics

### ๐Ÿš€ GraphQL API Testing Workflow

1. **๐Ÿ“ฅ Ingest GraphQL Schema**
   ```json
   {
     "tool": "ingest_spec",
     "params": {
       "spec_type": "graphql",
       "file_path": "./schema.graphql"
     }
   }
   ```

2. **๐Ÿ” Configure GraphQL Endpoint**
   ```json
   {
     "tool": "set_env_vars", 
     "params": {
       "graphqlEndpoint": "https://api.example.com/graphql",
       "auth_bearer": "your-jwt-token"
     }
   }
   ```

3. **๐Ÿงช Generate GraphQL Tests**
   ```json
   {
     "tool": "generate_test_cases",
     "params": {
       "preferred_language": "python",
       "preferred_framework": "pytest"
     }
   }
   ```

4. **๐Ÿ“Š Execute GraphQL Tests**
   ```json
   {
     "tool": "run_api_tests",
     "params": {
       "max_concurrent": 5
     }
   }
   ```

### โšก Load Testing

```json
{
  "tool": "run_load_tests",
  "params": {
    "users": 10,
    "duration": 60,
    "ramp_up": 10
  }
}
```

## ๐Ÿ” Test Generation Features

- **โœ… Positive Tests**: Valid requests with expected 2xx responses
- **โŒ Negative Tests**: Invalid authentication (401), wrong methods (405)
- **๐ŸŽฏ Edge Cases**: Large payloads, boundary conditions
- **๐Ÿ—๏ธ Schema-based Bodies**: Automatic request body generation from OpenAPI schemas
- **๐Ÿ” Comprehensive Assertions**: Status codes, response times, content validation

## ๐Ÿ“Š HTML Reports

Generated reports include:
- ๐Ÿ“ˆ Test execution summary with pass/fail statistics
- โฑ๏ธ Detailed test results with timing information
- ๐Ÿ” Assertion breakdowns and error details
- ๐Ÿ‘๏ธ Response previews and debugging information
- ๐Ÿ“ฑ Mobile-friendly responsive design

## ๐Ÿ”’ Authentication Support

- **๐ŸŽซ Bearer Tokens**: `auth_bearer` environment variable
- **๐Ÿ”‘ API Keys**: `auth_apikey` environment variable (sent as X-API-Key header)
- **๐Ÿ‘ค Basic Auth**: `auth_basic` environment variable

## ๐Ÿ”ง Requirements

- **๐Ÿ Python**: 3.8 or higher
- **๐ŸŸข Node.js**: 14 or higher (for npm installation)

## ๐Ÿ“ฆ Dependencies

### ๐Ÿ Python Dependencies
- ๐Ÿš€ fastmcp>=0.2.0
- ๐Ÿ“Š pydantic>=2.0.0
- ๐ŸŒ requests>=2.28.0
- โœ… jsonschema>=4.0.0
- ๐Ÿ“ pyyaml>=6.0
- ๐ŸŽจ jinja2>=3.1.0
- โšก aiohttp>=3.8.0
- ๐ŸŽญ faker>=19.0.0

### ๐ŸŸข Node.js Dependencies  
- โœจ None (self-contained package)

## ๐Ÿ”ง Troubleshooting

### โ— Common Issues

**๐Ÿ“ฆ NPX Command Not Working**
```bash
# If npx command fails, try:
npm install -g @kirti676/api-tester-mcp@latest

# Or run directly:
node ./node_modules/@kirti676/api-tester-mcp/cli.js
```

**๐Ÿ Python Not Found**
```bash
# Make sure Python 3.8+ is installed and in PATH
python --version

# Install Python dependencies manually if needed:
pip install fastmcp>=0.2.0 pydantic>=2.0.0 requests>=2.28.0
```

**๐Ÿ”— MCP Client Connection Issues**
- โœ… Ensure the MCP server is running on stdio transport (default)
- ๐Ÿ”„ Check that your MCP client supports the latest MCP protocol version
- ๐Ÿ“ Verify the configuration JSON syntax is correct

### ๐Ÿ†˜ Getting Help

1. ๐Ÿ“– Check the [Examples](examples/) directory for working configurations
2. ๐Ÿ” Run with `--verbose` flag for detailed logging
3. ๐Ÿ› Report issues on [GitHub Issues](https://github.com/kirti676/api_tester_mcp/issues)

## ๐Ÿค Contributing

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## ๐Ÿ“„ License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## ๐Ÿ› Issues & Support

- **NPM Package**: [@kirti676/api-tester-mcp](https://www.npmjs.com/package/@kirti676/api-tester-mcp)
- **Report bugs**: [GitHub Issues](https://github.com/kirti676/api_tester_mcp/issues)

## ๐Ÿ“ˆ Roadmap

- [x] **Multi-Language Test Generation** - TypeScript/Playwright, JavaScript/Jest, Python/pytest support โœจ **NEW!**
- [x] **Complete Project Generation** - Full project scaffolding with dependencies and configuration โœจ **NEW!**
- [x] **GraphQL API support** - Supports GraphQL Schemas โœจ **NEW!**
- [ ] Additional authentication methods (OAuth2, JWT)
- [ ] Go/Golang test generation (with testify/ginkgo)
- [ ] C#/.NET test generation (with NUnit/xUnit)
- [ ] Performance monitoring and alerting
- [ ] Integration with CI/CD pipelines (GitHub Actions, Jenkins)
- [ ] Advanced test data generation from examples and schemas
- [ ] API contract testing with Pact support
- [ ] Mock server generation for development

## ๐Ÿ“„ Copyright & Usage

**ยฉ 2025 kirti676. All rights reserved.**

This repository and its contents are protected by copyright law. For permission to reuse, reference, or redistribute any part of this project, please contact the owner at [kirti676@outlook.com](mailto:kirti676@outlook.com).

**โœ… Allowed without permission:**
- Personal learning and experimentation
- Contributing back to this repository via Pull Requests

**โ“ Requires permission:**
- Commercial use or integration
- Redistribution in modified form
- Publishing derived works

For licensing inquiries, collaboration opportunities, or permission requests, reach out to [kirti676@outlook.com](mailto:kirti676@outlook.com).

---

<div align="center">

[![โญ Star this repo](https://img.shields.io/github/stars/kirti676/api_tester_mcp?style=social)](https://github.com/kirti676/api_tester_mcp)
[![๐Ÿด Fork this repo](https://img.shields.io/github/forks/kirti676/api_tester_mcp?style=social)](https://github.com/kirti676/api_tester_mcp/fork)

**๐Ÿš€ Built with โค๏ธ for QA/SDET engineers worldwide ๐ŸŒ**

</div>

TDQS

B3.4/5.0

Scored across 11 tools

Disambiguation4/5

Most tools have distinct purposes, but debug_file_system and get_workspace_info both provide workspace information, which could cause minor confusion. The descriptions help differentiate them.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case (e.g., generate_scenarios, run_api_tests). No mixed conventions or ambiguous verbs.

Tool Count5/5

11 tools is appropriate for an API testing server. Each tool serves a clear purpose in the workflow without being excessive or insufficient.

Completeness4/5

The tool set covers the core API testing workflow: ingestion, setup, scenario/test generation, execution, and diagnostics. Minor gaps include inability to view generated content directly or delete resources, but these are not critical.

Maintenance

ActivityInactive
ResponsivenessNo issues