@mastra/mcp-docs-server 0.13.2-alpha.0 → 0.13.2-alpha.2

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 (115) hide show
  1. package/.docs/organized/changelogs/%40mastra%2Fagui.md +12 -0
  2. package/.docs/organized/changelogs/%40mastra%2Fastra.md +25 -25
  3. package/.docs/organized/changelogs/%40mastra%2Fchroma.md +25 -25
  4. package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +26 -26
  5. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +32 -32
  6. package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +25 -25
  7. package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +26 -26
  8. package/.docs/organized/changelogs/%40mastra%2Fcore.md +26 -26
  9. package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +14 -14
  10. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +40 -40
  11. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +44 -44
  12. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +42 -42
  13. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +45 -45
  14. package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +27 -27
  15. package/.docs/organized/changelogs/%40mastra%2Fevals.md +13 -13
  16. package/.docs/organized/changelogs/%40mastra%2Ffirecrawl.md +16 -16
  17. package/.docs/organized/changelogs/%40mastra%2Fgithub.md +13 -13
  18. package/.docs/organized/changelogs/%40mastra%2Flance.md +25 -0
  19. package/.docs/organized/changelogs/%40mastra%2Flibsql.md +28 -28
  20. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +30 -30
  21. package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +16 -16
  22. package/.docs/organized/changelogs/%40mastra%2Fmcp.md +24 -24
  23. package/.docs/organized/changelogs/%40mastra%2Fmem0.md +13 -13
  24. package/.docs/organized/changelogs/%40mastra%2Fmemory.md +35 -35
  25. package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +28 -28
  26. package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +24 -0
  27. package/.docs/organized/changelogs/%40mastra%2Fpg.md +28 -28
  28. package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +14 -14
  29. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +38 -38
  30. package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +14 -14
  31. package/.docs/organized/changelogs/%40mastra%2Frag.md +14 -14
  32. package/.docs/organized/changelogs/%40mastra%2Fragie.md +13 -13
  33. package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +6 -0
  34. package/.docs/organized/changelogs/%40mastra%2Fserver.md +32 -32
  35. package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +14 -14
  36. package/.docs/organized/changelogs/%40mastra%2Fupstash.md +26 -26
  37. package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +14 -14
  38. package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +13 -13
  39. package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +14 -14
  40. package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +14 -14
  41. package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +12 -0
  42. package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +14 -14
  43. package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +13 -13
  44. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +14 -14
  45. package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +13 -13
  46. package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +13 -13
  47. package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +14 -14
  48. package/.docs/organized/changelogs/create-mastra.md +7 -7
  49. package/.docs/organized/changelogs/mastra.md +48 -48
  50. package/.docs/organized/code-examples/a2a.md +1 -1
  51. package/.docs/organized/code-examples/agent-network.md +125 -7
  52. package/.docs/organized/code-examples/agent.md +183 -6
  53. package/.docs/organized/code-examples/agui.md +4 -4
  54. package/.docs/organized/code-examples/ai-sdk-useChat.md +6 -6
  55. package/.docs/organized/code-examples/assistant-ui.md +6 -6
  56. package/.docs/organized/code-examples/bird-checker-with-express.md +1 -1
  57. package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +6 -6
  58. package/.docs/organized/code-examples/bird-checker-with-nextjs.md +6 -6
  59. package/.docs/organized/code-examples/client-side-tools.md +6 -6
  60. package/.docs/organized/code-examples/crypto-chatbot.md +6 -6
  61. package/.docs/organized/code-examples/experimental-auth-weather-agent.md +1 -1
  62. package/.docs/organized/code-examples/fireworks-r1.md +1 -1
  63. package/.docs/organized/code-examples/mcp-configuration.md +2 -2
  64. package/.docs/organized/code-examples/mcp-registry-registry.md +1 -1
  65. package/.docs/organized/code-examples/memory-per-resource-example.md +236 -0
  66. package/.docs/organized/code-examples/memory-with-mem0.md +1 -1
  67. package/.docs/organized/code-examples/memory-with-processors.md +1 -1
  68. package/.docs/organized/code-examples/openapi-spec-writer.md +6 -6
  69. package/.docs/organized/code-examples/quick-start.md +1 -1
  70. package/.docs/organized/code-examples/stock-price-tool.md +1 -1
  71. package/.docs/organized/code-examples/weather-agent.md +1 -1
  72. package/.docs/organized/code-examples/workflow-ai-recruiter.md +1 -1
  73. package/.docs/organized/code-examples/workflow-with-inline-steps.md +1 -1
  74. package/.docs/organized/code-examples/workflow-with-memory.md +1 -1
  75. package/.docs/organized/code-examples/workflow-with-separate-steps.md +1 -1
  76. package/.docs/raw/agents/using-tools-and-mcp.mdx +3 -2
  77. package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +111 -0
  78. package/.docs/raw/deployment/cloud-providers/index.mdx +15 -0
  79. package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +53 -10
  80. package/.docs/raw/mastra-cloud/dashboard.mdx +100 -0
  81. package/.docs/raw/mastra-cloud/observability.mdx +24 -138
  82. package/.docs/raw/mastra-cloud/overview.mdx +50 -42
  83. package/.docs/raw/mastra-cloud/setting-up.mdx +51 -87
  84. package/.docs/raw/memory/overview.mdx +4 -0
  85. package/.docs/raw/memory/working-memory.mdx +144 -1
  86. package/.docs/raw/networks-vnext/complex-task-execution.mdx +137 -0
  87. package/.docs/raw/networks-vnext/overview.mdx +85 -0
  88. package/.docs/raw/networks-vnext/single-task-execution.mdx +131 -0
  89. package/.docs/raw/observability/nextjs-tracing.mdx +2 -2
  90. package/.docs/raw/reference/client-js/agents.mdx +41 -0
  91. package/.docs/raw/reference/deployer/netlify.mdx +22 -68
  92. package/.docs/raw/reference/deployer/vercel.mdx +7 -77
  93. package/.docs/raw/reference/storage/libsql.mdx +1 -0
  94. package/.docs/raw/reference/tools/mcp-client.mdx +244 -0
  95. package/.docs/raw/reference/tools/mcp-server.mdx +186 -0
  96. package/.docs/raw/reference/tools/vector-query-tool.mdx +1 -0
  97. package/.docs/raw/reference/workflows/create-run.mdx +1 -1
  98. package/.docs/raw/reference/workflows/resume.mdx +1 -1
  99. package/.docs/raw/reference/workflows/sleep.mdx +43 -0
  100. package/.docs/raw/reference/workflows/sleepUntil.mdx +43 -0
  101. package/.docs/raw/reference/workflows/start.mdx +1 -1
  102. package/.docs/raw/reference/workflows/stream.mdx +1 -1
  103. package/.docs/raw/reference/workflows/waitForEvent.mdx +49 -0
  104. package/.docs/raw/reference/workflows/watch.mdx +1 -1
  105. package/.docs/raw/reference/workflows/workflow.mdx +6 -2
  106. package/.docs/raw/storage/overview.mdx +50 -1
  107. package/.docs/raw/tools-mcp/mcp-overview.mdx +52 -0
  108. package/.docs/raw/workflows/control-flow.mdx +42 -1
  109. package/.docs/raw/workflows/inngest-workflow.mdx +1 -1
  110. package/.docs/raw/workflows/overview.mdx +73 -5
  111. package/.docs/raw/workflows/pausing-execution.mdx +60 -0
  112. package/.docs/raw/workflows/suspend-and-resume.mdx +68 -23
  113. package/.docs/raw/workflows/using-with-agents-and-tools.mdx +1 -1
  114. package/package.json +6 -6
  115. package/.docs/raw/mastra-cloud/deploying.mdx +0 -142
@@ -27,29 +27,26 @@ When running a workflow, its `status` can be one of the following:
27
27
 
28
28
  ## Suspend
29
29
 
30
- When the state is `suspended`, you can identify any and all steps that have been suspended by looking at the `suspended` array of the workflow.
30
+ When the state is `suspended`, you can identify any and all steps that have been suspended by looking at the `suspended` array of the workflow result output.
31
31
 
32
32
  ```typescript {17} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
33
33
  const step1 = createStep({
34
34
  id: "step-1",
35
35
  description: "Test suspend",
36
36
  inputSchema: z.object({
37
- input: z.array(z.string())
38
- }),
39
- resumeSchema: z.object({
40
- city: z.string()
37
+ input: z.string()
41
38
  }),
42
39
  outputSchema: z.object({
43
40
  output: z.string()
44
41
  }),
42
+ suspendSchema: z.object({}),
43
+ resumeSchema: z.object({
44
+ city: z.string()
45
+ }),
45
46
  execute: async ({ resumeData, suspend }) => {
46
- const { city } = resumeData ?? {};
47
-
48
- if (!city) {
47
+ if (!(resumeData ?? {}).city) {
49
48
  await suspend({});
50
- return {
51
- outcome: ""
52
- };
49
+ return { output: "" };
53
50
  }
54
51
 
55
52
  return {
@@ -65,17 +62,69 @@ export const testWorkflow = createWorkflow({})
65
62
 
66
63
  > See [Define Suspendable workflow](/examples/workflows/human-in-the-loop#define-suspendable-workflow) for more information.
67
64
 
65
+ ### Identifying Suspended steps
66
+
67
+ To resume a suspended workflow, inspect the `suspended` array in the result to determine which step needs input:
68
+
69
+ ```typescript {15} filename="src/test-workflow.ts" showLineNumbers copy
70
+ import { mastra } from "./mastra";
71
+
72
+ const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
73
+
74
+ const result = await run.start({
75
+ inputData: {
76
+ city: "London"
77
+ }
78
+ });
79
+
80
+ console.log(JSON.stringify(result, null, 2));
81
+
82
+ if (result.status === "suspended") {
83
+ const resumedResult = await run.resume({
84
+ step: result.suspended[0],
85
+ resumeData: {
86
+ city: "Berlin"
87
+ }
88
+ });
89
+ }
90
+
91
+ ```
92
+
93
+ In this case, the logic resumes the first step listed in the `suspended` array. A `step` can also be defined using it's `id`, for example: 'step-1'.
94
+
95
+ ```json
96
+ {
97
+ "status": "suspended",
98
+ "steps": {
99
+ // ...
100
+ "step-1": {
101
+ // ...
102
+ "status": "suspended",
103
+ }
104
+ },
105
+ "suspended": [
106
+ [
107
+ "step-1"
108
+ ]
109
+ ]
110
+ }
111
+ ```
112
+
113
+ > See [Run Workflow Results](/workflows/overview#run-workflow-results) for more details.
114
+
68
115
  ## Resume
69
116
 
70
117
  A workflow can be resumed by calling `resume` and providing the required `resumeData`.
71
118
 
72
- ```typescript {6,12,13,14} filename="src/test-workflow.ts" showLineNumbers copy
119
+ ```typescript {16-18} filename="src/test-workflow.ts" showLineNumbers copy
73
120
  import { mastra } from "./mastra";
74
121
 
75
- const run = mastra.getWorkflow("testWorkflow").createRun();
122
+ const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
76
123
 
77
124
  const result = await run.start({
78
- inputData: { suggestions: ["London", "Paris", "New York"] }
125
+ inputData: {
126
+ city: "London"
127
+ }
79
128
  });
80
129
 
81
130
  console.log(JSON.stringify(result, null, 2));
@@ -83,19 +132,15 @@ console.log(JSON.stringify(result, null, 2));
83
132
  if (result.status === "suspended") {
84
133
  const resumedResult = await run.resume({
85
134
  step: 'step-1',
86
- resumeData: { city: "New York" }
135
+ resumeData: {
136
+ city: "Berlin"
137
+ }
87
138
  });
88
139
 
89
140
  console.log(JSON.stringify(resumedResult, null, 2));
90
141
  }
91
142
  ```
92
143
 
93
- To execute this run from your terminal:
94
-
95
- ```bash copy
96
- npx tsx src/test-workflow.ts
97
- ```
98
-
99
144
  ### Nested Workflow
100
145
 
101
146
  To resume a suspended nested workflow pass the workflow instance to the `step` parameter of the `resume` function.
@@ -128,7 +173,7 @@ const dowhileWorkflow = createWorkflow({
128
173
  )
129
174
  .commit();
130
175
 
131
- const run = dowhileWorkflow.createRun();
176
+ const run = await dowhileWorkflow.createRunAsync();
132
177
  const result = await run.start({ inputData: { value: 0 } });
133
178
 
134
179
  if (result.status === "suspended") {
@@ -151,7 +196,7 @@ import { RuntimeContext } from "@mastra/core/di";
151
196
  import { mastra } from "./mastra";
152
197
 
153
198
  const runtimeContext = new RuntimeContext();
154
- const run = mastra.getWorkflow("testWorkflow").createRun();
199
+ const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
155
200
 
156
201
  const result = await run.start({
157
202
  inputData: { suggestions: ["London", "Paris", "New York"] },
@@ -238,7 +238,7 @@ export const cityCoordinatesTool = createTool({
238
238
 
239
239
  const workflow = mastra?.getWorkflow("cityStringWorkflow");
240
240
 
241
- const run = workflow?.createRun();
241
+ const run = await workflow?.createRunAsync();
242
242
 
243
243
  const { result } = await run?.start({
244
244
  inputData: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mastra/mcp-docs-server",
3
- "version": "0.13.2-alpha.0",
3
+ "version": "0.13.2-alpha.2",
4
4
  "description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -24,15 +24,15 @@
24
24
  "author": "",
25
25
  "license": "Elastic-2.0",
26
26
  "dependencies": {
27
- "@modelcontextprotocol/sdk": "^1.12.1",
27
+ "@modelcontextprotocol/sdk": "^1.13.0",
28
28
  "date-fns": "^4.1.0",
29
29
  "exit-hook": "^4.0.0",
30
30
  "jsdom": "^26.1.0",
31
31
  "turndown": "^7.2.0",
32
32
  "uuid": "^11.1.0",
33
- "zod": "^3.25.57",
33
+ "zod": "^3.25.67",
34
34
  "zod-to-json-schema": "^3.24.5",
35
- "@mastra/mcp": "^0.10.5-alpha.0"
35
+ "@mastra/mcp": "^0.10.5-alpha.2"
36
36
  },
37
37
  "devDependencies": {
38
38
  "@hono/node-server": "^1.14.4",
@@ -41,14 +41,14 @@
41
41
  "@types/turndown": "^5.0.5",
42
42
  "@wong2/mcp-cli": "^1.10.0",
43
43
  "cross-env": "^7.0.3",
44
- "eslint": "^9.28.0",
44
+ "eslint": "^9.29.0",
45
45
  "hono": "^4.7.11",
46
46
  "tsup": "^8.5.0",
47
47
  "tsx": "^4.19.4",
48
48
  "typescript": "^5.8.3",
49
49
  "vitest": "^3.2.3",
50
50
  "@internal/lint": "0.0.13",
51
- "@mastra/core": "0.10.7-alpha.1"
51
+ "@mastra/core": "0.10.7-alpha.4"
52
52
  },
53
53
  "peerDependencies": {
54
54
  "@mastra/core": "^0.10.0-alpha.0"
@@ -1,142 +0,0 @@
1
- ---
2
- title: Deploying to Mastra Cloud
3
- description: GitHub-based deployment process for Mastra applications
4
- ---
5
-
6
- # Deploying to Mastra Cloud
7
-
8
- > **Beta Notice**
9
- > Mastra Cloud is currently in **public beta**.
10
-
11
- This page describes the deployment process for Mastra applications to Mastra Cloud using GitHub integration.
12
-
13
- ## Prerequisites
14
-
15
- - A GitHub account
16
- - A GitHub repository containing a Mastra application
17
- - Access to Mastra Cloud
18
-
19
- ## Deployment Process
20
-
21
- Mastra Cloud uses a Git-based deployment workflow similar to platforms like Vercel and Netlify:
22
-
23
- 1. **Import GitHub Repository**
24
-
25
- - From the Projects dashboard, click "Add new"
26
- - Select the repository containing your Mastra application
27
- - Click "Import" next to the desired repository
28
-
29
- 2. **Configure Deployment Settings**
30
-
31
- - Set the project name (defaults to repository name)
32
- - Select branch to deploy (typically `main`)
33
- - Configure the Mastra directory path (defaults to `src/mastra`)
34
- - Add necessary environment variables (like API keys)
35
-
36
- 3. **Deploy from Git**
37
- - After initial configuration, deployments are triggered by pushes to the selected branch
38
- - Mastra Cloud automatically builds and deploys your application
39
- - Each deployment creates an atomic snapshot of your agents and workflows
40
-
41
- ## Automatic Deployments
42
-
43
- Mastra Cloud follows a Git-driven workflow:
44
-
45
- 1. Make changes to your Mastra application locally
46
- 2. Commit changes to the `main` branch
47
- 3. Push to GitHub
48
- 4. Mastra Cloud automatically detects the push and creates a new deployment
49
- 5. Once the build completes, your application is live
50
-
51
- ## Deployment Domains
52
-
53
- Each project receives two URLs:
54
-
55
- 1. **Project-specific domain**: `https://[project-name].mastra.cloud`
56
-
57
- - Example: `https://gray-acoustic-helicopter.mastra.cloud`
58
-
59
- 2. **Deployment-specific domain**: `https://[deployment-id].mastra.cloud`
60
- - Example: `https://young-loud-caravan-6156280f-ad56-4ec8-9701-6bb5271fd73d.mastra.cloud`
61
-
62
- These URLs provide direct access to your deployed agents and workflows.
63
-
64
- ## Viewing Deployments
65
-
66
- ![Deployments List](../../../../../public/image/cloud-agents.png)
67
-
68
- The deployments section in the dashboard shows:
69
-
70
- - **Title**: Deployment identifier (based on commit hash)
71
- - **Status**: Current state (success or archived)
72
- - **Branch**: The branch used (typically `main`)
73
- - **Commit**: The Git commit hash
74
- - **Updated At**: Timestamp of the deployment
75
-
76
- Each deployment represents an atomic snapshot of your Mastra application at a specific point in time.
77
-
78
- ## Interacting with Agents
79
-
80
- ![Agent Interface](../../../../../public/image/cloud-agent.png)
81
-
82
- After deployment, interact with your agents:
83
-
84
- 1. Navigate to your project in the dashboard
85
- 2. Go to the Agents section
86
- 3. Select an agent to view its details and interface
87
- 4. Use the Chat tab to communicate with your agent
88
- 5. View the agent's configuration in the right panel:
89
- - Model information (e.g., OpenAI)
90
- - Available tools (e.g., getWeather)
91
- - Complete system prompt
92
- 6. Use suggested prompts (like "What capabilities do you have?") or enter custom messages
93
-
94
- The interface shows the agent's branch (typically "main") and indicates whether conversation memory is enabled.
95
-
96
- ## Monitoring Logs
97
-
98
- The Logs section provides detailed information about your application:
99
-
100
- - **Time**: When the log entry was created
101
- - **Level**: Log level (info, debug)
102
- - **Hostname**: Server identification
103
- - **Message**: Detailed log information, including:
104
- - API initialization
105
- - Storage connections
106
- - Agent and workflow activity
107
-
108
- These logs help debug and monitor your application's behavior in the production environment.
109
-
110
- ## Workflows
111
-
112
- ![Workflows Interface](../../../../../public/image/cloud-workflows.png)
113
-
114
- The Workflows section allows you to view and interact with your deployed workflows:
115
-
116
- 1. View all workflows in your project
117
- 2. Examine workflow structure and steps
118
- 3. Access execution history and performance data
119
-
120
- ## Database Usage
121
-
122
- Mastra Cloud tracks database utilization metrics:
123
-
124
- - Number of reads
125
- - Number of writes
126
- - Storage used (MB)
127
-
128
- These metrics appear in the project overview, helping you monitor resource consumption.
129
-
130
- ## Deployment Configuration
131
-
132
- Configure your deployment through the dashboard:
133
-
134
- 1. Navigate to your project settings
135
- 2. Set environment variables (like `OPENAI_API_KEY`)
136
- 3. Configure project-specific settings
137
-
138
- Changes to configuration require a new deployment to take effect.
139
-
140
- ## Next Steps
141
-
142
- After deployment, [trace and monitor execution](./observability.mdx) using the observability tools.