8039b47795
- Fix remaining "Next.js 14" references in: - docs/architecture/IMPLEMENTATION_QUICK_REFERENCE.md - docs/load-testing/K6_LOAD_TESTING_GUIDE.md - Create README.md for libs/ai-services/ (FastAPI AVM, moderation, NLP) - Create README.md for libs/mcp-servers/ (MCP tool server library) - Note: CLAUDE.md, README.md, and docs/architecture.md were already updated in a prior pass Co-Authored-By: Paperclip <noreply@paperclip.ing>
55 lines
1.6 KiB
Markdown
55 lines
1.6 KiB
Markdown
# @goodgo/mcp-servers
|
|
|
|
MCP (Model Context Protocol) tool server library for the GoodGo Platform. Provides structured tools that AI assistants can use to query property data, run analytics, and perform valuations.
|
|
|
|
## Tool Servers
|
|
|
|
| Server | Path | Description |
|
|
|--------|------|-------------|
|
|
| **Property Search** | `property-search/` | Geo search, full-text search, filter by type/price/area |
|
|
| **Market Analytics** | `market-analytics/` | Price trends, heatmaps, district comparisons |
|
|
| **Valuation** | `valuation/` | AVM property valuation requests |
|
|
|
|
## Tech Stack
|
|
|
|
- **TypeScript** 6+
|
|
- **@modelcontextprotocol/sdk** 1.12 (MCP protocol implementation)
|
|
- **Zod** 3.24 (schema validation)
|
|
- **NestJS** integration module (optional peer dependency)
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
libs/mcp-servers/
|
|
├── src/
|
|
│ ├── index.ts # Public API exports
|
|
│ ├── property-search/ # Property search tool server
|
|
│ ├── market-analytics/ # Market analytics tool server
|
|
│ ├── valuation/ # AVM valuation tool server
|
|
│ ├── nestjs/ # NestJS module integration
|
|
│ ├── shared/ # Shared types and utilities
|
|
│ └── __tests__/ # Test suite
|
|
├── package.json
|
|
└── tsconfig.json
|
|
```
|
|
|
|
## Usage
|
|
|
|
```typescript
|
|
import { PropertySearchServer, MarketAnalyticsServer } from '@goodgo/mcp-servers';
|
|
```
|
|
|
|
The MCP endpoints are exposed via the API's `apps/api/src/modules/mcp/` module.
|
|
|
|
## Building
|
|
|
|
```bash
|
|
pnpm --filter @goodgo/mcp-servers build
|
|
```
|
|
|
|
## Testing
|
|
|
|
```bash
|
|
pnpm --filter @goodgo/mcp-servers test
|
|
```
|