Open History to see the last commit
1---
2id: mcp-tools
3title: MCP Tools Reference
4---
5
6## Project Creation Tools
7
8### listTanStackAddOns
9
10Returns available add-ons for project scaffolding.
11
12**Parameters:**
13
14| Param | Type | Required | Description |
15|-------|------|----------|-------------|
16| `framework` | string | Yes | `React` or `Solid` |
17
18**Response:**
19
20```typescript
21interface AddOn {
22 id: string // e.g., "tanstack-query"
23 name: string // e.g., "TanStack Query"
24 description: string
25 type: string // "add-on", "toolchain", "deployment"
26 category: string // "tanstack", "auth", "database", etc.
27 link?: string // Documentation URL
28 warning?: string // Warning message for the add-on
29 exclusive?: string[] // Mutually exclusive add-ons
30 options?: object // Configurable options
31 dependsOn: string[] // Required add-ons
32}
33```
34
35---
36
37### getAddOnDetails
38
39Returns detailed information about a specific add-on including implementation patterns, routes, dependencies, and documentation.
40
41**Parameters:**
42
43| Param | Type | Required | Description |
44|-------|------|----------|-------------|
45| `framework` | string | Yes | `React` or `Solid` |
46| `addOnId` | string | Yes | The add-on ID (e.g., `clerk`, `drizzle`) |
47
48**Response:**
49
50```typescript
51interface AddOnDetails {
52 id: string
53 name: string
54 description: string
55 type: string
56 category: string
57 phase: string
58 modes: string[]
59 link?: string
60 warning?: string
61 exclusive?: string[]
62 dependsOn: string[]
63 options?: object
64 routes?: object[] // Route definitions
65 packageAdditions?: object // package.json additions
66 shadcnComponents?: string[] // Required shadcn components
67 integrations?: object[] // Integration configs
68 readme?: string // Add-on documentation
69 files: string[] // List of files in the add-on
70 author?: string
71 version?: string
72 license?: string
73}
74```
75
76---
77
78### createTanStackApplication
79
80Creates a new TanStack Start project.
81
82**Parameters:**
83
84| Param | Type | Required | Default |
85|-------|------|----------|---------|
86| `projectName` | string | Yes | - |
87| `targetDir` | string | Yes | - |
88| `framework` | string | Yes | - |
89| `cwd` | string | Yes | - |
90| `addOns` | string[] | No | `[]` |
91| `addOnOptions` | object | No | `{}` |
92
93**Example:**
94
95```json
96{
97 "projectName": "my-app",
98 "targetDir": "/Users/me/projects/my-app",
99 "cwd": "/Users/me/projects",
100 "framework": "React",
101 "addOns": ["tanstack-query", "clerk"]
102}
103```
104
105Use `listTanStackAddOns` to discover available add-ons and their configuration options.
106
107---
108
109## Documentation Tools
110
111### tanstack_list_libraries
112
113Lists TanStack libraries with metadata, frameworks, and documentation URLs.
114
115**Parameters:**
116
117| Param | Type | Required | Description |
118|-------|------|----------|-------------|
119| `group` | string | No | Filter by group: `state`, `headlessUI`, `performance`, `tooling` |
120
121---
122
123### tanstack_doc
124
125Fetches a documentation page by library and path.
126
127**Parameters:**
128
129| Param | Type | Required | Description |
130|-------|------|----------|-------------|
131| `library` | string | Yes | Library ID (e.g., `query`, `router`, `table`) |
132| `path` | string | Yes | Doc path (e.g., `framework/react/overview`) |
133| `version` | string | No | Version (e.g., `v5`, `v1`). Defaults to `latest` |
134
135**Example:**
136
137```json
138{
139 "library": "router",
140 "path": "framework/react/guide/data-loading"
141}
142```
143
144---
145
146### tanstack_search_docs
147
148Searches TanStack documentation.
149
150**Parameters:**
151
152| Param | Type | Required | Description |
153|-------|------|----------|-------------|
154| `query` | string | Yes | Search query |
155| `library` | string | No | Filter to specific library |
156| `framework` | string | No | Filter to specific framework |
157| `limit` | number | No | Max results (default: 10, max: 50) |
158
159---
160
161### tanstack_ecosystem
162
163Browse ecosystem partners by category or library.
164
165**Parameters:**
166
167| Param | Type | Required | Description |
168|-------|------|----------|-------------|
169| `category` | string | No | Filter by category |
170| `library` | string | No | Filter by TanStack library |
171
172---
173
174## Programmatic Usage
175
176```typescript
177import { Client } from '@modelcontextprotocol/sdk/client/index.js'
178import { StdioClientTransport } from '@modelcontextprotocol/sdk/client/stdio.js'
179
180const transport = new StdioClientTransport({
181 command: 'npx',
182 args: ['@tanstack/cli', 'mcp']
183})
184
185const client = new Client({ name: 'my-client', version: '1.0.0' }, {})
186await client.connect(transport)
187
188// List available add-ons
189const addOns = await client.callTool('listTanStackAddOns', {
190 framework: 'React'
191})
192
193// Search documentation
194const results = await client.callTool('tanstack_search_docs', {
195 query: 'server functions',
196 library: 'start'
197})
198
199// Fetch a specific doc page
200const doc = await client.callTool('tanstack_doc', {
201 library: 'router',
202 path: 'framework/react/guide/data-loading'
203})
204
205// Create a project
206const result = await client.callTool('createTanStackApplication', {
207 projectName: 'my-app',
208 targetDir: '/path/to/my-app',
209 cwd: '/path/to',
210 framework: 'React',
211 addOns: ['tanstack-query']
212})
213```