@zakstam/convex-docs-mcp 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1199 @@
1
+ {
2
+ "generatedAt": "2026-01-19T15:50:01.672Z",
3
+ "baseUrl": "https://docs.convex.dev",
4
+ "totalPages": 298,
5
+ "titles": [
6
+ {
7
+ "path": "agents",
8
+ "title": "AI Agents"
9
+ },
10
+ {
11
+ "path": "agents/agent-usage",
12
+ "title": "Agent Definition and Usage"
13
+ },
14
+ {
15
+ "path": "agents/context",
16
+ "title": "LLM Context"
17
+ },
18
+ {
19
+ "path": "agents/debugging",
20
+ "title": "Debugging"
21
+ },
22
+ {
23
+ "path": "agents/files",
24
+ "title": "Files and Images in Agent messages"
25
+ },
26
+ {
27
+ "path": "agents/getting-started",
28
+ "title": "Getting Started with Agent"
29
+ },
30
+ {
31
+ "path": "agents/human-agents",
32
+ "title": "Human Agents"
33
+ },
34
+ {
35
+ "path": "agents/messages",
36
+ "title": "Messages"
37
+ },
38
+ {
39
+ "path": "agents/playground",
40
+ "title": "Playground"
41
+ },
42
+ {
43
+ "path": "agents/rag",
44
+ "title": "RAG (Retrieval-Augmented Generation) with the Agent component"
45
+ },
46
+ {
47
+ "path": "agents/rate-limiting",
48
+ "title": "Rate Limiting"
49
+ },
50
+ {
51
+ "path": "agents/streaming",
52
+ "title": "Streaming"
53
+ },
54
+ {
55
+ "path": "agents/threads",
56
+ "title": "Threads"
57
+ },
58
+ {
59
+ "path": "agents/tools",
60
+ "title": "Tools"
61
+ },
62
+ {
63
+ "path": "agents/usage-tracking",
64
+ "title": "Usage Tracking"
65
+ },
66
+ {
67
+ "path": "agents/workflows",
68
+ "title": "Workflows"
69
+ },
70
+ {
71
+ "path": "ai",
72
+ "title": "AI Code Generation"
73
+ },
74
+ {
75
+ "path": "ai/convex-mcp-server",
76
+ "title": "Convex MCP Server"
77
+ },
78
+ {
79
+ "path": "ai/using-cursor",
80
+ "title": "Using Cursor with Convex"
81
+ },
82
+ {
83
+ "path": "ai/using-github-copilot",
84
+ "title": "Using GitHub Copilot with Convex"
85
+ },
86
+ {
87
+ "path": "ai/using-windsurf",
88
+ "title": "Using Windsurf with Convex"
89
+ },
90
+ {
91
+ "path": "api",
92
+ "title": "convex"
93
+ },
94
+ {
95
+ "path": "api/classes/browser.BaseConvexClient",
96
+ "title": "Class: BaseConvexClient"
97
+ },
98
+ {
99
+ "path": "api/classes/browser.ConvexClient",
100
+ "title": "Class: ConvexClient"
101
+ },
102
+ {
103
+ "path": "api/classes/browser.ConvexHttpClient",
104
+ "title": "Class: ConvexHttpClient"
105
+ },
106
+ {
107
+ "path": "api/classes/react.ConvexReactClient",
108
+ "title": "Class: ConvexReactClient"
109
+ },
110
+ {
111
+ "path": "api/classes/server.Crons",
112
+ "title": "Class: Crons"
113
+ },
114
+ {
115
+ "path": "api/classes/server.Expression",
116
+ "title": "Class: Expression<T>"
117
+ },
118
+ {
119
+ "path": "api/classes/server.FilterExpression",
120
+ "title": "Class: FilterExpression<T>"
121
+ },
122
+ {
123
+ "path": "api/classes/server.HttpRouter",
124
+ "title": "Class: HttpRouter"
125
+ },
126
+ {
127
+ "path": "api/classes/server.IndexRange",
128
+ "title": "Class: IndexRange"
129
+ },
130
+ {
131
+ "path": "api/classes/server.SchemaDefinition",
132
+ "title": "Class: SchemaDefinition<Schema, StrictTableTypes>"
133
+ },
134
+ {
135
+ "path": "api/classes/server.SearchFilter",
136
+ "title": "Class: SearchFilter"
137
+ },
138
+ {
139
+ "path": "api/classes/server.TableDefinition",
140
+ "title": "Class: TableDefinition<DocumentType, Indexes, SearchIndexes, VectorIndexes>"
141
+ },
142
+ {
143
+ "path": "api/classes/values.ConvexError",
144
+ "title": "Class: ConvexError<TData>"
145
+ },
146
+ {
147
+ "path": "api/classes/values.VAny",
148
+ "title": "Class: VAny<Type, IsOptional, FieldPaths>"
149
+ },
150
+ {
151
+ "path": "api/classes/values.VArray",
152
+ "title": "Class: VArray<Type, Element, IsOptional>"
153
+ },
154
+ {
155
+ "path": "api/classes/values.VBoolean",
156
+ "title": "Class: VBoolean<Type, IsOptional>"
157
+ },
158
+ {
159
+ "path": "api/classes/values.VBytes",
160
+ "title": "Class: VBytes<Type, IsOptional>"
161
+ },
162
+ {
163
+ "path": "api/classes/values.VFloat64",
164
+ "title": "Class: VFloat64<Type, IsOptional>"
165
+ },
166
+ {
167
+ "path": "api/classes/values.VId",
168
+ "title": "Class: VId<Type, IsOptional>"
169
+ },
170
+ {
171
+ "path": "api/classes/values.VInt64",
172
+ "title": "Class: VInt64<Type, IsOptional>"
173
+ },
174
+ {
175
+ "path": "api/classes/values.VLiteral",
176
+ "title": "Class: VLiteral<Type, IsOptional>"
177
+ },
178
+ {
179
+ "path": "api/classes/values.VNull",
180
+ "title": "Class: VNull<Type, IsOptional>"
181
+ },
182
+ {
183
+ "path": "api/classes/values.VObject",
184
+ "title": "Class: VObject<Type, Fields, IsOptional, FieldPaths>"
185
+ },
186
+ {
187
+ "path": "api/classes/values.VRecord",
188
+ "title": "Class: VRecord<Type, Key, Value, IsOptional, FieldPaths>"
189
+ },
190
+ {
191
+ "path": "api/classes/values.VString",
192
+ "title": "Class: VString<Type, IsOptional>"
193
+ },
194
+ {
195
+ "path": "api/classes/values.VUnion",
196
+ "title": "Class: VUnion<Type, T, IsOptional, FieldPaths>"
197
+ },
198
+ {
199
+ "path": "api/interfaces/browser.BaseConvexClientOptions",
200
+ "title": "Interface: BaseConvexClientOptions"
201
+ },
202
+ {
203
+ "path": "api/interfaces/browser.MutationOptions",
204
+ "title": "Interface: MutationOptions"
205
+ },
206
+ {
207
+ "path": "api/interfaces/browser.OptimisticLocalStore",
208
+ "title": "Interface: OptimisticLocalStore"
209
+ },
210
+ {
211
+ "path": "api/interfaces/browser.SubscribeOptions",
212
+ "title": "Interface: SubscribeOptions"
213
+ },
214
+ {
215
+ "path": "api/interfaces/react.ConvexReactClientOptions",
216
+ "title": "Interface: ConvexReactClientOptions"
217
+ },
218
+ {
219
+ "path": "api/interfaces/react.MutationOptions",
220
+ "title": "Interface: MutationOptions<Args>"
221
+ },
222
+ {
223
+ "path": "api/interfaces/react.ReactAction",
224
+ "title": "Interface: ReactAction<Action>"
225
+ },
226
+ {
227
+ "path": "api/interfaces/react.ReactMutation",
228
+ "title": "Interface: ReactMutation<Mutation>"
229
+ },
230
+ {
231
+ "path": "api/interfaces/react.Watch",
232
+ "title": "Interface: Watch<T>"
233
+ },
234
+ {
235
+ "path": "api/interfaces/react.WatchQueryOptions",
236
+ "title": "Interface: WatchQueryOptions"
237
+ },
238
+ {
239
+ "path": "api/interfaces/server.Auth",
240
+ "title": "Interface: Auth"
241
+ },
242
+ {
243
+ "path": "api/interfaces/server.BaseTableReader",
244
+ "title": "Interface: BaseTableReader<DataModel, TableName>"
245
+ },
246
+ {
247
+ "path": "api/interfaces/server.BaseTableWriter",
248
+ "title": "Interface: BaseTableWriter<DataModel, TableName>"
249
+ },
250
+ {
251
+ "path": "api/interfaces/server.CronJob",
252
+ "title": "Interface: CronJob"
253
+ },
254
+ {
255
+ "path": "api/interfaces/server.DefineSchemaOptions",
256
+ "title": "Interface: DefineSchemaOptions<StrictTableNameTypes>"
257
+ },
258
+ {
259
+ "path": "api/interfaces/server.FilterBuilder",
260
+ "title": "Interface: FilterBuilder<TableInfo>"
261
+ },
262
+ {
263
+ "path": "api/interfaces/server.GenericActionCtx",
264
+ "title": "Interface: GenericActionCtx<DataModel>"
265
+ },
266
+ {
267
+ "path": "api/interfaces/server.GenericDatabaseReader",
268
+ "title": "Interface: GenericDatabaseReader<DataModel>"
269
+ },
270
+ {
271
+ "path": "api/interfaces/server.GenericDatabaseReaderWithTable",
272
+ "title": "Interface: GenericDatabaseReaderWithTable<DataModel>"
273
+ },
274
+ {
275
+ "path": "api/interfaces/server.GenericDatabaseWriter",
276
+ "title": "Interface: GenericDatabaseWriter<DataModel>"
277
+ },
278
+ {
279
+ "path": "api/interfaces/server.GenericDatabaseWriterWithTable",
280
+ "title": "Interface: GenericDatabaseWriterWithTable<DataModel>"
281
+ },
282
+ {
283
+ "path": "api/interfaces/server.GenericMutationCtx",
284
+ "title": "Interface: GenericMutationCtx<DataModel>"
285
+ },
286
+ {
287
+ "path": "api/interfaces/server.GenericQueryCtx",
288
+ "title": "Interface: GenericQueryCtx<DataModel>"
289
+ },
290
+ {
291
+ "path": "api/interfaces/server.IndexRangeBuilder",
292
+ "title": "Interface: IndexRangeBuilder<Document, IndexFields, FieldNum>"
293
+ },
294
+ {
295
+ "path": "api/interfaces/server.OrderedQuery",
296
+ "title": "Interface: OrderedQuery<TableInfo>"
297
+ },
298
+ {
299
+ "path": "api/interfaces/server.PaginationOptions",
300
+ "title": "Interface: PaginationOptions"
301
+ },
302
+ {
303
+ "path": "api/interfaces/server.PaginationResult",
304
+ "title": "Interface: PaginationResult<T>"
305
+ },
306
+ {
307
+ "path": "api/interfaces/server.Query",
308
+ "title": "Interface: Query<TableInfo>"
309
+ },
310
+ {
311
+ "path": "api/interfaces/server.QueryInitializer",
312
+ "title": "Interface: QueryInitializer<TableInfo>"
313
+ },
314
+ {
315
+ "path": "api/interfaces/server.Scheduler",
316
+ "title": "Interface: Scheduler"
317
+ },
318
+ {
319
+ "path": "api/interfaces/server.SearchFilterBuilder",
320
+ "title": "Interface: SearchFilterBuilder<Document, SearchIndexConfig>"
321
+ },
322
+ {
323
+ "path": "api/interfaces/server.SearchFilterFinalizer",
324
+ "title": "Interface: SearchFilterFinalizer<Document, SearchIndexConfig>"
325
+ },
326
+ {
327
+ "path": "api/interfaces/server.SearchIndexConfig",
328
+ "title": "Interface: SearchIndexConfig<SearchField, FilterFields>"
329
+ },
330
+ {
331
+ "path": "api/interfaces/server.StorageActionWriter",
332
+ "title": "Interface: StorageActionWriter"
333
+ },
334
+ {
335
+ "path": "api/interfaces/server.StorageReader",
336
+ "title": "Interface: StorageReader"
337
+ },
338
+ {
339
+ "path": "api/interfaces/server.StorageWriter",
340
+ "title": "Interface: StorageWriter"
341
+ },
342
+ {
343
+ "path": "api/interfaces/server.SystemDataModel",
344
+ "title": "Interface: SystemDataModel"
345
+ },
346
+ {
347
+ "path": "api/interfaces/server.UserIdentity",
348
+ "title": "Interface: UserIdentity"
349
+ },
350
+ {
351
+ "path": "api/interfaces/server.ValidatedFunction",
352
+ "title": "Interface: ValidatedFunction<Ctx, ArgsValidator, Returns>"
353
+ },
354
+ {
355
+ "path": "api/interfaces/server.VectorFilterBuilder",
356
+ "title": "Interface: VectorFilterBuilder<Document, VectorIndexConfig>"
357
+ },
358
+ {
359
+ "path": "api/interfaces/server.VectorIndexConfig",
360
+ "title": "Interface: VectorIndexConfig<VectorField, FilterFields>"
361
+ },
362
+ {
363
+ "path": "api/interfaces/server.VectorSearchQuery",
364
+ "title": "Interface: VectorSearchQuery<TableInfo, IndexName>"
365
+ },
366
+ {
367
+ "path": "api/modules",
368
+ "title": "convex"
369
+ },
370
+ {
371
+ "path": "api/modules/browser",
372
+ "title": "Module: browser"
373
+ },
374
+ {
375
+ "path": "api/modules/nextjs",
376
+ "title": "Module: nextjs"
377
+ },
378
+ {
379
+ "path": "api/modules/react",
380
+ "title": "Module: react"
381
+ },
382
+ {
383
+ "path": "api/modules/react_auth0",
384
+ "title": "Module: react-auth0"
385
+ },
386
+ {
387
+ "path": "api/modules/react_clerk",
388
+ "title": "Module: react-clerk"
389
+ },
390
+ {
391
+ "path": "api/modules/server",
392
+ "title": "Module: server"
393
+ },
394
+ {
395
+ "path": "api/modules/values",
396
+ "title": "Module: values"
397
+ },
398
+ {
399
+ "path": "api/namespaces/values.Base64",
400
+ "title": "Namespace: Base64"
401
+ },
402
+ {
403
+ "path": "auth",
404
+ "title": "Authentication"
405
+ },
406
+ {
407
+ "path": "auth/advanced/custom-auth",
408
+ "title": "Custom OIDC Provider"
409
+ },
410
+ {
411
+ "path": "auth/advanced/custom-jwt",
412
+ "title": "Custom JWT Provider"
413
+ },
414
+ {
415
+ "path": "auth/auth0",
416
+ "title": "Convex & Auth0"
417
+ },
418
+ {
419
+ "path": "auth/authkit",
420
+ "title": "Convex & WorkOS AuthKit"
421
+ },
422
+ {
423
+ "path": "auth/authkit/auto-provision",
424
+ "title": "Automatic AuthKit Configuration"
425
+ },
426
+ {
427
+ "path": "auth/authkit/troubleshooting",
428
+ "title": "AuthKit Troubleshooting"
429
+ },
430
+ {
431
+ "path": "auth/clerk",
432
+ "title": "Convex & Clerk"
433
+ },
434
+ {
435
+ "path": "auth/convex-auth",
436
+ "title": "Convex Auth"
437
+ },
438
+ {
439
+ "path": "auth/database-auth",
440
+ "title": "Storing Users in the Convex Database"
441
+ },
442
+ {
443
+ "path": "auth/debug",
444
+ "title": "Debugging Authentication"
445
+ },
446
+ {
447
+ "path": "auth/functions-auth",
448
+ "title": "Auth in Functions"
449
+ },
450
+ {
451
+ "path": "chef",
452
+ "title": "Chef"
453
+ },
454
+ {
455
+ "path": "cli",
456
+ "title": "CLI"
457
+ },
458
+ {
459
+ "path": "cli/agent-mode",
460
+ "title": "Agent Mode"
461
+ },
462
+ {
463
+ "path": "cli/deploy-key-types",
464
+ "title": "Deploy keys"
465
+ },
466
+ {
467
+ "path": "cli/local-deployments",
468
+ "title": "Local Deployments for Development"
469
+ },
470
+ {
471
+ "path": "client/android",
472
+ "title": "Android Kotlin"
473
+ },
474
+ {
475
+ "path": "client/android/data-types",
476
+ "title": "Kotlin and Convex type conversion"
477
+ },
478
+ {
479
+ "path": "client/javascript",
480
+ "title": "JavaScript"
481
+ },
482
+ {
483
+ "path": "client/javascript/bun",
484
+ "title": "Bun"
485
+ },
486
+ {
487
+ "path": "client/javascript/node",
488
+ "title": "Node.js"
489
+ },
490
+ {
491
+ "path": "client/javascript/script-tag",
492
+ "title": "Script Tag"
493
+ },
494
+ {
495
+ "path": "client/nextjs/app-router",
496
+ "title": "Next.js"
497
+ },
498
+ {
499
+ "path": "client/nextjs/app-router/server-rendering",
500
+ "title": "Next.js Server Rendering"
501
+ },
502
+ {
503
+ "path": "client/nextjs/pages-router",
504
+ "title": "Next.js Pages Router"
505
+ },
506
+ {
507
+ "path": "client/nextjs/pages-router/quickstart",
508
+ "title": "Next.js Pages Quickstart"
509
+ },
510
+ {
511
+ "path": "client/open-api",
512
+ "title": "OpenAPI & Other Languages"
513
+ },
514
+ {
515
+ "path": "client/python",
516
+ "title": "Python"
517
+ },
518
+ {
519
+ "path": "client/react",
520
+ "title": "Convex React"
521
+ },
522
+ {
523
+ "path": "client/react-native",
524
+ "title": "Convex React Native"
525
+ },
526
+ {
527
+ "path": "client/react/deployment-urls",
528
+ "title": "Configuring Deployment URL"
529
+ },
530
+ {
531
+ "path": "client/react/optimistic-updates",
532
+ "title": "Optimistic Updates"
533
+ },
534
+ {
535
+ "path": "client/rust",
536
+ "title": "Rust"
537
+ },
538
+ {
539
+ "path": "client/svelte",
540
+ "title": "Svelte"
541
+ },
542
+ {
543
+ "path": "client/swift",
544
+ "title": "iOS & macOS Swift"
545
+ },
546
+ {
547
+ "path": "client/swift/data-types",
548
+ "title": "Swift and Convex type conversion"
549
+ },
550
+ {
551
+ "path": "client/tanstack/tanstack-query",
552
+ "title": "Convex with TanStack Query"
553
+ },
554
+ {
555
+ "path": "client/tanstack/tanstack-start",
556
+ "title": "TanStack Start"
557
+ },
558
+ {
559
+ "path": "client/tanstack/tanstack-start/clerk",
560
+ "title": "TanStack Start with Clerk"
561
+ },
562
+ {
563
+ "path": "client/vue",
564
+ "title": "Vue"
565
+ },
566
+ {
567
+ "path": "client/vue/nuxt",
568
+ "title": "Nuxt"
569
+ },
570
+ {
571
+ "path": "components",
572
+ "title": "Components"
573
+ },
574
+ {
575
+ "path": "components/authoring",
576
+ "title": "Authoring Components"
577
+ },
578
+ {
579
+ "path": "components/understanding",
580
+ "title": "Understanding Components"
581
+ },
582
+ {
583
+ "path": "components/using",
584
+ "title": "Using Components"
585
+ },
586
+ {
587
+ "path": "dashboard",
588
+ "title": "Dashboard"
589
+ },
590
+ {
591
+ "path": "dashboard/deployments",
592
+ "title": "Deployments"
593
+ },
594
+ {
595
+ "path": "dashboard/deployments/data",
596
+ "title": "Data"
597
+ },
598
+ {
599
+ "path": "dashboard/deployments/deployment-settings",
600
+ "title": "Settings"
601
+ },
602
+ {
603
+ "path": "dashboard/deployments/file-storage",
604
+ "title": "File Storage"
605
+ },
606
+ {
607
+ "path": "dashboard/deployments/functions",
608
+ "title": "Functions"
609
+ },
610
+ {
611
+ "path": "dashboard/deployments/health",
612
+ "title": "Health"
613
+ },
614
+ {
615
+ "path": "dashboard/deployments/history",
616
+ "title": "History"
617
+ },
618
+ {
619
+ "path": "dashboard/deployments/logs",
620
+ "title": "Logs"
621
+ },
622
+ {
623
+ "path": "dashboard/deployments/schedules",
624
+ "title": "Schedules"
625
+ },
626
+ {
627
+ "path": "dashboard/projects",
628
+ "title": "Projects"
629
+ },
630
+ {
631
+ "path": "dashboard/teams",
632
+ "title": "Teams"
633
+ },
634
+ {
635
+ "path": "database",
636
+ "title": "Database"
637
+ },
638
+ {
639
+ "path": "database/advanced/occ",
640
+ "title": "OCC and Atomicity"
641
+ },
642
+ {
643
+ "path": "database/advanced/schema-philosophy",
644
+ "title": "Schema Philosophy"
645
+ },
646
+ {
647
+ "path": "database/advanced/system-tables",
648
+ "title": "System Tables"
649
+ },
650
+ {
651
+ "path": "database/backup-restore",
652
+ "title": "Backup & Restore"
653
+ },
654
+ {
655
+ "path": "database/document-ids",
656
+ "title": "Document IDs"
657
+ },
658
+ {
659
+ "path": "database/import-export",
660
+ "title": "Data Import & Export"
661
+ },
662
+ {
663
+ "path": "database/import-export/export",
664
+ "title": "Data Export"
665
+ },
666
+ {
667
+ "path": "database/import-export/import",
668
+ "title": "Data Import"
669
+ },
670
+ {
671
+ "path": "database/pagination",
672
+ "title": "Paginated Queries"
673
+ },
674
+ {
675
+ "path": "database/reading-data",
676
+ "title": "Reading Data"
677
+ },
678
+ {
679
+ "path": "database/reading-data/filters",
680
+ "title": "Filters"
681
+ },
682
+ {
683
+ "path": "database/reading-data/indexes",
684
+ "title": "Indexes"
685
+ },
686
+ {
687
+ "path": "database/reading-data/indexes/indexes-and-query-perf",
688
+ "title": "Introduction to Indexes and Query Performance"
689
+ },
690
+ {
691
+ "path": "database/schemas",
692
+ "title": "Schemas"
693
+ },
694
+ {
695
+ "path": "database/types",
696
+ "title": "Data Types"
697
+ },
698
+ {
699
+ "path": "database/writing-data",
700
+ "title": "Writing Data"
701
+ },
702
+ {
703
+ "path": "deployment-api",
704
+ "title": "Deployment API"
705
+ },
706
+ {
707
+ "path": "deployment-api/convex-deployment-api",
708
+ "title": "Convex Deployment API"
709
+ },
710
+ {
711
+ "path": "deployment-api/create-log-stream",
712
+ "title": "Create log stream"
713
+ },
714
+ {
715
+ "path": "deployment-api/delete-log-stream",
716
+ "title": "Delete log stream"
717
+ },
718
+ {
719
+ "path": "deployment-api/get-canonical-urls",
720
+ "title": "Get canonical URLs"
721
+ },
722
+ {
723
+ "path": "deployment-api/get-log-stream",
724
+ "title": "Get log stream"
725
+ },
726
+ {
727
+ "path": "deployment-api/list-environment-variables",
728
+ "title": "List environment variables"
729
+ },
730
+ {
731
+ "path": "deployment-api/list-log-streams",
732
+ "title": "List log streams"
733
+ },
734
+ {
735
+ "path": "deployment-api/pause-deployment",
736
+ "title": "Pause deployment"
737
+ },
738
+ {
739
+ "path": "deployment-api/rotate-webhook-secret",
740
+ "title": "Rotate webhook log stream secret"
741
+ },
742
+ {
743
+ "path": "deployment-api/unpause-deployment",
744
+ "title": "Unpause deployment"
745
+ },
746
+ {
747
+ "path": "deployment-api/update-canonical-url",
748
+ "title": "Update canonical URL"
749
+ },
750
+ {
751
+ "path": "deployment-api/update-environment-variables",
752
+ "title": "Update environment variables"
753
+ },
754
+ {
755
+ "path": "deployment-api/update-log-stream",
756
+ "title": "Update log stream"
757
+ },
758
+ {
759
+ "path": "deployment-platform-api",
760
+ "title": "Deployment Platform API"
761
+ },
762
+ {
763
+ "path": "error",
764
+ "title": "Errors and Warnings"
765
+ },
766
+ {
767
+ "path": "eslint",
768
+ "title": "ESLint rules"
769
+ },
770
+ {
771
+ "path": "file-storage",
772
+ "title": "File Storage"
773
+ },
774
+ {
775
+ "path": "file-storage/delete-files",
776
+ "title": "Deleting Files"
777
+ },
778
+ {
779
+ "path": "file-storage/file-metadata",
780
+ "title": "Accessing File Metadata"
781
+ },
782
+ {
783
+ "path": "file-storage/serve-files",
784
+ "title": "Serving Files"
785
+ },
786
+ {
787
+ "path": "file-storage/store-files",
788
+ "title": "Storing Generated Files"
789
+ },
790
+ {
791
+ "path": "file-storage/upload-files",
792
+ "title": "Uploading and Storing Files"
793
+ },
794
+ {
795
+ "path": "functions",
796
+ "title": "Functions"
797
+ },
798
+ {
799
+ "path": "functions/actions",
800
+ "title": "Actions"
801
+ },
802
+ {
803
+ "path": "functions/bundling",
804
+ "title": "Bundling"
805
+ },
806
+ {
807
+ "path": "functions/debugging",
808
+ "title": "Debugging"
809
+ },
810
+ {
811
+ "path": "functions/error-handling",
812
+ "title": "Error Handling"
813
+ },
814
+ {
815
+ "path": "functions/error-handling/application-errors",
816
+ "title": "Application Errors"
817
+ },
818
+ {
819
+ "path": "functions/http-actions",
820
+ "title": "HTTP Actions"
821
+ },
822
+ {
823
+ "path": "functions/internal-functions",
824
+ "title": "Internal Functions"
825
+ },
826
+ {
827
+ "path": "functions/mutation-functions",
828
+ "title": "Mutations"
829
+ },
830
+ {
831
+ "path": "functions/query-functions",
832
+ "title": "Queries"
833
+ },
834
+ {
835
+ "path": "functions/runtimes",
836
+ "title": "Runtimes"
837
+ },
838
+ {
839
+ "path": "functions/validation",
840
+ "title": "Argument and Return Value Validation"
841
+ },
842
+ {
843
+ "path": "generated-api",
844
+ "title": "Generated Code"
845
+ },
846
+ {
847
+ "path": "generated-api/api",
848
+ "title": "api.js"
849
+ },
850
+ {
851
+ "path": "generated-api/data-model",
852
+ "title": "dataModel.d.ts"
853
+ },
854
+ {
855
+ "path": "generated-api/server",
856
+ "title": "server.js"
857
+ },
858
+ {
859
+ "path": "home",
860
+ "title": "Convex Docs"
861
+ },
862
+ {
863
+ "path": "http-api",
864
+ "title": "Convex HTTP API"
865
+ },
866
+ {
867
+ "path": "index",
868
+ "title": "Convex Developer Hub"
869
+ },
870
+ {
871
+ "path": "management-api",
872
+ "title": "Management API"
873
+ },
874
+ {
875
+ "path": "management-api/convex-management-api",
876
+ "title": "Convex Management API"
877
+ },
878
+ {
879
+ "path": "management-api/create-custom-domain",
880
+ "title": "Create custom domain"
881
+ },
882
+ {
883
+ "path": "management-api/create-deploy-key",
884
+ "title": "Create deploy key"
885
+ },
886
+ {
887
+ "path": "management-api/create-project",
888
+ "title": "Create project"
889
+ },
890
+ {
891
+ "path": "management-api/delete-custom-domain",
892
+ "title": "Delete custom domain"
893
+ },
894
+ {
895
+ "path": "management-api/delete-deployment",
896
+ "title": "Delete deployment"
897
+ },
898
+ {
899
+ "path": "management-api/delete-project",
900
+ "title": "Delete project"
901
+ },
902
+ {
903
+ "path": "management-api/get-token-details",
904
+ "title": "Get token details"
905
+ },
906
+ {
907
+ "path": "management-api/list-custom-domains",
908
+ "title": "List custom domains"
909
+ },
910
+ {
911
+ "path": "management-api/list-deployments",
912
+ "title": "List deployments"
913
+ },
914
+ {
915
+ "path": "management-api/list-projects",
916
+ "title": "List projects"
917
+ },
918
+ {
919
+ "path": "platform-apis",
920
+ "title": "Platform APIs"
921
+ },
922
+ {
923
+ "path": "platform-apis/embedded-dashboard",
924
+ "title": "Embedding the dashboard"
925
+ },
926
+ {
927
+ "path": "platform-apis/oauth-applications",
928
+ "title": "OAuth Applications"
929
+ },
930
+ {
931
+ "path": "production",
932
+ "title": "Deploying Your App to Production"
933
+ },
934
+ {
935
+ "path": "production/contact",
936
+ "title": "Contact Us"
937
+ },
938
+ {
939
+ "path": "production/environment-variables",
940
+ "title": "Environment Variables"
941
+ },
942
+ {
943
+ "path": "production/hosting",
944
+ "title": "Hosting and Deployment"
945
+ },
946
+ {
947
+ "path": "production/hosting/custom",
948
+ "title": "Custom Domains & Hosting"
949
+ },
950
+ {
951
+ "path": "production/hosting/netlify",
952
+ "title": "Using Convex with Netlify"
953
+ },
954
+ {
955
+ "path": "production/hosting/preview-deployments",
956
+ "title": "Preview Deployments"
957
+ },
958
+ {
959
+ "path": "production/hosting/vercel",
960
+ "title": "Using Convex with Vercel"
961
+ },
962
+ {
963
+ "path": "production/integrations",
964
+ "title": "Integrations"
965
+ },
966
+ {
967
+ "path": "production/integrations/exception-reporting",
968
+ "title": "Exception Reporting"
969
+ },
970
+ {
971
+ "path": "production/integrations/log-streams",
972
+ "title": "Log Streams"
973
+ },
974
+ {
975
+ "path": "production/integrations/log-streams/legacy-event-schema",
976
+ "title": "(Legacy) Event schema"
977
+ },
978
+ {
979
+ "path": "production/integrations/streaming-import-export",
980
+ "title": "Streaming Data in and out of Convex"
981
+ },
982
+ {
983
+ "path": "production/multiple-repos",
984
+ "title": "Multiple Repositories"
985
+ },
986
+ {
987
+ "path": "production/pause-deployment",
988
+ "title": "Pausing a Deployment"
989
+ },
990
+ {
991
+ "path": "production/project-configuration",
992
+ "title": "Project Configuration"
993
+ },
994
+ {
995
+ "path": "production/state",
996
+ "title": "Status and Guarantees"
997
+ },
998
+ {
999
+ "path": "production/state/limits",
1000
+ "title": "Limits"
1001
+ },
1002
+ {
1003
+ "path": "public-deployment-api/convex-public-http-routes",
1004
+ "title": "Convex Public HTTP routes"
1005
+ },
1006
+ {
1007
+ "path": "public-deployment-api/public-action-post",
1008
+ "title": "Execute action"
1009
+ },
1010
+ {
1011
+ "path": "public-deployment-api/public-function-post",
1012
+ "title": "Execute any function"
1013
+ },
1014
+ {
1015
+ "path": "public-deployment-api/public-function-post-with-path",
1016
+ "title": "Execute function by URL path"
1017
+ },
1018
+ {
1019
+ "path": "public-deployment-api/public-get-query-ts",
1020
+ "title": "Get latest timestamp"
1021
+ },
1022
+ {
1023
+ "path": "public-deployment-api/public-mutation-post",
1024
+ "title": "Execute mutation"
1025
+ },
1026
+ {
1027
+ "path": "public-deployment-api/public-query-at-ts-post",
1028
+ "title": "Execute query at timestamp"
1029
+ },
1030
+ {
1031
+ "path": "public-deployment-api/public-query-batch-post",
1032
+ "title": "Execute query batch"
1033
+ },
1034
+ {
1035
+ "path": "public-deployment-api/public-query-get",
1036
+ "title": "Execute query (GET)"
1037
+ },
1038
+ {
1039
+ "path": "public-deployment-api/public-query-post",
1040
+ "title": "Execute query (POST)"
1041
+ },
1042
+ {
1043
+ "path": "quickstart/android",
1044
+ "title": "Android Kotlin Quickstart"
1045
+ },
1046
+ {
1047
+ "path": "quickstart/bun",
1048
+ "title": "Bun Quickstart"
1049
+ },
1050
+ {
1051
+ "path": "quickstart/nextjs",
1052
+ "title": "Next.js Quickstart"
1053
+ },
1054
+ {
1055
+ "path": "quickstart/nodejs",
1056
+ "title": "Node.js Quickstart"
1057
+ },
1058
+ {
1059
+ "path": "quickstart/nuxt",
1060
+ "title": "Nuxt Quickstart"
1061
+ },
1062
+ {
1063
+ "path": "quickstart/python",
1064
+ "title": "Python Quickstart"
1065
+ },
1066
+ {
1067
+ "path": "quickstart/react",
1068
+ "title": "React Quickstart"
1069
+ },
1070
+ {
1071
+ "path": "quickstart/react-native",
1072
+ "title": "React Native Quickstart"
1073
+ },
1074
+ {
1075
+ "path": "quickstart/remix",
1076
+ "title": "Remix Quickstart"
1077
+ },
1078
+ {
1079
+ "path": "quickstart/rust",
1080
+ "title": "Rust Quickstart"
1081
+ },
1082
+ {
1083
+ "path": "quickstart/script-tag",
1084
+ "title": "Script Tag Quickstart"
1085
+ },
1086
+ {
1087
+ "path": "quickstart/svelte",
1088
+ "title": "Svelte Quickstart"
1089
+ },
1090
+ {
1091
+ "path": "quickstart/swift",
1092
+ "title": "iOS Swift Quickstart"
1093
+ },
1094
+ {
1095
+ "path": "quickstart/tanstack-start",
1096
+ "title": "TanStack Start Quickstart"
1097
+ },
1098
+ {
1099
+ "path": "quickstart/vue",
1100
+ "title": "Vue Quickstart"
1101
+ },
1102
+ {
1103
+ "path": "quickstarts",
1104
+ "title": "Quickstarts"
1105
+ },
1106
+ {
1107
+ "path": "realtime",
1108
+ "title": "Realtime"
1109
+ },
1110
+ {
1111
+ "path": "scheduling",
1112
+ "title": "Scheduling"
1113
+ },
1114
+ {
1115
+ "path": "scheduling/cron-jobs",
1116
+ "title": "Cron Jobs"
1117
+ },
1118
+ {
1119
+ "path": "scheduling/scheduled-functions",
1120
+ "title": "Scheduled Functions"
1121
+ },
1122
+ {
1123
+ "path": "search",
1124
+ "title": "AI & Search"
1125
+ },
1126
+ {
1127
+ "path": "search/text-search",
1128
+ "title": "Full Text Search"
1129
+ },
1130
+ {
1131
+ "path": "search/vector-search",
1132
+ "title": "Vector Search"
1133
+ },
1134
+ {
1135
+ "path": "self-hosting",
1136
+ "title": "Self Hosting"
1137
+ },
1138
+ {
1139
+ "path": "streaming-export-api",
1140
+ "title": "Streaming Export"
1141
+ },
1142
+ {
1143
+ "path": "streaming-import-api",
1144
+ "title": "Streaming Import"
1145
+ },
1146
+ {
1147
+ "path": "testing",
1148
+ "title": "Testing"
1149
+ },
1150
+ {
1151
+ "path": "testing/ci",
1152
+ "title": "Continuous Integration"
1153
+ },
1154
+ {
1155
+ "path": "testing/convex-backend",
1156
+ "title": "Testing Local Backend"
1157
+ },
1158
+ {
1159
+ "path": "testing/convex-test",
1160
+ "title": "convex-test"
1161
+ },
1162
+ {
1163
+ "path": "tutorial",
1164
+ "title": "Convex Tutorial: A Chat App"
1165
+ },
1166
+ {
1167
+ "path": "tutorial/actions",
1168
+ "title": "Convex Tutorial: Calling External Services"
1169
+ },
1170
+ {
1171
+ "path": "tutorial/scale",
1172
+ "title": "Convex Tutorial: Scaling Your App"
1173
+ },
1174
+ {
1175
+ "path": "understanding",
1176
+ "title": "Convex Overview"
1177
+ },
1178
+ {
1179
+ "path": "understanding/best-practices",
1180
+ "title": "Best Practices"
1181
+ },
1182
+ {
1183
+ "path": "understanding/best-practices/other-recommendations",
1184
+ "title": "Other Recommendations"
1185
+ },
1186
+ {
1187
+ "path": "understanding/best-practices/typescript",
1188
+ "title": "TypeScript"
1189
+ },
1190
+ {
1191
+ "path": "understanding/workflow",
1192
+ "title": "Dev workflow"
1193
+ },
1194
+ {
1195
+ "path": "understanding/zen",
1196
+ "title": "The Zen of Convex"
1197
+ }
1198
+ ]
1199
+ }