Mockoon MCP服务

Mockoon MCP是一个允许AI助手通过自然语言创建和管理Mockoon模拟API的服务。

  • by Albenzoo
  • TypeScript
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 Albenzoo/Mockoon-mcp

使用说明

mockoon mcp

允许AI助手(Claude、GitHub Copilot、Cursor等)创建和管理的MCP服务器 嘲讽 通过自然语言模拟API。


需求

  • Node.js 18+
  • 模拟桌面 --用于通过UI管理环境文件
  • Mockoon命令行界面 (可选) --仅当您想使用时才需要 start_server / stop_server 以编程方式启动模拟服务器的工具(npm install -g @mockoon/cli)

配置

无需安装。使用配置您的AI客户端 npx:

VS代码/GitHub副本

创建 .vscode/mcp.json 在您的工作空间中:

{
  "servers": {
    "mockoon": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "mockoon-mcp@latest"]
    }
  }
}

克劳德桌面版

编辑 ~/Library/Application Support/Claude/claude_desktop_config.json (macOS)或 %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "mockoon": {
      "command": "npx",
      "args": ["-y", "mockoon-mcp@latest"]
    }
  }
}

光标

编辑 ~/.cursor/mcp.json (全球)或 .cursor/mcp.json 在您的项目中:

{
  "mcpServers": {
    "mockoon": {
      "command": "npx",
      "args": ["-y", "mockoon-mcp@latest"]
    }
  }
}

环境变量

变量 描述
MOCKOON_STORAGE_DIR 覆盖主存储目录(默认:Mockoon Desktop的存储文件夹)
MOCKOON_DATA_DIRS 以分号分隔的用于搜索环境文件的附加目录列表

默认存储路径:

  • 视窗: %APPDATA%\mockoon\storage
  • macOS/Linux: ~/.config/mockoon/storage

例子:

"env": {
  "MOCKOON_DATA_DIRS": "/path/to/dir1;/path/to/dir2"
}

可用工具

环境

工具 说明
list_environments 列出所有具有文件路径和端口的环境
create_environment 创建新环境
delete_environment 永久删除环境文件

路线

工具 说明
list_routes 列出环境中的所有路由(UUID、方法、端点、响应计数)
get_route 检查包含所有响应、规则、标头和正文的单个路由
create_route 使用单个默认响应创建路由
create_route_with_responses 在一次调用中创建路由+N个响应(默认+条件)
bulk_create_routes 在一个调用中创建N个路由-非常适合构建整个API
update_route 更新方法、端点、文档和/或默认响应字段
duplicate_route 使用新的UUID克隆路由(包括所有响应)
delete_route 删除路线及其所有响应
add_route_response 向现有路由添加条件/备选响应
set_default_response 更改标记为默认的响应
get_default_response 返回当前默认响应(快速检查)

数据桶(模板)

工具 说明
list_templates 列出环境中的所有数据库
create_template 创建新的数据库
update_template 更新数据库的内容
delete_template 删除数据包

服务器

工具 说明
start_server 为环境启动模拟服务器
stop_server 停止正在运行的模拟服务器
list_running_servers 列出当前运行的所有模拟服务器

注: start_server 和 stop_server 需要 Mockoon命令行界面 全球安装(npm install -g @mockoon/cli).如果只使用Mockoon Desktop,这些工具将无法工作,但所有其他工具(环境、路由、数据库)都可以在没有CLI的情况下工作。


示例提示

以下是一些示例短语,您可以对您的AI助手说,以便通过此MCP服务器与Mockoon进行交互:

探索环境和路线

  • “列出所有可用的Mockoon环境。”
  • “给我看看Taccuino环境中的所有路线。”
  • “获取路线的全部细节 GET /users/:id,包括所有响应和规则。"

创建管线

  • “创建一个 GET /products Demo API环境中的路由,返回状态为200的3个产品的JSON数组。”
  • “添加一个 POST /auth/login 路由有两个响应:200个带有令牌体,401个未经授权。"
  • “为 Task 资源下 /tasks 在演示环境中。"

更新和管理路线

  • “更改默认响应 GET /users 以空体返回状态204。"
  • “复制 GET /orders 路线。"
  • “删除 DELETE /legacy/endpoint 从环境出发的路线。"
  • “添加条件403响应 POST /documents 当 X-Role header等于 guest."

数据桶

  • “创建一个名为 UserList 在演示API中使用5个伪造用户的JSON数组。"
  • “更新 ProductCatalog 带有新项目列表的数据库。"

服务器管理

  • “启动Taccuino环境的模拟服务器。”
  • “停止所有正在运行的模拟服务器。”
  • “当前正在运行哪些Mockoon环境?”

运作原理

服务器通过以下方式进行通信 标准 (JSON-RPC 2.0)。它直接读写Mockoon的环境JSON文件,不涉及REST API。

如果满足以下条件,MCP服务器所做的更改会自动反映在模拟桌面中 环境文件监视器 已启用。首选 应用→ 设置 并将其设置为 自动 用于静音重新加载。


许可证

麻省理工学院——见 许可证.