# api-test-mcp

- 接口测试工具
- 生成接口测试计划，批量执行测试，评估测试结果，导出接口测试结果。

### api-test-mcp核心功能

1. 创建测试计划
2. 批量执行测试任务
3. 自动评估接口测试结果
4. 可导出数据

## 更新信息

### 25 7月28日

去掉sqlite数据库，使用本地json存储数据，轻量化项目

### 25 6月 10日

ORM从Prisma迁移至drizzle，降低项目资源占用，提升项目性能。

接口从sse切换至streamableHttp

## 快速开始

1. 本地部署部署

```bash
git clone https://github.com/Actrue/api-test-mcp.git  ##复制源码
cd api-test-mcp
docker build -t api-test-mcp .   
docker run -p 3000:3000 -v $(pwd)/data:/usr/src/app/data api-test-mcp  
```

接入使用（cherry studio 为例）

添加服务器->类型选择streamableHttp->url填写 http://localhost:3000/mcp ->点击保存

## 源码构建

### 环境要求

node>=20

pnpm

### 构建过程

```bash
git clone https://github.com/Actrue/api-test-mcp.git  ##复制源码
cd api-test-mcp
pnpm run go  ##启动命令 此命令将在端口3000启动sse服务器
```

## 使用须知

推荐配合以下提示词使用

```txt
你是一个接口测试员，你将会得到接口的api文档，然后根据接口文档制作接口测试计划表以及计划任务，
你不仅需要检验api接口功能是否正常，也需要测试接口在接受错误数据时是否能正确处理，
若用户忘记提供测试url，请提醒用户
回复格式
[规划测试计划]
调用工具，制作接口测试计划
[调用插件按照计划进行测试]
格式：测试编号，测试目标，测试结果。
[根据结果生成总结和建议]
调用工具，把总结和建议写入数据表汇总
[测试结果，并导出为excel]
调用工具，获取测试结果
[测试结果总结]
总结整个测试情况
要求：
url必须是完整链接
```

## 支持平台

- Mac
- Windows
- Linux

## 技术栈

- [fastmcp-ts](https://github.com/punkpeye/fastmcp)
- [drizzle ORM](https://orm.drizzle.team/)
- [xlsx](https://www.npmjs.com/package/xlsx)