|
| 1 | +--- |
| 2 | +name: tanstack-start |
| 3 | +description: TanStack Start full-stack React framework patterns. Use when working with file-based routing, API routes, server handlers, TanStack Router layouts, or integrating AI/MCP features in this codebase. |
| 4 | +--- |
| 5 | + |
| 6 | +# TanStack Start |
| 7 | + |
| 8 | +## File-Based Routing |
| 9 | + |
| 10 | +Routes live in `src/routes/`. The route tree auto-generates to `src/routeTree.gen.ts` - commit this file (required for type-checking). |
| 11 | + |
| 12 | +### Route Types |
| 13 | + |
| 14 | +- `__root.tsx` - Root layout, wraps all routes |
| 15 | +- `index.tsx` - Index route for a path segment |
| 16 | +- `demo.tsx` - Layout route wrapping all `demo/*.tsx` children (uses `<Outlet />`) |
| 17 | +- `demo/*.tsx` - Child routes rendered inside parent layout |
| 18 | +- `$param.tsx` - Dynamic route segment |
| 19 | + |
| 20 | +### Layout Routes |
| 21 | + |
| 22 | +Create `foo.tsx` alongside `foo/` directory to wrap child routes: |
| 23 | + |
| 24 | +```tsx |
| 25 | +import { createFileRoute, Outlet } from '@tanstack/react-router' |
| 26 | + |
| 27 | +export const Route = createFileRoute('/foo')({ |
| 28 | + component: FooLayout, |
| 29 | +}) |
| 30 | + |
| 31 | +function FooLayout() { |
| 32 | + return ( |
| 33 | + <div> |
| 34 | + <Outlet /> |
| 35 | + </div> |
| 36 | + ) |
| 37 | +} |
| 38 | +``` |
| 39 | + |
| 40 | +## API Routes |
| 41 | + |
| 42 | +Server handlers use `api.*.ts` naming convention: |
| 43 | + |
| 44 | +```tsx |
| 45 | +import { createFileRoute } from '@tanstack/react-router' |
| 46 | + |
| 47 | +export const Route = createFileRoute('/demo/api/example')({ |
| 48 | + server: { |
| 49 | + handlers: { |
| 50 | + POST: async ({ request }) => { |
| 51 | + const data = await request.json() |
| 52 | + return Response.json({ result: data }) |
| 53 | + }, |
| 54 | + }, |
| 55 | + }, |
| 56 | +}) |
| 57 | +``` |
| 58 | + |
| 59 | +## AI Chat Integration |
| 60 | + |
| 61 | +### Client Side |
| 62 | + |
| 63 | +Use `@ai-sdk/react` with `DefaultChatTransport`: |
| 64 | + |
| 65 | +```tsx |
| 66 | +import { useChat } from '@ai-sdk/react' |
| 67 | +import { DefaultChatTransport } from 'ai' |
| 68 | + |
| 69 | +const { messages, sendMessage } = useChat({ |
| 70 | + transport: new DefaultChatTransport({ |
| 71 | + api: '/demo/api/chat', |
| 72 | + }), |
| 73 | +}) |
| 74 | +``` |
| 75 | + |
| 76 | +### Server Side |
| 77 | + |
| 78 | +Use `streamText` from `ai` package with OpenRouter provider: |
| 79 | + |
| 80 | +```tsx |
| 81 | +import { convertToModelMessages, streamText } from 'ai' |
| 82 | +import { haiku } from '@/lib/openrouter' |
| 83 | + |
| 84 | +const result = await streamText({ |
| 85 | + model: haiku, |
| 86 | + messages: convertToModelMessages(messages), |
| 87 | + system: SYSTEM_PROMPT, |
| 88 | + tools, |
| 89 | +}) |
| 90 | + |
| 91 | +return result.toUIMessageStreamResponse() |
| 92 | +``` |
| 93 | + |
| 94 | +### OpenRouter Setup |
| 95 | + |
| 96 | +Create provider singleton in `src/lib/openrouter.ts`: |
| 97 | + |
| 98 | +```tsx |
| 99 | +import { createOpenRouter } from '@openrouter/ai-sdk-provider' |
| 100 | + |
| 101 | +export const openrouter = createOpenRouter({ |
| 102 | + apiKey: process.env.OPENROUTER_API_KEY, |
| 103 | +}) |
| 104 | + |
| 105 | +export const haiku = openrouter('anthropic/claude-3.5-haiku') |
| 106 | +``` |
| 107 | + |
| 108 | +## MCP Server |
| 109 | + |
| 110 | +Register tools with Zod schemas in route files: |
| 111 | + |
| 112 | +```tsx |
| 113 | +import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js' |
| 114 | +import z from 'zod' |
| 115 | +import { handleMcpRequest } from '@/utils/mcp-handler' |
| 116 | + |
| 117 | +const server = new McpServer({ name: 'my-server', version: '1.0.0' }) |
| 118 | + |
| 119 | +server.registerTool( |
| 120 | + 'toolName', |
| 121 | + { |
| 122 | + title: 'Tool Title', |
| 123 | + description: 'Tool description', |
| 124 | + inputSchema: { param: z.string().describe('Param description') }, |
| 125 | + }, |
| 126 | + ({ param }) => ({ |
| 127 | + content: [{ type: 'text', text: result }], |
| 128 | + }), |
| 129 | +) |
| 130 | + |
| 131 | +export const Route = createFileRoute('/mcp')({ |
| 132 | + server: { |
| 133 | + handlers: { |
| 134 | + POST: async ({ request }) => handleMcpRequest(request, server), |
| 135 | + }, |
| 136 | + }, |
| 137 | +}) |
| 138 | +``` |
| 139 | + |
| 140 | +## Path Aliases |
| 141 | + |
| 142 | +`@/*` maps to `./src/*` (configured in tsconfig.json). |
0 commit comments