readyapi-mcp-server

PareshSoni468/readyapi-mcp-server

3.2

If you are the rightful owner of readyapi-mcp-server and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.

The ReadyAPI MCP Server is a Model Context Protocol server designed to enhance API testing automation and management using AI capabilities.

Tools
6
Resources
0
Prompts
0

ReadyAPI MCP Server

A Model Context Protocol (MCP) server that provides intelligent automation capabilities for ReadyAPI/SoapUI testing. This server enables AI assistants to help users with API testing automation, SOAP/REST service testing, and comprehensive test management.

Features

šŸ”§ Core Capabilities

  • ReadyAPI Project Analysis: Comprehensive project structure analysis and insights
  • Test Suite Execution: Automated test execution with real-time monitoring
  • SOAP Service Management: WSDL import, request creation, and response validation
  • REST API Testing: Endpoint validation, Swagger import, and authentication testing
  • Assertion Management: Smart assertion creation and response validation
  • Test Data Management: Data source configuration and test data generation

šŸ“Š Analysis & Reporting

  • Project overview and health assessment
  • Test coverage analysis
  • Endpoint health monitoring
  • Performance metrics tracking
  • Assertion validation reports

šŸ› ļø Testing Automation

  • SOAP and REST service testing
  • Data-driven test execution
  • Authentication and security testing
  • Performance and load testing setup
  • Error handling and validation

Installation

Prerequisites

  • Node.js 18+
  • ReadyAPI or SoapUI installed
  • TypeScript development environment

Setup

  1. Clone the repository:

    git clone <repository-url>
cd ReadyAPI_MCP_Server

  2. Install dependencies:

    npm install

  3. Build the project:

    npm run build

  4. Run the development server:

    npm run dev

Claude Desktop Configuration

To use this MCP server with Claude Desktop, you need to add it to your Claude Desktop configuration.

Windows Configuration

  1. Locate the Claude Desktop config file:

    %APPDATA%\Claude\claude_desktop_config.json

  2. Add the ReadyAPI MCP Server configuration:

    {
  "mcpServers": {
    "readyapi-mcp-server": {
      "command": "node",
      "args": ["C:/path/to/your/ReadyAPI_MCP_Server/build/index.js"],
      "env": {
        "NODE_ENV": "production"
      }
    }
  }
}

macOS Configuration

  1. Locate the Claude Desktop config file:

    ~/Library/Application Support/Claude/claude_desktop_config.json

  2. Add the ReadyAPI MCP Server configuration:

    {
  "mcpServers": {
    "readyapi-mcp-server": {
      "command": "node",
      "args": ["/path/to/your/ReadyAPI_MCP_Server/build/index.js"],
      "env": {
        "NODE_ENV": "production"
      }
    }
  }
}

Linux Configuration

  1. Locate the Claude Desktop config file:

    ~/.config/Claude/claude_desktop_config.json

  2. Add the ReadyAPI MCP Server configuration:

    {
  "mcpServers": {
    "readyapi-mcp-server": {
      "command": "node",
      "args": ["/path/to/your/ReadyAPI_MCP_Server/build/index.js"],
      "env": {
        "NODE_ENV": "production"
      }
    }
  }
}

Configuration Notes

  • Replace the path: Update the path in args to match your actual installation directory
  • Build first: Ensure you've run npm run build before configuring Claude Desktop
  • Restart Claude: Restart Claude Desktop after updating the configuration
  • Multiple servers: You can add multiple MCP servers to the same configuration file

Verification

After configuration, you should see the ReadyAPI MCP Server tools available in Claude Desktop:

  • readyapi_analyze_project
  • readyapi_execute_test_suite
  • readyapi_manage_soap_services
  • readyapi_manage_rest_services
  • readyapi_manage_assertions
  • readyapi_manage_test_data

Troubleshooting

If the server doesn't appear in Claude Desktop:

  1. Check the path: Verify the absolute path to build/index.js is correct
  2. Check permissions: Ensure Claude Desktop has permission to execute the Node.js script
  3. Check logs: Look at Claude Desktop's logs for any error messages
  4. Test manually: Run the server manually to ensure it starts without errors: 
    node build/index.js
  5. Restart Claude: Close and restart Claude Desktop completely

MCP Tools Available

1. ReadyAPI Project Analysis

{
  "name": "readyapi_analyze_project",
  "description": "Analyze ReadyAPI project structure and provide insights",
  "parameters": {
    "projectPath": "Path to the ReadyAPI project",
    "analysisType": "overview | test_coverage | endpoint_health | performance_metrics"
  }
}

2. Test Suite Execution

{
  "name": "readyapi_execute_test_suite",
  "description": "Execute a ReadyAPI test suite with real-time monitoring",
  "parameters": {
    "projectPath": "Full path to the ReadyAPI project folder",
    "testSuitePath": "Path to the specific test suite file",
    "environment": "Environment to run tests against",
    "testRunner": "gui | headless"
  }
}

3. SOAP Service Management

{
  "name": "readyapi_manage_soap_services",
  "description": "Manage SOAP services: import WSDL, create requests, validate responses",
  "parameters": {
    "projectPath": "Path to the ReadyAPI project",
    "action": "import_wsdl | create_request | validate_response | update_endpoint",
    "wsdlUrl": "WSDL URL for import operations",
    "serviceName": "Name of the SOAP service",
    "operationName": "SOAP operation name"
  }
}

4. REST Service Management

{
  "name": "readyapi_manage_rest_services",
  "description": "Manage REST services: create requests, validate responses, test endpoints",
  "parameters": {
    "projectPath": "Path to the ReadyAPI project",
    "action": "create_request | import_swagger | validate_endpoint | test_auth",
    "endpoint": "REST endpoint URL",
    "method": "GET | POST | PUT | DELETE | PATCH",
    "swaggerUrl": "Swagger/OpenAPI specification URL"
  }
}

5. Assertion Management

{
  "name": "readyapi_manage_assertions",
  "description": "Create and manage test assertions for API responses",
  "parameters": {
    "projectPath": "Path to the ReadyAPI project",
    "action": "create_assertion | validate_response | update_assertion | list_assertions",
    "testStepName": "Name of the test step to add assertions to",
    "assertionType": "xpath | jsonpath | response_time | status_code | schema_validation",
    "expectedValue": "Expected value for the assertion"
  }
}

6. Test Data Management

{
  "name": "readyapi_manage_test_data",
  "description": "Manage test data sources and parameterization",
  "parameters": {
    "projectPath": "Path to the ReadyAPI project",
    "action": "create_datasource | import_excel | create_database_connection | generate_test_data",
    "dataSourceType": "excel | csv | database | xml | json",
    "filePath": "Path to data file (for file-based sources)",
    "connectionString": "Database connection string"
  }
}

Usage Examples

Using with Claude Desktop

Once configured, you can use natural language to interact with ReadyAPI projects through Claude Desktop:

Project Analysis
"Please analyze my ReadyAPI project at C:/Projects/MyAPI/MyAPI-readyapi-project.xml and give me an overview of the test coverage."
Test Execution
"Run the UserManagement test suite from my ReadyAPI project in headless mode against the staging environment."
SOAP Service Management
"Import the WSDL from https://api.example.com/service?wsdl into my ReadyAPI project and create sample requests for all operations."
REST API Testing
"Create a REST request for the GET /users endpoint at https://api.example.com/users and validate the response structure."
Assertion Management
"Add JSONPath assertions to validate that the user status is 'active' and the response time is under 2 seconds."
Test Data Management
"Import test data from my Excel file at C:/TestData/users.xlsx and create a data source for parameterized testing."

Programmatic Examples

Analyze a ReadyAPI Project

// Analyze project overview
await analyzeProject({
  projectPath: "C:/Projects/MyAPI/MyAPI-readyapi-project.xml",
  analysisType: "overview"
});

// Check test coverage
await analyzeProject({
  projectPath: "C:/Projects/MyAPI/MyAPI-readyapi-project.xml",
  analysisType: "test_coverage"
});

Execute Test Suite

// Run test suite in headless mode
await executeTestSuite({
  projectPath: "C:/Projects/MyAPI/MyAPI-readyapi-project.xml",
  testSuitePath: "UserManagement-TestSuite",
  environment: "staging",
  testRunner: "headless"
});

Import WSDL Service

// Import SOAP service from WSDL
await manageSoapServices({
  projectPath: "C:/Projects/MyAPI/MyAPI-readyapi-project.xml",
  action: "import_wsdl",
  wsdlUrl: "https://api.example.com/service?wsdl"
});

Create REST Request

// Create REST API request
await manageRestServices({
  projectPath: "C:/Projects/MyAPI/MyAPI-readyapi-project.xml",
  action: "create_request",
  endpoint: "https://api.example.com/users",
  method: "GET"
});

Development

Project Structure

src/
ā”œā”€ā”€ index.ts                 # Main MCP server implementation
ā”œā”€ā”€ readyapi/
ā”‚   ā”œā”€ā”€ project-manager.ts   # Project analysis and management
ā”‚   ā”œā”€ā”€ test-executor.ts     # Test execution and monitoring
ā”‚   ā”œā”€ā”€ soap-helper.ts       # SOAP service operations
ā”‚   ā”œā”€ā”€ rest-helper.ts       # REST API operations
ā”‚   ā”œā”€ā”€ assertion-manager.ts # Assertion creation and validation
ā”‚   ā””ā”€ā”€ data-manager.ts      # Test data management
ā””ā”€ā”€ .vscode/
    ā””ā”€ā”€ copilot-instructions.md # AI development guidelines

Scripts

  • npm run build - Build TypeScript to JavaScript
  • npm run dev - Build and run the development server
  • npm start - Run the production server
  • npm test - Run tests (to be implemented)

Integration with AI Assistants

This MCP server is designed to work with AI assistants like Claude, providing them with the ability to:

  1. Understand ReadyAPI Projects: Analyze project structure, test suites, and service definitions
  2. Execute Test Automation: Run tests, monitor results, and provide feedback
  3. Debug API Issues: Validate responses, check assertions, and identify problems
  4. Generate Test Cases: Create comprehensive test scenarios and data sets
  5. Optimize Performance: Analyze response times and suggest improvements

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests for new functionality
  5. Submit a pull request

License

MIT License - see LICENSE file for details

Support

For issues and questions:

  • Create an issue in the GitHub repository
  • Check the documentation in the USAGE_EXAMPLES.md file
  • Review the .vscode/copilot-instructions.md for development guidance

Note: This is a foundational implementation of the ReadyAPI MCP Server. Full integration with ReadyAPI's XML project format and testrunner executable will be implemented in subsequent iterations.