@mastra/mcp-docs-server 1.0.0-beta.13 → 1.0.0-beta.14

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.
Files changed (297) hide show
  1. package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +19 -19
  2. package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +28 -28
  3. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +98 -98
  4. package/.docs/organized/changelogs/%40mastra%2Fconvex.md +30 -0
  5. package/.docs/organized/changelogs/%40mastra%2Fcore.md +171 -171
  6. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +15 -15
  7. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +16 -16
  8. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +15 -15
  9. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +10 -10
  10. package/.docs/organized/changelogs/%40mastra%2Fmemory.md +12 -12
  11. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +22 -22
  12. package/.docs/organized/changelogs/%40mastra%2Frag.md +17 -17
  13. package/.docs/organized/changelogs/%40mastra%2Freact.md +9 -2
  14. package/.docs/organized/changelogs/%40mastra%2Fserver.md +94 -94
  15. package/.docs/organized/changelogs/create-mastra.md +3 -3
  16. package/.docs/organized/changelogs/mastra.md +17 -17
  17. package/.docs/organized/code-examples/agent-v6.md +151 -0
  18. package/.docs/organized/code-examples/ai-elements.md +1 -1
  19. package/.docs/raw/agents/adding-voice.mdx +2 -3
  20. package/.docs/raw/agents/agent-approval.mdx +5 -6
  21. package/.docs/raw/agents/agent-memory.mdx +22 -30
  22. package/.docs/raw/agents/guardrails.mdx +60 -50
  23. package/.docs/raw/agents/networks.mdx +8 -12
  24. package/.docs/raw/agents/overview.mdx +39 -23
  25. package/.docs/raw/agents/processors.mdx +20 -19
  26. package/.docs/raw/agents/structured-output.mdx +11 -7
  27. package/.docs/raw/agents/using-tools.mdx +4 -5
  28. package/.docs/raw/deployment/mastra-server.mdx +3 -3
  29. package/.docs/raw/deployment/overview.mdx +7 -0
  30. package/.docs/raw/deployment/web-framework.mdx +4 -6
  31. package/.docs/raw/evals/custom-scorers.mdx +9 -6
  32. package/.docs/raw/evals/overview.mdx +3 -6
  33. package/.docs/raw/evals/running-in-ci.mdx +2 -2
  34. package/.docs/raw/getting-started/manual-install.mdx +20 -20
  35. package/.docs/raw/getting-started/mcp-docs-server.mdx +2 -2
  36. package/.docs/raw/guides/agent-frameworks/ai-sdk.mdx +4 -4
  37. package/.docs/raw/guides/build-your-ui/ai-sdk-ui.mdx +30 -30
  38. package/.docs/raw/guides/build-your-ui/assistant-ui.mdx +8 -8
  39. package/.docs/raw/guides/build-your-ui/copilotkit.mdx +11 -11
  40. package/.docs/raw/guides/deployment/amazon-ec2.mdx +9 -9
  41. package/.docs/raw/guides/deployment/aws-lambda.mdx +11 -11
  42. package/.docs/raw/guides/deployment/azure-app-services.mdx +2 -2
  43. package/.docs/raw/guides/deployment/cloudflare-deployer.mdx +5 -6
  44. package/.docs/raw/guides/deployment/digital-ocean.mdx +10 -10
  45. package/.docs/raw/guides/deployment/index.mdx +1 -1
  46. package/.docs/raw/guides/deployment/inngest.mdx +386 -0
  47. package/.docs/raw/guides/deployment/netlify-deployer.mdx +4 -4
  48. package/.docs/raw/guides/deployment/vercel-deployer.mdx +5 -6
  49. package/.docs/raw/guides/getting-started/astro.mdx +292 -451
  50. package/.docs/raw/guides/getting-started/express.mdx +7 -7
  51. package/.docs/raw/guides/getting-started/hono.mdx +18 -18
  52. package/.docs/raw/guides/getting-started/next-js.mdx +19 -20
  53. package/.docs/raw/guides/getting-started/quickstart.mdx +4 -4
  54. package/.docs/raw/guides/getting-started/sveltekit.mdx +238 -409
  55. package/.docs/raw/guides/getting-started/vite-react.mdx +21 -21
  56. package/.docs/raw/guides/guide/ai-recruiter.mdx +10 -10
  57. package/.docs/raw/guides/guide/chef-michel.mdx +9 -11
  58. package/.docs/raw/guides/guide/notes-mcp-server.mdx +15 -15
  59. package/.docs/raw/guides/guide/research-assistant.mdx +13 -13
  60. package/.docs/raw/guides/guide/stock-agent.mdx +5 -5
  61. package/.docs/raw/guides/guide/web-search.mdx +8 -8
  62. package/.docs/raw/guides/guide/whatsapp-chat-bot.mdx +7 -7
  63. package/.docs/raw/guides/migrations/ai-sdk-v4-to-v5.mdx +2 -2
  64. package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +1 -1
  65. package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +0 -2
  66. package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +21 -23
  67. package/.docs/raw/index.mdx +2 -2
  68. package/.docs/raw/mastra-cloud/setting-up.mdx +6 -2
  69. package/.docs/raw/mcp/overview.mdx +31 -13
  70. package/.docs/raw/mcp/publishing-mcp-server.mdx +2 -2
  71. package/.docs/raw/memory/memory-processors.mdx +9 -9
  72. package/.docs/raw/memory/message-history.mdx +69 -0
  73. package/.docs/raw/memory/overview.mdx +34 -76
  74. package/.docs/raw/memory/semantic-recall.mdx +58 -49
  75. package/.docs/raw/memory/storage.mdx +188 -0
  76. package/.docs/raw/memory/working-memory.mdx +7 -7
  77. package/.docs/raw/observability/logging.mdx +9 -10
  78. package/.docs/raw/observability/overview.mdx +0 -1
  79. package/.docs/raw/observability/tracing/bridges/otel.mdx +2 -2
  80. package/.docs/raw/observability/tracing/exporters/default.mdx +3 -3
  81. package/.docs/raw/observability/tracing/exporters/langfuse.mdx +1 -2
  82. package/.docs/raw/observability/tracing/overview.mdx +23 -25
  83. package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +3 -3
  84. package/.docs/raw/rag/chunking-and-embedding.mdx +6 -6
  85. package/.docs/raw/rag/graph-rag.mdx +7 -7
  86. package/.docs/raw/rag/overview.mdx +1 -1
  87. package/.docs/raw/rag/retrieval.mdx +21 -22
  88. package/.docs/raw/rag/vector-databases.mdx +22 -22
  89. package/.docs/raw/reference/agents/agent.mdx +3 -3
  90. package/.docs/raw/reference/agents/generate.mdx +1 -1
  91. package/.docs/raw/reference/agents/generateLegacy.mdx +2 -2
  92. package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +2 -2
  93. package/.docs/raw/reference/agents/getDefaultOptions.mdx +2 -2
  94. package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +2 -2
  95. package/.docs/raw/reference/agents/getDescription.mdx +1 -1
  96. package/.docs/raw/reference/agents/getInstructions.mdx +2 -2
  97. package/.docs/raw/reference/agents/getLLM.mdx +2 -2
  98. package/.docs/raw/reference/agents/getMemory.mdx +2 -2
  99. package/.docs/raw/reference/agents/getModel.mdx +2 -2
  100. package/.docs/raw/reference/agents/getTools.mdx +2 -2
  101. package/.docs/raw/reference/agents/getVoice.mdx +2 -2
  102. package/.docs/raw/reference/agents/listAgents.mdx +2 -2
  103. package/.docs/raw/reference/agents/listScorers.mdx +2 -2
  104. package/.docs/raw/reference/agents/listTools.mdx +2 -2
  105. package/.docs/raw/reference/agents/listWorkflows.mdx +2 -2
  106. package/.docs/raw/reference/agents/network.mdx +1 -1
  107. package/.docs/raw/reference/ai-sdk/chat-route.mdx +2 -2
  108. package/.docs/raw/reference/ai-sdk/handle-chat-stream.mdx +1 -1
  109. package/.docs/raw/reference/ai-sdk/handle-network-stream.mdx +1 -1
  110. package/.docs/raw/reference/ai-sdk/handle-workflow-stream.mdx +1 -1
  111. package/.docs/raw/reference/ai-sdk/network-route.mdx +2 -2
  112. package/.docs/raw/reference/ai-sdk/to-ai-sdk-stream.mdx +6 -6
  113. package/.docs/raw/reference/ai-sdk/to-ai-sdk-v4-messages.mdx +3 -3
  114. package/.docs/raw/reference/ai-sdk/to-ai-sdk-v5-messages.mdx +3 -3
  115. package/.docs/raw/reference/ai-sdk/with-mastra.mdx +1 -1
  116. package/.docs/raw/reference/ai-sdk/workflow-route.mdx +2 -2
  117. package/.docs/raw/reference/auth/auth0.mdx +1 -2
  118. package/.docs/raw/reference/auth/clerk.mdx +1 -2
  119. package/.docs/raw/reference/auth/firebase.mdx +2 -4
  120. package/.docs/raw/reference/auth/jwt.mdx +1 -2
  121. package/.docs/raw/reference/auth/supabase.mdx +1 -2
  122. package/.docs/raw/reference/auth/workos.mdx +1 -2
  123. package/.docs/raw/reference/cli/create-mastra.mdx +10 -10
  124. package/.docs/raw/reference/cli/mastra.mdx +9 -9
  125. package/.docs/raw/reference/client-js/agents.mdx +1 -2
  126. package/.docs/raw/reference/client-js/mastra-client.mdx +1 -1
  127. package/.docs/raw/reference/core/getAgent.mdx +1 -1
  128. package/.docs/raw/reference/core/getAgentById.mdx +1 -1
  129. package/.docs/raw/reference/core/getDeployer.mdx +1 -1
  130. package/.docs/raw/reference/core/getLogger.mdx +1 -1
  131. package/.docs/raw/reference/core/getMCPServer.mdx +1 -1
  132. package/.docs/raw/reference/core/getMCPServerById.mdx +1 -1
  133. package/.docs/raw/reference/core/getMemory.mdx +2 -2
  134. package/.docs/raw/reference/core/getServer.mdx +1 -1
  135. package/.docs/raw/reference/core/getStorage.mdx +2 -2
  136. package/.docs/raw/reference/core/getStoredAgentById.mdx +3 -3
  137. package/.docs/raw/reference/core/getTelemetry.mdx +1 -1
  138. package/.docs/raw/reference/core/getVector.mdx +1 -1
  139. package/.docs/raw/reference/core/getWorkflow.mdx +1 -1
  140. package/.docs/raw/reference/core/listAgents.mdx +1 -1
  141. package/.docs/raw/reference/core/listLogs.mdx +1 -1
  142. package/.docs/raw/reference/core/listLogsByRunId.mdx +1 -1
  143. package/.docs/raw/reference/core/listMCPServers.mdx +1 -1
  144. package/.docs/raw/reference/core/listMemory.mdx +2 -2
  145. package/.docs/raw/reference/core/listStoredAgents.mdx +4 -4
  146. package/.docs/raw/reference/core/listVectors.mdx +1 -1
  147. package/.docs/raw/reference/core/listWorkflows.mdx +1 -1
  148. package/.docs/raw/reference/core/setLogger.mdx +1 -1
  149. package/.docs/raw/reference/core/setStorage.mdx +2 -2
  150. package/.docs/raw/reference/core/setTelemetry.mdx +1 -1
  151. package/.docs/raw/reference/deployer/cloudflare.mdx +1 -2
  152. package/.docs/raw/reference/deployer/deployer.mdx +0 -1
  153. package/.docs/raw/reference/deployer/netlify.mdx +1 -1
  154. package/.docs/raw/reference/deployer/vercel.mdx +2 -4
  155. package/.docs/raw/reference/evals/answer-relevancy.mdx +1 -1
  156. package/.docs/raw/reference/evals/answer-similarity.mdx +1 -1
  157. package/.docs/raw/reference/evals/bias.mdx +1 -1
  158. package/.docs/raw/reference/evals/completeness.mdx +1 -1
  159. package/.docs/raw/reference/evals/content-similarity.mdx +1 -1
  160. package/.docs/raw/reference/evals/context-precision.mdx +1 -1
  161. package/.docs/raw/reference/evals/faithfulness.mdx +1 -1
  162. package/.docs/raw/reference/evals/hallucination.mdx +1 -1
  163. package/.docs/raw/reference/evals/keyword-coverage.mdx +1 -1
  164. package/.docs/raw/reference/evals/prompt-alignment.mdx +7 -7
  165. package/.docs/raw/reference/evals/textual-difference.mdx +1 -1
  166. package/.docs/raw/reference/evals/tone-consistency.mdx +1 -1
  167. package/.docs/raw/reference/evals/tool-call-accuracy.mdx +10 -10
  168. package/.docs/raw/reference/evals/toxicity.mdx +1 -1
  169. package/.docs/raw/reference/logging/pino-logger.mdx +6 -7
  170. package/.docs/raw/reference/memory/createThread.mdx +2 -2
  171. package/.docs/raw/reference/memory/deleteMessages.mdx +2 -2
  172. package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +2 -2
  173. package/.docs/raw/reference/memory/memory-class.mdx +3 -3
  174. package/.docs/raw/reference/memory/query.mdx +2 -2
  175. package/.docs/raw/reference/memory/recall.mdx +2 -2
  176. package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx +1 -1
  177. package/.docs/raw/reference/processors/batch-parts-processor.mdx +2 -2
  178. package/.docs/raw/reference/processors/language-detector.mdx +2 -2
  179. package/.docs/raw/reference/processors/message-history-processor.mdx +2 -2
  180. package/.docs/raw/reference/processors/moderation-processor.mdx +3 -3
  181. package/.docs/raw/reference/processors/pii-detector.mdx +3 -3
  182. package/.docs/raw/reference/processors/processor-interface.mdx +13 -13
  183. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +2 -2
  184. package/.docs/raw/reference/processors/semantic-recall-processor.mdx +2 -2
  185. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +2 -2
  186. package/.docs/raw/reference/processors/token-limiter-processor.mdx +2 -2
  187. package/.docs/raw/reference/processors/tool-call-filter.mdx +3 -3
  188. package/.docs/raw/reference/processors/unicode-normalizer.mdx +2 -2
  189. package/.docs/raw/reference/processors/working-memory-processor.mdx +3 -3
  190. package/.docs/raw/reference/rag/chunk.mdx +1 -1
  191. package/.docs/raw/reference/rag/extract-params.mdx +2 -2
  192. package/.docs/raw/reference/rag/metadata-filters.mdx +7 -7
  193. package/.docs/raw/reference/server/create-route.mdx +13 -13
  194. package/.docs/raw/reference/server/express-adapter.mdx +6 -7
  195. package/.docs/raw/reference/server/hono-adapter.mdx +6 -7
  196. package/.docs/raw/reference/server/mastra-server.mdx +20 -20
  197. package/.docs/raw/reference/storage/cloudflare-d1.mdx +3 -3
  198. package/.docs/raw/reference/storage/cloudflare.mdx +2 -2
  199. package/.docs/raw/reference/storage/convex.mdx +6 -6
  200. package/.docs/raw/reference/storage/dynamodb.mdx +4 -4
  201. package/.docs/raw/reference/storage/lance.mdx +3 -3
  202. package/.docs/raw/reference/storage/libsql.mdx +69 -54
  203. package/.docs/raw/reference/storage/mongodb.mdx +80 -7
  204. package/.docs/raw/reference/storage/mssql.mdx +4 -4
  205. package/.docs/raw/{memory → reference}/storage/overview.mdx +12 -110
  206. package/.docs/raw/reference/storage/postgresql.mdx +78 -7
  207. package/.docs/raw/reference/storage/upstash.mdx +74 -2
  208. package/.docs/raw/reference/streaming/agents/stream.mdx +5 -5
  209. package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +2 -2
  210. package/.docs/raw/reference/streaming/workflows/observeStream.mdx +1 -1
  211. package/.docs/raw/reference/streaming/workflows/resumeStream.mdx +1 -1
  212. package/.docs/raw/reference/streaming/workflows/stream.mdx +2 -2
  213. package/.docs/raw/reference/streaming/workflows/timeTravelStream.mdx +4 -4
  214. package/.docs/raw/reference/templates/overview.mdx +1 -2
  215. package/.docs/raw/reference/tools/create-tool.mdx +1 -4
  216. package/.docs/raw/reference/tools/vector-query-tool.mdx +1 -1
  217. package/.docs/raw/reference/vectors/astra.mdx +3 -3
  218. package/.docs/raw/reference/vectors/chroma.mdx +3 -3
  219. package/.docs/raw/reference/vectors/convex.mdx +12 -12
  220. package/.docs/raw/reference/vectors/couchbase.mdx +5 -5
  221. package/.docs/raw/reference/vectors/duckdb.mdx +10 -10
  222. package/.docs/raw/reference/vectors/elasticsearch.mdx +4 -4
  223. package/.docs/raw/reference/vectors/lance.mdx +4 -4
  224. package/.docs/raw/reference/vectors/libsql.mdx +61 -11
  225. package/.docs/raw/reference/vectors/mongodb.mdx +58 -5
  226. package/.docs/raw/reference/vectors/pg.mdx +53 -6
  227. package/.docs/raw/reference/vectors/pinecone.mdx +3 -3
  228. package/.docs/raw/reference/vectors/qdrant.mdx +3 -3
  229. package/.docs/raw/reference/vectors/s3vectors.mdx +6 -6
  230. package/.docs/raw/reference/vectors/turbopuffer.mdx +4 -4
  231. package/.docs/raw/reference/vectors/upstash.mdx +55 -6
  232. package/.docs/raw/reference/vectors/vectorize.mdx +3 -3
  233. package/.docs/raw/reference/workflows/run-methods/cancel.mdx +2 -2
  234. package/.docs/raw/reference/workflows/run-methods/restart.mdx +1 -3
  235. package/.docs/raw/reference/workflows/run-methods/resume.mdx +2 -2
  236. package/.docs/raw/reference/workflows/run-methods/start.mdx +2 -2
  237. package/.docs/raw/reference/workflows/run-methods/startAsync.mdx +2 -2
  238. package/.docs/raw/reference/workflows/run-methods/timeTravel.mdx +5 -5
  239. package/.docs/raw/reference/workflows/run.mdx +1 -1
  240. package/.docs/raw/reference/workflows/step.mdx +3 -3
  241. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +1 -1
  242. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
  243. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +3 -3
  244. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
  245. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
  246. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +6 -6
  247. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +7 -7
  248. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
  249. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +2 -2
  250. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +2 -2
  251. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +2 -2
  252. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
  253. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +2 -2
  254. package/.docs/raw/reference/workflows/workflow.mdx +3 -3
  255. package/.docs/raw/server/auth/auth0.mdx +20 -14
  256. package/.docs/raw/server/auth/clerk.mdx +16 -9
  257. package/.docs/raw/server/auth/firebase.mdx +21 -15
  258. package/.docs/raw/server/auth/jwt.mdx +14 -7
  259. package/.docs/raw/server/auth/supabase.mdx +16 -9
  260. package/.docs/raw/server/auth/workos.mdx +19 -13
  261. package/.docs/raw/server/custom-adapters.mdx +10 -10
  262. package/.docs/raw/server/custom-api-routes.mdx +2 -4
  263. package/.docs/raw/server/mastra-client.mdx +24 -13
  264. package/.docs/raw/server/mastra-server.mdx +3 -3
  265. package/.docs/raw/server/middleware.mdx +7 -7
  266. package/.docs/raw/server/request-context.mdx +31 -30
  267. package/.docs/raw/server/server-adapters.mdx +6 -6
  268. package/.docs/raw/streaming/events.mdx +14 -7
  269. package/.docs/raw/streaming/overview.mdx +21 -10
  270. package/.docs/raw/streaming/tool-streaming.mdx +6 -6
  271. package/.docs/raw/streaming/workflow-streaming.mdx +6 -8
  272. package/.docs/raw/tools-mcp/advanced-usage.mdx +2 -2
  273. package/.docs/raw/tools-mcp/mcp-overview.mdx +31 -12
  274. package/.docs/raw/tools-mcp/overview.mdx +9 -10
  275. package/.docs/raw/voice/overview.mdx +1 -1
  276. package/.docs/raw/workflows/agents-and-tools.mdx +28 -19
  277. package/.docs/raw/workflows/control-flow.mdx +27 -40
  278. package/.docs/raw/workflows/error-handling.mdx +15 -22
  279. package/.docs/raw/workflows/human-in-the-loop.mdx +6 -7
  280. package/.docs/raw/workflows/inngest-workflow.mdx +8 -9
  281. package/.docs/raw/workflows/input-data-mapping.mdx +7 -7
  282. package/.docs/raw/workflows/overview.mdx +33 -22
  283. package/.docs/raw/workflows/snapshots.mdx +14 -44
  284. package/.docs/raw/workflows/suspend-and-resume.mdx +7 -7
  285. package/.docs/raw/workflows/time-travel.mdx +16 -16
  286. package/.docs/raw/workflows/workflow-state.mdx +5 -8
  287. package/CHANGELOG.md +9 -0
  288. package/dist/logger.d.ts +3 -0
  289. package/dist/logger.d.ts.map +1 -1
  290. package/dist/stdio.js +53 -0
  291. package/package.json +4 -4
  292. package/.docs/raw/memory/conversation-history.mdx +0 -24
  293. package/.docs/raw/memory/storage/memory-with-libsql.mdx +0 -140
  294. package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -150
  295. package/.docs/raw/memory/storage/memory-with-pg.mdx +0 -138
  296. package/.docs/raw/memory/storage/memory-with-upstash.mdx +0 -146
  297. package/.docs/raw/memory/threads-and-resources.mdx +0 -95
@@ -25,7 +25,7 @@ For general adapter concepts (constructor options, initialization flow, etc.), s
25
25
 
26
26
  Install the Hono adapter and Hono framework:
27
27
 
28
- ```bash copy
28
+ ```bash
29
29
  npm install @mastra/hono@beta hono
30
30
  ```
31
31
 
@@ -35,7 +35,7 @@ npm install @mastra/hono@beta hono
35
35
 
36
36
  Create your server file:
37
37
 
38
- ```typescript title="server.ts" copy
38
+ ```typescript title="server.ts"
39
39
  import { Hono } from 'hono';
40
40
  import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
41
41
  import { mastra } from './mastra';
@@ -54,7 +54,7 @@ export default app;
54
54
 
55
55
  ## Full example
56
56
 
57
- ```typescript title="server.ts" copy
57
+ ```typescript title="server.ts"
58
58
  import { Hono } from 'hono';
59
59
  import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
60
60
  import { mastra } from './mastra';
@@ -147,7 +147,7 @@ export default app;
147
147
 
148
148
  Add routes directly to the Hono app:
149
149
 
150
- ```typescript title="server.ts" copy
150
+ ```typescript title="server.ts"
151
151
  import { Hono } from 'hono';
152
152
  import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
153
153
 
@@ -176,7 +176,7 @@ Routes added before `init()` run without Mastra context. Add routes after `init(
176
176
 
177
177
  In Hono middleware and route handlers, access Mastra context via `c.get()`:
178
178
 
179
- ```typescript copy
179
+ ```typescript
180
180
  app.get('/custom', async (c) => {
181
181
  const mastra = c.get('mastra');
182
182
  const requestContext = c.get('requestContext');
@@ -203,7 +203,7 @@ Available context keys:
203
203
 
204
204
  Add Hono middleware before or after `init()`:
205
205
 
206
- ```typescript title="server.ts" copy
206
+ ```typescript title="server.ts"
207
207
  import { Hono } from 'hono';
208
208
  import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
209
209
 
@@ -221,7 +221,6 @@ await server.init();
221
221
  // Middleware after init has access to Mastra context
222
222
  app.use('*', async (c, next) => {
223
223
  const mastra = c.get('mastra');
224
- // ...
225
224
  await next();
226
225
  });
227
226
  ```
@@ -11,13 +11,13 @@ The `MastraServer` abstract class is the base for all server adapters. Extend th
11
11
 
12
12
  ## Import
13
13
 
14
- ```typescript copy
14
+ ```typescript
15
15
  import { MastraServer } from '@mastra/server/server-adapter';
16
16
  ```
17
17
 
18
18
  ## Type parameters
19
19
 
20
- ```typescript copy
20
+ ```typescript
21
21
  MastraServer<TApp, TRequest, TResponse>
22
22
  ```
23
23
 
@@ -29,7 +29,7 @@ MastraServer<TApp, TRequest, TResponse>
29
29
 
30
30
  ## Constructor
31
31
 
32
- ```typescript copy
32
+ ```typescript
33
33
  constructor(options: MastraServerOptions<TApp>)
34
34
  ```
35
35
 
@@ -119,7 +119,7 @@ These methods must be implemented by adapters:
119
119
 
120
120
  Attach Mastra context to every request.
121
121
 
122
- ```typescript copy
122
+ ```typescript
123
123
  abstract registerContextMiddleware(): void
124
124
  ```
125
125
 
@@ -133,7 +133,7 @@ abstract registerContextMiddleware(): void
133
133
 
134
134
  Register authentication and authorization middleware.
135
135
 
136
- ```typescript copy
136
+ ```typescript
137
137
  abstract registerAuthMiddleware(): void
138
138
  ```
139
139
 
@@ -141,7 +141,7 @@ abstract registerAuthMiddleware(): void
141
141
 
142
142
  Register a single route with the framework.
143
143
 
144
- ```typescript copy
144
+ ```typescript
145
145
  abstract registerRoute(
146
146
  app: TApp,
147
147
  route: ServerRoute,
@@ -153,7 +153,7 @@ abstract registerRoute(
153
153
 
154
154
  Extract parameters from the request.
155
155
 
156
- ```typescript copy
156
+ ```typescript
157
157
  abstract getParams(
158
158
  route: ServerRoute,
159
159
  request: TRequest
@@ -168,7 +168,7 @@ abstract getParams(
168
168
 
169
169
  Send response based on route type.
170
170
 
171
- ```typescript copy
171
+ ```typescript
172
172
  abstract sendResponse(
173
173
  route: ServerRoute,
174
174
  response: TResponse,
@@ -180,7 +180,7 @@ abstract sendResponse(
180
180
 
181
181
  Handle streaming responses.
182
182
 
183
- ```typescript copy
183
+ ```typescript
184
184
  abstract stream(
185
185
  route: ServerRoute,
186
186
  response: TResponse,
@@ -194,7 +194,7 @@ abstract stream(
194
194
 
195
195
  Initialize the server by registering all middleware and routes.
196
196
 
197
- ```typescript copy
197
+ ```typescript
198
198
  async init(): Promise<void>
199
199
  ```
200
200
 
@@ -207,7 +207,7 @@ Calls in order:
207
207
 
208
208
  Register all Mastra routes.
209
209
 
210
- ```typescript copy
210
+ ```typescript
211
211
  async registerRoutes(): Promise<void>
212
212
  ```
213
213
 
@@ -215,7 +215,7 @@ async registerRoutes(): Promise<void>
215
215
 
216
216
  Get the framework app instance.
217
217
 
218
- ```typescript copy
218
+ ```typescript
219
219
  getApp<T = TApp>(): T
220
220
  ```
221
221
 
@@ -223,7 +223,7 @@ getApp<T = TApp>(): T
223
223
 
224
224
  Validate path parameters with the route's Zod schema.
225
225
 
226
- ```typescript copy
226
+ ```typescript
227
227
  async parsePathParams(
228
228
  route: ServerRoute,
229
229
  params: Record<string, string>
@@ -234,7 +234,7 @@ async parsePathParams(
234
234
 
235
235
  Validate query parameters with the route's Zod schema.
236
236
 
237
- ```typescript copy
237
+ ```typescript
238
238
  async parseQueryParams(
239
239
  route: ServerRoute,
240
240
  params: Record<string, string>
@@ -245,7 +245,7 @@ async parseQueryParams(
245
245
 
246
246
  Validate request body with the route's Zod schema.
247
247
 
248
- ```typescript copy
248
+ ```typescript
249
249
  async parseBody(
250
250
  route: ServerRoute,
251
251
  body: unknown
@@ -256,7 +256,7 @@ async parseBody(
256
256
 
257
257
  Register an endpoint that serves the OpenAPI specification.
258
258
 
259
- ```typescript copy
259
+ ```typescript
260
260
  async registerOpenAPIRoute(
261
261
  app: TApp,
262
262
  config: OpenAPIConfig,
@@ -270,7 +270,7 @@ async registerOpenAPIRoute(
270
270
 
271
271
  Merge request context from multiple sources (query params and body).
272
272
 
273
- ```typescript copy
273
+ ```typescript
274
274
  protected mergeRequestContext(options: {
275
275
  paramsRequestContext?: Record<string, any>;
276
276
  bodyRequestContext?: Record<string, any>;
@@ -281,7 +281,7 @@ protected mergeRequestContext(options: {
281
281
 
282
282
  ### BodyLimitOptions
283
283
 
284
- ```typescript copy
284
+ ```typescript
285
285
  interface BodyLimitOptions {
286
286
  maxSize: number;
287
287
  onError: (error: unknown) => unknown;
@@ -290,7 +290,7 @@ interface BodyLimitOptions {
290
290
 
291
291
  ### StreamOptions
292
292
 
293
- ```typescript copy
293
+ ```typescript
294
294
  interface StreamOptions {
295
295
  redact?: boolean;
296
296
  }
@@ -298,7 +298,7 @@ interface StreamOptions {
298
298
 
299
299
  ## Example
300
300
 
301
- ```typescript copy
301
+ ```typescript
302
302
  import { MastraServer, ServerRoute } from '@mastra/server/server-adapter';
303
303
  import type { Mastra } from '@mastra/core';
304
304
 
@@ -15,7 +15,7 @@ npm install @mastra/cloudflare-d1@beta
15
15
 
16
16
  ## Usage
17
17
 
18
- ```typescript copy showLineNumbers
18
+ ```typescript
19
19
  import { D1Store } from "@mastra/cloudflare-d1";
20
20
 
21
21
  type Env = {
@@ -99,7 +99,7 @@ The storage implementation handles schema creation and updates automatically. It
99
99
 
100
100
  When you pass storage to the Mastra class, `init()` is called automatically before any storage operation:
101
101
 
102
- ```typescript copy
102
+ ```typescript
103
103
  import { Mastra } from "@mastra/core";
104
104
  import { D1Store } from "@mastra/cloudflare-d1";
105
105
 
@@ -114,7 +114,7 @@ const mastra = new Mastra({
114
114
 
115
115
  If you're using storage directly without Mastra, you must call `init()` explicitly to create the tables:
116
116
 
117
- ```typescript copy
117
+ ```typescript
118
118
  import { D1Store } from "@mastra/cloudflare-d1";
119
119
 
120
120
  const storage = new D1Store({
@@ -9,13 +9,13 @@ The Cloudflare KV storage implementation provides a globally distributed, server
9
9
 
10
10
  ## Installation
11
11
 
12
- ```bash copy
12
+ ```bash
13
13
  npm install @mastra/cloudflare@beta
14
14
  ```
15
15
 
16
16
  ## Usage
17
17
 
18
- ```typescript copy showLineNumbers
18
+ ```typescript
19
19
  import { CloudflareStore } from "@mastra/cloudflare";
20
20
 
21
21
  // --- Example 1: Using Workers Binding ---
@@ -9,7 +9,7 @@ The Convex storage implementation provides a serverless storage solution using [
9
9
 
10
10
  ## Installation
11
11
 
12
- ```bash copy
12
+ ```bash
13
13
  npm install @mastra/convex@beta
14
14
  ```
15
15
 
@@ -21,7 +21,7 @@ Before using `ConvexStore`, you need to set up the Convex schema and storage han
21
21
 
22
22
  In `convex/schema.ts`:
23
23
 
24
- ```typescript copy
24
+ ```typescript
25
25
  import { defineSchema } from 'convex/server';
26
26
  import {
27
27
  mastraThreadsTable,
@@ -32,7 +32,7 @@ import {
32
32
  mastraVectorIndexesTable,
33
33
  mastraVectorsTable,
34
34
  mastraDocumentsTable,
35
- } from '@mastra/convex/server';
35
+ } from '@mastra/convex/schema';
36
36
 
37
37
  export default defineSchema({
38
38
  mastra_threads: mastraThreadsTable,
@@ -50,7 +50,7 @@ export default defineSchema({
50
50
 
51
51
  In `convex/mastra/storage.ts`:
52
52
 
53
- ```typescript copy
53
+ ```typescript
54
54
  import { mastraStorage } from '@mastra/convex/server';
55
55
 
56
56
  export const handle = mastraStorage;
@@ -58,7 +58,7 @@ export const handle = mastraStorage;
58
58
 
59
59
  ### 3. Deploy to Convex
60
60
 
61
- ```bash copy
61
+ ```bash
62
62
  npx convex dev
63
63
  # or for production
64
64
  npx convex deploy
@@ -66,7 +66,7 @@ npx convex deploy
66
66
 
67
67
  ## Usage
68
68
 
69
- ```typescript copy showLineNumbers
69
+ ```typescript
70
70
  import { ConvexStore } from "@mastra/convex";
71
71
 
72
72
  const storage = new ConvexStore({
@@ -18,7 +18,7 @@ The DynamoDB storage implementation provides a scalable and performant NoSQL dat
18
18
 
19
19
  ## Installation
20
20
 
21
- ```bash copy
21
+ ```bash
22
22
  npm install @mastra/dynamodb@beta
23
23
  # or
24
24
  pnpm add @mastra/dynamodb@beta
@@ -36,7 +36,7 @@ Detailed instructions for setting up the table using AWS CloudFormation or AWS C
36
36
 
37
37
  ### Basic Usage
38
38
 
39
- ```typescript copy showLineNumbers
39
+ ```typescript
40
40
  import { Memory } from "@mastra/memory";
41
41
  import { DynamoDBStore } from "@mastra/dynamodb";
42
42
 
@@ -72,7 +72,7 @@ For local development, you can use [DynamoDB Local](https://docs.aws.amazon.com/
72
72
 
73
73
  2. **Configure `DynamoDBStore` to use the local endpoint:**
74
74
 
75
- ```typescript copy showLineNumbers
75
+ ```typescript copy
76
76
  import { DynamoDBStore } from "@mastra/dynamodb";
77
77
 
78
78
  const storage = new DynamoDBStore({
@@ -134,7 +134,7 @@ For local development, you can use [DynamoDB Local](https://docs.aws.amazon.com/
134
134
 
135
135
  The IAM role or user executing the code needs appropriate permissions to interact with the specified DynamoDB table and its indexes. Below is a sample policy. Replace `${YOUR_TABLE_NAME}` with your actual table name and `${YOUR_AWS_REGION}` and `${YOUR_AWS_ACCOUNT_ID}` with appropriate values.
136
136
 
137
- ```json copy
137
+ ```json
138
138
  {
139
139
  "Version": "2012-10-17",
140
140
  "Statement": [
@@ -17,7 +17,7 @@ npm install @mastra/lance@beta
17
17
 
18
18
  ### Basic Storage Usage
19
19
 
20
- ```typescript copy showLineNumbers
20
+ ```typescript
21
21
  import { LanceStorage } from "@mastra/lance";
22
22
 
23
23
  // Connect to a local database
@@ -77,7 +77,7 @@ The LanceStorage implementation automatically handles schema creation and update
77
77
 
78
78
  When you pass storage to the Mastra class, `init()` is called automatically before any storage operation:
79
79
 
80
- ```typescript copy
80
+ ```typescript
81
81
  import { Mastra } from "@mastra/core";
82
82
  import { LanceStorage } from "@mastra/lance";
83
83
 
@@ -90,7 +90,7 @@ const mastra = new Mastra({
90
90
 
91
91
  If you're using storage directly without Mastra, you must call `init()` explicitly to create the tables:
92
92
 
93
- ```typescript copy
93
+ ```typescript
94
94
  import { LanceStorage } from "@mastra/lance";
95
95
 
96
96
  const storage = await LanceStorage.create("my-storage", "/path/to/db");
@@ -1,37 +1,81 @@
1
1
  ---
2
- title: "Reference: LibSQL Storage | Storage"
3
- description: Documentation for the LibSQL storage implementation in Mastra.
2
+ title: "Reference: libSQL Storage | Storage"
3
+ description: Documentation for the libSQL storage implementation in Mastra.
4
4
  ---
5
5
 
6
- # LibSQL Storage
6
+ # libSQL Storage
7
7
 
8
- The LibSQL storage implementation provides a SQLite-compatible storage solution that can run both in-memory and as a persistent database.
8
+ [libSQL](https://docs.turso.tech/libsql) is an open-source, SQLite-compatible database that supports both local and remote deployments. It can be used to store message history, workflow snapshots, traces, and eval scores.
9
+
10
+ For vectors like semantic recall or traditional RAG, use [libSQL Vector](/reference/v1/vectors/libsql) which covers embeddings and vector search.
9
11
 
10
12
  ## Installation
11
13
 
12
- ```bash copy
14
+ Storage providers must be installed as separate packages:
15
+
16
+ ```bash
13
17
  npm install @mastra/libsql@beta
14
18
  ```
15
19
 
16
20
  ## Usage
17
21
 
18
- ```typescript copy showLineNumbers
22
+ ```typescript
19
23
  import { LibSQLStore } from "@mastra/libsql";
24
+ import { Mastra } from "@mastra/core";
20
25
 
21
- // File database (development)
22
- const storage = new LibSQLStore({
23
- id: 'libsql-storage',
24
- url: "file:./storage.db",
26
+ const mastra = new Mastra({
27
+ storage: new LibSQLStore({
28
+ id: 'libsql-storage',
29
+ url: "file:./storage.db",
30
+ }),
25
31
  });
32
+ ```
26
33
 
27
- // Persistent database (production)
28
- const storage = new LibSQLStore({
29
- id: 'libsql-storage',
30
- url: process.env.DATABASE_URL,
34
+ Agent-level file storage:
35
+
36
+ ```typescript
37
+ import { Memory } from "@mastra/memory";
38
+ import { Agent } from "@mastra/core/agent";
39
+ import { LibSQLStore } from "@mastra/libsql";
40
+
41
+ export const agent = new Agent({
42
+ id: "example-agent",
43
+ memory: new Memory({
44
+ storage: new LibSQLStore({
45
+ id: 'libsql-storage',
46
+ url: "file:./agent.db",
47
+ }),
48
+ }),
31
49
  });
32
50
  ```
33
51
 
34
- ## Parameters
52
+ :::warning
53
+ File storage doesn't work with serverless platforms that have ephemeral file systems. For serverless deployments, use [Turso](https://turso.tech) or a different database engine.
54
+ :::
55
+
56
+ Production with remote database:
57
+
58
+ ```typescript
59
+ storage: new LibSQLStore({
60
+ id: 'libsql-storage',
61
+ url: "libsql://your-db-name.aws-ap-northeast-1.turso.io",
62
+ authToken: process.env.TURSO_AUTH_TOKEN,
63
+ })
64
+ ```
65
+
66
+ For local development and testing, you can store data in memory:
67
+
68
+ ```typescript
69
+ storage: new LibSQLStore({
70
+ id: 'libsql-storage',
71
+ url: ":memory:",
72
+ })
73
+ ```
74
+ :::warning
75
+ In-memory storage resets when the process changes. Only suitable for development.
76
+ :::
77
+
78
+ ## Options
35
79
 
36
80
  <PropertiesTable
37
81
  content={[
@@ -39,75 +83,46 @@ const storage = new LibSQLStore({
39
83
  name: "url",
40
84
  type: "string",
41
85
  description:
42
- "Database URL. Use ':memory:' for in-memory database, 'file:filename.db' for a file database, or any LibSQL-compatible connection string for persistent storage.",
86
+ "Database URL. Use `:memory:` for in-memory database, `file:filename.db` for a file database, or a libSQL connection string (e.g., `libsql://your-database.turso.io`) for remote storage.",
43
87
  isOptional: false,
44
88
  },
45
89
  {
46
90
  name: "authToken",
47
91
  type: "string",
48
- description: "Authentication token for remote LibSQL databases.",
92
+ description: "Authentication token for remote libSQL databases.",
49
93
  isOptional: true,
50
94
  },
51
95
  ]}
52
96
  />
53
97
 
54
- ## Additional Notes
55
-
56
- ### In-Memory vs Persistent Storage
57
-
58
- The file configuration (`file:storage.db`) is useful for:
59
-
60
- - Development and testing
61
- - Temporary storage
62
- - Quick prototyping
63
-
64
- For production use cases, use a persistent database URL: `libsql://your-database.turso.io`
98
+ ## Initialization
65
99
 
66
- ### Schema Management
100
+ When you pass storage to the Mastra class, `init()` is called automatically to create the [core schema](/reference/v1/storage/overview#core-schema):
67
101
 
68
- The storage implementation handles schema creation and updates automatically. It creates the following tables:
69
-
70
- - `mastra_workflow_snapshot`: Stores workflow state and execution data
71
- - `mastra_evals`: Stores evaluation results and metadata
72
- - `mastra_threads`: Stores conversation threads
73
- - `mastra_messages`: Stores individual messages
74
- - `mastra_traces`: Stores telemetry and tracing data
75
- - `mastra_scorers`: Stores scoring and evaluation data
76
- - `mastra_resources`: Stores resource working memory data
77
-
78
- ### Initialization
79
-
80
- When you pass storage to the Mastra class, `init()` is called automatically before any storage operation:
81
-
82
- ```typescript copy
102
+ ```typescript
83
103
  import { Mastra } from "@mastra/core";
84
104
  import { LibSQLStore } from "@mastra/libsql";
85
105
 
86
106
  const storage = new LibSQLStore({
107
+ id: 'libsql-storage',
87
108
  url: "file:./storage.db",
88
109
  });
89
110
 
90
111
  const mastra = new Mastra({
91
- storage, // init() is called automatically
112
+ storage, // init() called automatically
92
113
  });
93
114
  ```
94
115
 
95
- If you're using storage directly without Mastra, you must call `init()` explicitly to create the tables:
116
+ If using storage directly without Mastra, call `init()` explicitly:
96
117
 
97
- ```typescript copy
118
+ ```typescript
98
119
  import { LibSQLStore } from "@mastra/libsql";
99
120
 
100
121
  const storage = new LibSQLStore({
122
+ id: 'libsql-storage',
101
123
  url: "file:./storage.db",
102
124
  });
103
125
 
104
- // Required when using storage directly
105
126
  await storage.init();
106
-
107
- // Now you can use the storage
108
127
  await storage.getThread({ threadId: "..." });
109
128
  ```
110
-
111
- :::warning
112
- If `init()` is not called, tables won't be created and storage operations will fail silently or throw errors.
113
- :::