none.api-OpenAPI Explorer MCP服务器
用于模型上下文协议(MCP)的专业OpenAPI浏览器,针对 前端开发 和 后端合同验证.
这是什么?
该MCP服务器允许像Claude或Cursor这样的大型语言模型(LLM)动态地探索、理解任何具有OpenAPI/Swagger规范的API,并与之交互。
它专门用于:
- 加快前端开发:直接从API定义生成类型、Zod模式、模拟数据和数据获取挂钩(Axios/TanStack Query)。
- 验证后端实现:根据OpenAPI契约验证后端响应对象,以确保实现符合规范。
安装
使用npx(推荐)
您可以直接运行服务器,无需安装:
npx @nonetss/none.api全球安装
npm install -g @nonetss/none.api主要特点
- 智能探索:分类端点列表和基于关键字的搜索(支持多语言同义词)。
- 前端工厂:
- 生成 TypeScript接口 用于请求和响应。 - 生成 Zod模式 用于表单验证。 - 生成 React/Axios/TanStack查询 片段。 - 生成 模拟数据 用于UI原型设计。
- 后端保护:
- 响应验证:使用以下命令将JSON数据与OpenAPI模式进行比较 AJV. - 依赖关系映射:了解资源之间的关系(例如,哪个端点提供了另一个端点所需的ID)。
- 安全:自动身份验证支持(承载器/API密钥)和安全的环境锁定配置。
工具概述
| 工具 | 焦点 | 描述 |
|---|---|---|
list_endpoints | 探索 | 列出按功能类别分组的所有端点。 |
list_tags | 探索 | 列出API中的所有标记(功能类别)。 |
search_by_tag | 探索 | 列出与特定标记关联的所有端点。 |
find_endpoint | 探索 | 按意图或关键字进行智能搜索(例如,“删除用户”)。 |
get_endpoint_info | 分析 | 详细的文档、参数和响应代码。 |
get_request_schema | Analysis | 返回端点请求体的JSON模式。 |
get_response_schema | 分析 | 返回特定响应状态代码的JSON模式。 |
get_typescript_types | 前端 | 生成即用型TypeScript接口。 |
get_zod_schema | 前端 | 生成Zod验证模式。 |
get_framework_snippet | 前端 | 生成Axios或TanStack查询代码。 |
get_fetch_snippet | 前端 | 生成一个本地获取代码段以实现快速集成。 |
get_mock_data | 原型 | 基于模式生成高保真模拟数据。 |
map_dependencies | 架构 | 分析路由之间的数据流和ID关系。 |
get_security_info | 安全 | 显示API或特定路由的安全要求。 |
set_security_context | 安全 | 为后续请求设置身份验证标头。 |
call_endpoint | 调试 | 对已配置的API执行真正的HTTP调用。 |
validate_response | Backend | 根据API协定验证JSON对象。 |
配置
将此添加到您的 claude_desktop_config.json 或光标MCP设置:
{
"mcpServers": {
"none.api": {
"command": "npx",
"args": ["-y", "@nonetss/none.api"],
"env": {
"OPENAPI_URL": "http://localhost:3000/doc",
"AUTH_EMAIL": "admin@example.com",
"AUTH_PASSWORD": "your-password",
"AUTH_PATH": "/api/auth/login"
}
}
}
}开发工作流程
- 构建:
npm run build(使用tsc+tsc-alias用于路径分辨率)。 - 格式化:包括Prettier。
- Git挂钩:通过提交时自动格式化
husky和lint-staged.
