使用说明
NestJS MCP API搜索器
通过MCP协议从实时NestJS应用程序中搜索API端点,并提供可选的实时通知。
快速开始
# 1. Install dependencies
npm install
# 2. Start API server
npm run start:dev
# 3. Choose MCP server mode:
# Basic MCP server
npm run mcp:server
# OR with polling notifications
npm run mcp:notifications
# OR with real-time WebSocket notifications
npm run mcp:realtime
光标设置
更新您的 ~/.cursor/mcp.json:
{
"mcpServers": {
"api-searcher": {
"url": "http://localhost:5000/mcp"
}
}
}
重新启动Cursor以加载MCP服务器。
服务器选项
基本MCP服务器(mcp:server)
- 🔍 搜索API端点 按查询
- 📊 健康监测
- 简单轻便
通知服务器(mcp:notifications)
- 🔍 搜索API端点 按查询
- 📋 获取API更改 自时间戳以来
- 🔔 基于轮询的通知 (间隔30秒)
- 📊 加强健康监测
实时WebSocket服务器(mcp:realtime)
- 🔍 搜索API端点 按查询
- 📋 获取API更改 自时间戳以来
- ⚡ 实时WebSocket通知 (即时警报)
- 🔗 WebSocket客户端连接 (ws://localhost:5001)
- 📊 高级监控 具有客户跟踪功能
MCP工具
基本服务器:
search_api-按查询搜索端点
通知服务器:
search_api-按查询搜索端点get_api_changes-获取API最新更改
实时WebSocket服务器:
search_api-按查询搜索端点get_api_changes-获取API最新更改subscribe_realtime-获取WebSocket连接信息
端点
- 健康:
http://localhost:5000/health - MCP:
http://localhost:5000/mcp - 通知:
http://localhost:5000/notifications(仅限通知服务器)
配置
设置环境变量:
API_BASE_URL=http://localhost:3000 # Your API server
POLL_INTERVAL=30000 # Check for changes every 30s (notifications server)
ENABLE_NOTIFICATIONS=true # Enable/disable notifications
实时WebSocket测试
# Terminal 1: Start real-time server
npm run mcp:realtime
# Terminal 2: Connect WebSocket test client
npm run test:websocket
# Terminal 3: Make API changes and see instant notifications!
分布
与团队成员共享这些文件:
mcp-http-server.js(基本服务器)mcp-realtime-notifications.js(投票通知)mcp-websocket-realtime.js(实时WebSocket)websocket-test-client.js(测试客户端)package.jsonREADME.md
团队成员运行上述相同的设置命令。