Mcpclientmock

🚀 mockserver - mcp

这是一个用于与 James Bloom的MockServer 进行交互的MCP（模型上下文协议）服务器。借助它，AI助手可以以编程方式创建模拟HTTP期望、验证请求、清除状态以及管理MockServer实例。

🚀 快速开始

在使用 mockserver - mcp 之前，你需要先运行一个MockServer实例。可以使用以下命令通过Docker启动：

# 使用Docker（最简单的方式）
docker run -d -p 1080:1080 mockserver/mockserver

📦 安装指南

使用npx（推荐）

npx mockserver-mcp

全局安装

npm install -g mockserver-mcp
mockserver-mcp

✨ 主要特性

• 创建模拟期望：可以在MockServer上创建模拟HTTP期望。
• 验证请求：验证MockServer是否接收到符合特定条件的请求。
• 清除状态：清除MockServer中的期望和记录的请求。
• 重置服务器：对MockServer进行完全重置，清除所有期望和记录的请求。
• 检索请求：从MockServer检索记录的请求。
• 获取状态：获取MockServer的连接状态和配置信息。

📚 详细文档

配置

环境变量

MCP客户端配置

将以下内容添加到你的MCP客户端配置文件（例如Claude Desktop、Kiro、Cursor）中：

{
  "mcpServers": {
    "mockserver": {
      "command": "npx",
      "args": ["-y", "mockserver-mcp"],
      "env": {
        "MOCKSERVER_HOST": "localhost",
        "MOCKSERVER_PORT": "1080"
      }
    }
  }
}

如果是团队共享的MockServer，将 MOCKSERVER_HOST 更改为你的服务器地址。

可用工具

mockserver_create_expectation

在MockServer上创建一个模拟HTTP期望。 参数：

• httpRequest（必需）：请求匹配标准
  • method：HTTP方法（GET、POST、PUT、DELETE等）
  • path：要匹配的URL路径
  • queryStringParameters：要匹配的查询参数
  • headers：要匹配的请求头
  • body：带有 type（STRING、JSON、REGEX、XPATH、JSON_PATH）和 value 的请求体匹配器
• httpResponse：响应配置
  • statusCode：HTTP状态码
  • headers：响应头
  • body：响应体（字符串或对象）
  • delay：带有 timeUnit 和 value 的响应延迟
• times：匹配次数（remainingTimes、unlimited）
• timeToLive：期望的生命周期（timeUnit、timeToLive）

示例：

{
  "httpRequest": {
    "method": "GET",
    "path": "/api/users"
  },
  "httpResponse": {
    "statusCode": 200,
    "body": { "users": [] }
  }
}

mockserver_verify

验证MockServer是否接收到符合特定条件的请求。 参数：

• httpRequest（必需）：请求匹配标准（与 create_expectation 相同）
• times：期望的请求数量
  • atLeast：最小请求数量
  • atMost：最大请求数量
  • exactly：精确的请求数量

示例：

{
  "httpRequest": {
    "method": "POST",
    "path": "/api/orders"
  },
  "times": {
    "atLeast": 1
  }
}

mockserver_clear

清除MockServer中的期望和记录的请求。 参数：

• httpRequest（可选）：用于清除特定期望的请求匹配器。如果未提供，则清除所有内容。

示例：

{
  "httpRequest": {
    "path": "/api/users"
  }
}

mockserver_reset

对MockServer进行完全重置，清除所有期望和记录的请求。 参数：无

mockserver_retrieve_requests

从MockServer检索记录的请求。 参数：

• httpRequest（可选）：用于过滤记录请求的请求匹配器

示例：

{
  "httpRequest": {
    "method": "GET"
  }
}

mockserver_status

获取MockServer的连接状态和配置信息。 参数：无

🔧 技术细节

为什么需要模拟？

API模拟支持早期测试，你可以在后端准备好之前就开始构建和测试前端或集成。无需再等待，加快项目交付速度。

要求

• Node.js >= 18.0.0
• 一个正在运行的MockServer实例

链接

• npm: https://www.npmjs.com/package/mockserver-mcp
• GitHub: https://github.com/Akkshay10/MCPClientMock
• MCP注册表: https://registry.modelcontextprotocol.io

📄 许可证

本项目采用MIT许可证。