Readyapi MCP Server

ReadyAPI MCP服务器

一个模型上下文协议（MCP）服务器，为ReadyAPI/SoapUI测试提供智能自动化功能。该服务器使人工智能助手能够帮助用户实现API测试自动化、SOAP/REST服务测试和全面的测试管理。

特性

🔧 核心能力

• ReadyAPI项目分析：全面的项目结构分析和见解
• 测试套件执行：具有实时监控功能的自动化测试执行
• SOAP服务管理：WSDL导入、请求创建和响应验证
• REST API测试：端点验证、Swagger导入和身份验证测试
• 断言管理：智能断言创建和响应验证
• 测试数据管理：数据源配置和测试数据生成

📊 分析和报告

• 项目概况和健康评估
• 测试覆盖率分析
• 端点健康监测
• 绩效指标跟踪
• 断言验证报告

🛠️ 测试自动化

• SOAP和REST服务测试
• 数据驱动的测试执行
• 身份验证和安全测试
• 性能和负载测试设置
• 错误处理和验证

安装

先决条件

• Node.js 18+
• 已安装ReadyAPI或SoapUI
• TypeScript开发环境

设置

1. 克隆存储库：

   git clone 
   cd ReadyAPI_MCP_Server

1. 安装依赖项：

   npm install

1. 构建项目：

   npm run build

1. 运行开发服务器：

   npm run dev

Claude桌面配置

要将此MCP服务器与Claude Desktop一起使用，您需要将其添加到您的Claude Desktop配置中。

Windows配置

1. 找到Claude Desktop配置文件:

   %APPDATA%\Claude\claude_desktop_config.json

1. 添加ReadyAPI MCP服务器配置:

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

macOS配置

1. 找到Claude Desktop配置文件:

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

1. 添加ReadyAPI MCP服务器配置:

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

Linux配置

1. 找到Claude Desktop配置文件:

   ~/.config/Claude/claude_desktop_config.json

1. 添加ReadyAPI MCP服务器配置:

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

配置说明

• 替换路径：更新中的路径 args 以匹配您的实际安装目录
• 先建造：确保你已经跑过了 npm run build 在配置Claude Desktop之前
• 重新启动克劳德：更新配置后重新启动Claude Desktop
• 多个服务器：您可以将多个MCP服务器添加到同一配置文件中

验证

配置后，您应该在Claude Desktop中看到ReadyAPI MCP服务器工具：

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

故障排除

如果服务器未出现在Claude Desktop中：

1. 检查路径：验证到的绝对路径 build/index.js 是正确的
2. 检查权限：确保Claude Desktop有权执行Node.js脚本
3. 检查日志：查看Claude Desktop的日志以了解任何错误消息
4. 手动测试：手动运行服务器以确保其无错误启动：

   node build/index.js

1. 重新启动克劳德：完全关闭并重新启动Claude Desktop

MCP工具可用

1.ReadyAPI项目分析

{
  "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.测试套件执行

{
  "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服务管理

{
  "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服务管理

{
  "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.断言管理

{
  "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.测试数据管理

{
  "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"
  }
}

使用示例

与Claude Desktop一起使用

配置后，您可以使用自然语言通过Claude Desktop与ReadyAPI项目进行交互：

项目分析

"Please analyze my ReadyAPI project at C:/Projects/MyAPI/MyAPI-readyapi-project.xml and give me an overview of the test coverage."

测试执行

"Run the UserManagement test suite from my ReadyAPI project in headless mode against the staging environment."

SOAP服务管理

"Import the WSDL from https://api.example.com/service?wsdl into my ReadyAPI project and create sample requests for all operations."

REST API测试

"Create a REST request for the GET /users endpoint at https://api.example.com/users and validate the response structure."

断言管理

"Add JSONPath assertions to validate that the user status is 'active' and the response time is under 2 seconds."

测试数据管理

"Import test data from my Excel file at C:/TestData/users.xlsx and create a data source for parameterized testing."

程序示例

分析ReadyAPI项目

// 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"
});

执行测试套件

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

导入WSDL服务

// 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"
});

创建REST请求

// 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"
});

发展

项目结构

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

脚本

• npm run build -将TypeScript构建为JavaScript
• npm run dev -构建并运行开发服务器
• npm start -运行生产服务器
• npm test -运行测试（待实施）

与AI助手集成

此MCP服务器旨在与Claude等AI助手配合使用，使他们能够：

1. 了解ReadyAPI项目：分析项目结构、测试套件和服务定义
2. 执行测试自动化：运行测试、监控结果并提供反馈
3. 调试API问题：验证响应、检查断言并识别问题
4. 生成测试用例：创建全面的测试场景和数据集
5. 优化性能：分析响应时间并提出改进建议

贡献

1. 分叉存储库
2. 创建要素分支
3. 进行更改
4. 添加新功能的测试
5. 提交拉取请求

许可证

MIT许可证-有关详细信息，请参阅许可证文件

支持

对于问题和疑问：

• 在GitHub存储库中创建问题
• 检查USAGE_EXAMPLES.md文件中的文档
• 查看.vcode/copylot-instructions.md以获取开发指导

______________________________________________________________________

备注：这是ReadyAPI MCP服务器的基础实现。与ReadyAPI的XML项目格式和testrunner可执行文件的完全集成将在后续迭代中实现。