skip to main content
Browse documentation

Syncanix with NestJS

Make a NestJS API agent-ready: what discovery reads, how to run it, and how to ship the chat surface and MCP server.

NestJS declares routes with decorators and composes prefixes globally. Discovery reads both β€” the @Controller prefix and setGlobalPrefix β€” even when they live in different files.

What discovery reads

Discovery is static β€” it reads your source, not your traffic. It composes full request paths across files, so mounted prefixes are part of every extracted route:

// main.ts
app.setGlobalPrefix('api');

// orders.controller.ts
@Controller('orders')
export class OrdersController {
  @Get(':id')                       // β†’ GET /api/orders/:id
  @Post(':id/refund')               // β†’ POST /api/orders/:id/refund
}
Representative routes the extractor composes β€” full paths, prefixes included.

The extractor combines the @Controller(’orders’)-style controller prefix with setGlobalPrefix from main.ts β€” a cross-file composition β€” so each handler decorator is catalogued under its full production path.

Run discovery

From the repository root, run the init command. It detects the framework automatically, asks for consent before any LLM enrichment, and writes a deterministic catalog:

$ npx syncanix init
βœ“ detected framework
βœ“ scanned routes
βœ“ wrote .syncanix/catalog.json
β†’ review your capabilities in the dashboard

Review the catalog

The catalog at .syncanix/catalog.json lists every capability discovery found β€” method, path, and the enriched description your users will see. Review it like code before uploading: it is the contract your chat surface and MCP server expose.

Ship the surface

Once the catalog is uploaded, embed the widget for in-app chat and connect the per-tenant MCP server for Claude, ChatGPT, and Cursor. Every write action stays permission-gated, confirmed, and audited.

Next steps