@mastra/mcp-docs-server 1.0.0-beta.14 → 1.0.0-beta.16
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.
- package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +41 -41
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +51 -51
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +235 -235
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +85 -85
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +235 -235
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +235 -235
- package/.docs/organized/changelogs/%40mastra%2Fconvex.md +258 -0
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +338 -338
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +27 -27
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +67 -67
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +235 -235
- package/.docs/organized/changelogs/%40mastra%2Fevals.md +10 -10
- package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +6 -0
- package/.docs/organized/changelogs/%40mastra%2Flance.md +235 -235
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +235 -235
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fmcp.md +30 -30
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +168 -168
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +259 -259
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +259 -259
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +279 -279
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +108 -108
- package/.docs/organized/changelogs/%40mastra%2Freact.md +77 -77
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +180 -180
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +235 -235
- package/.docs/organized/changelogs/create-mastra.md +11 -11
- package/.docs/organized/changelogs/mastra.md +40 -40
- package/.docs/organized/code-examples/agent-v6.md +70 -11
- package/.docs/organized/code-examples/client-side-tools.md +1 -1
- package/.docs/raw/agents/adding-voice.mdx +8 -3
- package/.docs/raw/deployment/overview.mdx +3 -4
- package/.docs/raw/deployment/workflow-runners.mdx +14 -0
- package/.docs/raw/getting-started/studio.mdx +1 -1
- package/.docs/raw/guides/deployment/inngest.mdx +198 -140
- package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +11 -3
- package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +11 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +68 -0
- package/.docs/raw/mastra-cloud/deployment.mdx +39 -0
- package/.docs/raw/mastra-cloud/observability.mdx +9 -15
- package/.docs/raw/mastra-cloud/overview.mdx +14 -44
- package/.docs/raw/mastra-cloud/setup.mdx +64 -0
- package/.docs/raw/mastra-cloud/studio.mdx +35 -0
- package/.docs/raw/reference/client-js/workflows.mdx +15 -0
- package/.docs/raw/reference/logging/pino-logger.mdx +1 -1
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +39 -18
- package/.docs/raw/reference/storage/cloudflare-d1.mdx +4 -2
- package/.docs/raw/reference/storage/composite.mdx +223 -0
- package/.docs/raw/reference/storage/lance.mdx +3 -2
- package/.docs/raw/reference/storage/libsql.mdx +5 -2
- package/.docs/raw/reference/storage/mongodb.mdx +4 -2
- package/.docs/raw/reference/storage/mssql.mdx +4 -2
- package/.docs/raw/reference/storage/postgresql.mdx +4 -2
- package/.docs/raw/reference/tools/mcp-server.mdx +9 -0
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +51 -3
- package/.docs/raw/reference/workflows/run.mdx +8 -2
- package/.docs/raw/voice/overview.mdx +1 -1
- package/.docs/raw/workflows/overview.mdx +1 -1
- package/.docs/raw/workflows/snapshots.mdx +2 -1
- package/CHANGELOG.md +15 -0
- package/package.json +5 -5
- package/.docs/raw/mastra-cloud/dashboard.mdx +0 -96
- package/.docs/raw/mastra-cloud/setting-up.mdx +0 -106
- package/.docs/raw/workflows/inngest-workflow.mdx +0 -362
|
@@ -124,14 +124,16 @@ If you're using storage directly without Mastra, you must call `init()` explicit
|
|
|
124
124
|
import { MSSQLStore } from "@mastra/mssql";
|
|
125
125
|
|
|
126
126
|
const storage = new MSSQLStore({
|
|
127
|
+
id: 'mssql-storage',
|
|
127
128
|
connectionString: process.env.DATABASE_URL,
|
|
128
129
|
});
|
|
129
130
|
|
|
130
131
|
// Required when using storage directly
|
|
131
132
|
await storage.init();
|
|
132
133
|
|
|
133
|
-
//
|
|
134
|
-
await storage.
|
|
134
|
+
// Access domain-specific stores via getStore()
|
|
135
|
+
const memoryStore = await storage.getStore('memory');
|
|
136
|
+
const thread = await memoryStore?.getThreadById({ threadId: "..." });
|
|
135
137
|
```
|
|
136
138
|
|
|
137
139
|
:::warning
|
|
@@ -124,14 +124,16 @@ If you're using storage directly without Mastra, you must call `init()` explicit
|
|
|
124
124
|
import { PostgresStore } from "@mastra/pg";
|
|
125
125
|
|
|
126
126
|
const storage = new PostgresStore({
|
|
127
|
+
id: 'pg-storage',
|
|
127
128
|
connectionString: process.env.DATABASE_URL,
|
|
128
129
|
});
|
|
129
130
|
|
|
130
131
|
// Required when using storage directly
|
|
131
132
|
await storage.init();
|
|
132
133
|
|
|
133
|
-
//
|
|
134
|
-
await storage.
|
|
134
|
+
// Access domain-specific stores via getStore()
|
|
135
|
+
const memoryStore = await storage.getStore('memory');
|
|
136
|
+
const thread = await memoryStore?.getThreadById({ threadId: "..." });
|
|
135
137
|
```
|
|
136
138
|
|
|
137
139
|
:::warning
|
|
@@ -41,6 +41,8 @@ const server = new MCPServer({
|
|
|
41
41
|
id: "my-custom-server",
|
|
42
42
|
name: "My Custom Server",
|
|
43
43
|
version: "1.0.0",
|
|
44
|
+
description: "A server that provides weather data and agent capabilities",
|
|
45
|
+
instructions: "Use the available tools to help users with weather information and data processing tasks.",
|
|
44
46
|
tools: { weatherTool },
|
|
45
47
|
agents: { myAgent }, // this agent will become tool "ask_myAgent"
|
|
46
48
|
workflows: {
|
|
@@ -102,6 +104,13 @@ The constructor accepts an `MCPServerConfig` object with the following propertie
|
|
|
102
104
|
isOptional: true,
|
|
103
105
|
description: "Optional description of what the MCP server does.",
|
|
104
106
|
},
|
|
107
|
+
{
|
|
108
|
+
name: "instructions",
|
|
109
|
+
type: "string",
|
|
110
|
+
isOptional: true,
|
|
111
|
+
description:
|
|
112
|
+
"Optional instructions describing how to use the server and its features.",
|
|
113
|
+
},
|
|
105
114
|
{
|
|
106
115
|
name: "repository",
|
|
107
116
|
type: "Repository", // { url: string; source: string; id: string; }
|
|
@@ -7,12 +7,15 @@ description: Documentation for the `Run.cancel()` method in workflows, which can
|
|
|
7
7
|
|
|
8
8
|
The `.cancel()` method cancels a workflow run, stopping execution and cleaning up resources.
|
|
9
9
|
|
|
10
|
+
This method aborts any running steps and updates the workflow status to 'canceled'. It works for both actively running workflows and suspended/waiting workflows.
|
|
11
|
+
|
|
10
12
|
## Usage example
|
|
11
13
|
|
|
12
14
|
```typescript
|
|
13
15
|
const run = await workflow.createRun();
|
|
14
16
|
|
|
15
17
|
await run.cancel();
|
|
18
|
+
// Returns: { message: 'Workflow run canceled' }
|
|
16
19
|
```
|
|
17
20
|
|
|
18
21
|
## Parameters
|
|
@@ -34,14 +37,31 @@ await run.cancel();
|
|
|
34
37
|
content={[
|
|
35
38
|
{
|
|
36
39
|
name: "result",
|
|
37
|
-
type: "Promise<
|
|
40
|
+
type: "Promise<{ message: string }>",
|
|
38
41
|
description:
|
|
39
|
-
"A promise that resolves
|
|
42
|
+
"A promise that resolves with { message: 'Workflow run canceled' } when cancellation succeeds",
|
|
40
43
|
},
|
|
41
44
|
]}
|
|
42
45
|
/>
|
|
43
46
|
|
|
44
|
-
##
|
|
47
|
+
## How cancellation works
|
|
48
|
+
|
|
49
|
+
When called, the workflow will:
|
|
50
|
+
1. **Trigger the abort signal** - Uses the standard Web API AbortSignal to notify running steps
|
|
51
|
+
2. **Prevent subsequent steps** - No further steps will be executed
|
|
52
|
+
|
|
53
|
+
## Abort signal behavior
|
|
54
|
+
|
|
55
|
+
Steps that check the `abortSignal` parameter can respond to cancellation:
|
|
56
|
+
- Steps can listen to the 'abort' event: `abortSignal.addEventListener('abort', callback)`
|
|
57
|
+
- Steps can check if already aborted: `if (abortSignal.aborted) { ... }`
|
|
58
|
+
- Useful for cancelling timeouts, network requests, or long-running operations
|
|
59
|
+
|
|
60
|
+
**Note:** Steps must actively check the abort signal to be canceled mid-execution. Steps that don't check the signal will run to completion, but subsequent steps won't execute.
|
|
61
|
+
|
|
62
|
+
## Extended usage examples
|
|
63
|
+
|
|
64
|
+
### Cancelling a workflow on error
|
|
45
65
|
|
|
46
66
|
```typescript
|
|
47
67
|
const run = await workflow.createRun();
|
|
@@ -53,6 +73,34 @@ try {
|
|
|
53
73
|
}
|
|
54
74
|
```
|
|
55
75
|
|
|
76
|
+
### Creating a step that responds to cancellation
|
|
77
|
+
|
|
78
|
+
```typescript
|
|
79
|
+
const step = createStep({
|
|
80
|
+
id: 'long-running-step',
|
|
81
|
+
execute: async ({ inputData, abortSignal, abort }) => {
|
|
82
|
+
const timeout = new Promise((resolve) => {
|
|
83
|
+
const timer = setTimeout(() => resolve('done'), 10000);
|
|
84
|
+
|
|
85
|
+
// Clean up if canceled
|
|
86
|
+
abortSignal.addEventListener('abort', () => {
|
|
87
|
+
clearTimeout(timer);
|
|
88
|
+
resolve('canceled');
|
|
89
|
+
});
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
const result = await timeout;
|
|
93
|
+
|
|
94
|
+
// Check if aborted after async operation
|
|
95
|
+
if (abortSignal.aborted) {
|
|
96
|
+
return abort(); // Stop execution
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
return { result };
|
|
100
|
+
}
|
|
101
|
+
});
|
|
102
|
+
```
|
|
103
|
+
|
|
56
104
|
## Related
|
|
57
105
|
|
|
58
106
|
- [Workflows overview](/docs/v1/workflows/overview#running-workflows)
|
|
@@ -53,8 +53,8 @@ if (result.status === "suspended") {
|
|
|
53
53
|
},
|
|
54
54
|
{
|
|
55
55
|
name: "cancel",
|
|
56
|
-
type: "() => Promise<
|
|
57
|
-
description: "Cancels the workflow execution",
|
|
56
|
+
type: "() => Promise<{ message: string }>",
|
|
57
|
+
description: "Cancels the workflow execution, stopping any running steps and preventing subsequent steps from executing",
|
|
58
58
|
required: true,
|
|
59
59
|
},
|
|
60
60
|
{
|
|
@@ -102,6 +102,12 @@ A workflow run's `status` indicates its current execution state. The possible va
|
|
|
102
102
|
description:
|
|
103
103
|
"Workflow execution is paused waiting for resume, with suspended step information",
|
|
104
104
|
},
|
|
105
|
+
{
|
|
106
|
+
name: "canceled",
|
|
107
|
+
type: "string",
|
|
108
|
+
description:
|
|
109
|
+
"Workflow execution was canceled via the cancel() method, stopping any running steps and preventing subsequent steps from executing",
|
|
110
|
+
},
|
|
105
111
|
]}
|
|
106
112
|
/>
|
|
107
113
|
|
|
@@ -1031,4 +1031,4 @@ For more information on the CompositeVoice, refer to the [CompositeVoice Referen
|
|
|
1031
1031
|
- [Google Gemini Live Voice](/reference/v1/voice/google-gemini-live)
|
|
1032
1032
|
- [Deepgram Voice](/reference/v1/voice/deepgram)
|
|
1033
1033
|
- [PlayAI Voice](/reference/v1/voice/playai)
|
|
1034
|
-
- [Voice Examples](/
|
|
1034
|
+
- [Voice Examples](https://github.com/mastra-ai/voice-examples)
|
|
@@ -8,7 +8,7 @@ import TabItem from "@theme/TabItem";
|
|
|
8
8
|
|
|
9
9
|
# Workflows overview
|
|
10
10
|
|
|
11
|
-
Workflows let you define complex sequences of tasks using clear, structured steps rather than relying on the reasoning of a single agent. They give you full control over how tasks are broken down, how data moves between them, and what gets executed when.
|
|
11
|
+
Workflows let you define complex sequences of tasks using clear, structured steps rather than relying on the reasoning of a single agent. They give you full control over how tasks are broken down, how data moves between them, and what gets executed when. Workflows run using the built-in execution engine by default, or can be deployed to [workflow runners](/docs/v1/deployment/workflow-runners) like Inngest for managed infrastructure.
|
|
12
12
|
|
|
13
13
|

|
|
14
14
|
|
|
@@ -114,8 +114,9 @@ When a workflow is resumed, Mastra retrieves the persisted snapshot with these s
|
|
|
114
114
|
|
|
115
115
|
```typescript
|
|
116
116
|
const storage = mastra.getStorage();
|
|
117
|
+
const workflowStore = await storage?.getStore('workflows');
|
|
117
118
|
|
|
118
|
-
const snapshot = await
|
|
119
|
+
const snapshot = await workflowStore?.loadWorkflowSnapshot({
|
|
119
120
|
runId: "<run-id>",
|
|
120
121
|
workflowName: "<workflow-id>",
|
|
121
122
|
});
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
# @mastra/mcp-docs-server
|
|
2
2
|
|
|
3
|
+
## 1.0.0-beta.16
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies [[`3d93a15`](https://github.com/mastra-ai/mastra/commit/3d93a15796b158c617461c8b98bede476ebb43e2), [`efe406a`](https://github.com/mastra-ai/mastra/commit/efe406a1353c24993280ebc2ed61dd9f65b84b26), [`119e5c6`](https://github.com/mastra-ai/mastra/commit/119e5c65008f3e5cfca954eefc2eb85e3bf40da4), [`74e504a`](https://github.com/mastra-ai/mastra/commit/74e504a3b584eafd2f198001c6a113bbec589fd3), [`e33fdbd`](https://github.com/mastra-ai/mastra/commit/e33fdbd07b33920d81e823122331b0c0bee0bb59), [`929f69c`](https://github.com/mastra-ai/mastra/commit/929f69c3436fa20dd0f0e2f7ebe8270bd82a1529), [`8a73529`](https://github.com/mastra-ai/mastra/commit/8a73529ca01187f604b1f3019d0a725ac63ae55f)]:
|
|
8
|
+
- @mastra/core@1.0.0-beta.16
|
|
9
|
+
- @mastra/mcp@1.0.0-beta.7
|
|
10
|
+
|
|
11
|
+
## 1.0.0-beta.15
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- Updated dependencies [[`33a4d2e`](https://github.com/mastra-ai/mastra/commit/33a4d2e4ed8af51f69256232f00c34d6b6b51d48), [`4aaa844`](https://github.com/mastra-ai/mastra/commit/4aaa844a4f19d054490f43638a990cc57bda8d2f), [`4a1a6cb`](https://github.com/mastra-ai/mastra/commit/4a1a6cb3facad54b2bb6780b00ce91d6de1edc08), [`31d13d5`](https://github.com/mastra-ai/mastra/commit/31d13d5fdc2e2380e2e3ee3ec9fb29d2a00f265d), [`4c62166`](https://github.com/mastra-ai/mastra/commit/4c621669f4a29b1f443eca3ba70b814afa286266), [`7bcbf10`](https://github.com/mastra-ai/mastra/commit/7bcbf10133516e03df964b941f9a34e9e4ab4177), [`4353600`](https://github.com/mastra-ai/mastra/commit/43536005a65988a8eede236f69122e7f5a284ba2), [`6986fb0`](https://github.com/mastra-ai/mastra/commit/6986fb064f5db6ecc24aa655e1d26529087b43b3), [`053e979`](https://github.com/mastra-ai/mastra/commit/053e9793b28e970086b0507f7f3b76ea32c1e838), [`e26dc9c`](https://github.com/mastra-ai/mastra/commit/e26dc9c3ccfec54ae3dc3e2b2589f741f9ae60a6), [`55edf73`](https://github.com/mastra-ai/mastra/commit/55edf7302149d6c964fbb7908b43babfc2b52145), [`27c0009`](https://github.com/mastra-ai/mastra/commit/27c0009777a6073d7631b0eb7b481d94e165b5ca), [`dee388d`](https://github.com/mastra-ai/mastra/commit/dee388dde02f2e63c53385ae69252a47ab6825cc), [`3f3fc30`](https://github.com/mastra-ai/mastra/commit/3f3fc3096f24c4a26cffeecfe73085928f72aa63), [`d90ea65`](https://github.com/mastra-ai/mastra/commit/d90ea6536f7aa51c6545a4e9215b55858e98e16d), [`d171e55`](https://github.com/mastra-ai/mastra/commit/d171e559ead9f52ec728d424844c8f7b164c4510), [`10c2735`](https://github.com/mastra-ai/mastra/commit/10c27355edfdad1ee2b826b897df74125eb81fb8), [`1924cf0`](https://github.com/mastra-ai/mastra/commit/1924cf06816e5e4d4d5333065ec0f4bb02a97799), [`b339816`](https://github.com/mastra-ai/mastra/commit/b339816df0984d0243d944ac2655d6ba5f809cde)]:
|
|
16
|
+
- @mastra/core@1.0.0-beta.15
|
|
17
|
+
|
|
3
18
|
## 1.0.0-beta.14
|
|
4
19
|
|
|
5
20
|
### Patch Changes
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mastra/mcp-docs-server",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.16",
|
|
4
4
|
"description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -28,8 +28,8 @@
|
|
|
28
28
|
"@modelcontextprotocol/sdk": "^1.17.5",
|
|
29
29
|
"jsdom": "^26.1.0",
|
|
30
30
|
"zod": "^3.25.76",
|
|
31
|
-
"@mastra/
|
|
32
|
-
"@mastra/
|
|
31
|
+
"@mastra/core": "1.0.0-beta.16",
|
|
32
|
+
"@mastra/mcp": "^1.0.0-beta.7"
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
35
|
"@hono/node-server": "^1.19.6",
|
|
@@ -45,8 +45,8 @@
|
|
|
45
45
|
"tsx": "^4.19.4",
|
|
46
46
|
"typescript": "^5.8.3",
|
|
47
47
|
"vitest": "4.0.12",
|
|
48
|
-
"@
|
|
49
|
-
"@
|
|
48
|
+
"@mastra/core": "1.0.0-beta.16",
|
|
49
|
+
"@internal/lint": "0.0.53"
|
|
50
50
|
},
|
|
51
51
|
"homepage": "https://mastra.ai",
|
|
52
52
|
"repository": {
|
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Navigating the Dashboard | Mastra Cloud"
|
|
3
|
-
description: Details of each feature available in Mastra Cloud
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Navigating the Dashboard
|
|
7
|
-
|
|
8
|
-
This page explains how to navigate the Mastra Cloud dashboard, where you can configure your project, view deployment details, and interact with agents and workflows using the built-in [Studio](/docs/v1/mastra-cloud/dashboard#studio).
|
|
9
|
-
|
|
10
|
-
## Overview
|
|
11
|
-
|
|
12
|
-
The **Overview** page provides details about your application, including its domain URL, status, latest deployment, and connected agents and workflows.
|
|
13
|
-
|
|
14
|
-

|
|
15
|
-
|
|
16
|
-
Key features:
|
|
17
|
-
|
|
18
|
-
Each project shows its current deployment status, active domains, and environment variables, so you can quickly understand how your application is running.
|
|
19
|
-
|
|
20
|
-
## Deployments
|
|
21
|
-
|
|
22
|
-
The **Deployments** page shows recent builds and gives you quick access to detailed build logs. Click any row to view more information about a specific deployment.
|
|
23
|
-
|
|
24
|
-

|
|
25
|
-
|
|
26
|
-
Key features:
|
|
27
|
-
|
|
28
|
-
Each deployment includes its current status, the Git branch it was deployed from, and a title generated from the commit hash.
|
|
29
|
-
|
|
30
|
-
## Logs
|
|
31
|
-
|
|
32
|
-
The **Logs** page is where you'll find detailed information to help debug and monitor your application's behavior in the production environment.
|
|
33
|
-
|
|
34
|
-

|
|
35
|
-
|
|
36
|
-
Key features:
|
|
37
|
-
|
|
38
|
-
Each log includes a severity level and detailed messages showing agent, workflow, and storage activity.
|
|
39
|
-
|
|
40
|
-
## Settings
|
|
41
|
-
|
|
42
|
-
On the **Settings** page you can modify the configuration of your application.
|
|
43
|
-
|
|
44
|
-

|
|
45
|
-
|
|
46
|
-
Key features:
|
|
47
|
-
|
|
48
|
-
You can manage environment variables, edit key project settings like the name and branch, configure storage with LibSQLStore, and set a stable URL for your endpoints.
|
|
49
|
-
|
|
50
|
-
> Changes to configuration require a new deployment before taking effect.
|
|
51
|
-
|
|
52
|
-
## Studio
|
|
53
|
-
|
|
54
|
-
### Agents
|
|
55
|
-
|
|
56
|
-
On the **Agents** page you'll see all agents used in your application. Click any agent to interact using the chat interface.
|
|
57
|
-
|
|
58
|
-

|
|
59
|
-
|
|
60
|
-
Key features:
|
|
61
|
-
|
|
62
|
-
Test your agents in real time using the chat interface, review traces of each interaction, and see evaluation scores for every response.
|
|
63
|
-
|
|
64
|
-
### Workflows
|
|
65
|
-
|
|
66
|
-
On the **Workflows** page you'll see all workflows used in your application. Click any workflow to interact using the runner interface.
|
|
67
|
-
|
|
68
|
-

|
|
69
|
-
|
|
70
|
-
Key features:
|
|
71
|
-
|
|
72
|
-
Visualize your workflow with a step-by-step graph, view execution traces, and run workflows directly using the built-in runner.
|
|
73
|
-
|
|
74
|
-
### Tools
|
|
75
|
-
|
|
76
|
-
On the **Tools** page you'll see all tools used by your agents. Click any tool to interact using the input interface.
|
|
77
|
-
|
|
78
|
-

|
|
79
|
-
|
|
80
|
-
Key features:
|
|
81
|
-
|
|
82
|
-
Test your tools by providing an input that matches the schema and viewing the structured output.
|
|
83
|
-
|
|
84
|
-
## MCP Servers
|
|
85
|
-
|
|
86
|
-
The **MCP Servers** page lists all MCP Servers included in your application. Click any MCP Server for more information.
|
|
87
|
-
|
|
88
|
-

|
|
89
|
-
|
|
90
|
-
Key features:
|
|
91
|
-
|
|
92
|
-
Each MCP Server includes API endpoints for HTTP and SSE, along with IDE configuration snippets for tools like Cursor and Windsurf.
|
|
93
|
-
|
|
94
|
-
## Next steps
|
|
95
|
-
|
|
96
|
-
- [Understanding Tracing and Logs](/docs/v1/mastra-cloud/observability)
|
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Setting Up and Deploying | Mastra Cloud"
|
|
3
|
-
description: Configuration steps for Mastra Cloud projects
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
import Steps from "@site/src/components/Steps";
|
|
7
|
-
import StepItem from "@site/src/components/StepItem";
|
|
8
|
-
|
|
9
|
-
# Setting Up and Deploying
|
|
10
|
-
|
|
11
|
-
This page explains how to set up a project on [Mastra Cloud](https://mastra.ai/cloud) with automatic deployments using our GitHub integration.
|
|
12
|
-
|
|
13
|
-
## Prerequisites
|
|
14
|
-
|
|
15
|
-
- A [Mastra Cloud](https://mastra.ai/cloud) account
|
|
16
|
-
- A GitHub account / repository containing a Mastra application
|
|
17
|
-
|
|
18
|
-
:::info
|
|
19
|
-
|
|
20
|
-
Visit our [Getting started](/guides/v1/getting-started/quickstart) guide to scaffold out a new Mastra project with sensible defaults.
|
|
21
|
-
|
|
22
|
-
:::
|
|
23
|
-
|
|
24
|
-
## Setup and Deploy process
|
|
25
|
-
|
|
26
|
-
<Steps>
|
|
27
|
-
|
|
28
|
-
<StepItem>
|
|
29
|
-
|
|
30
|
-
Head over to [https://cloud.mastra.ai/](https://cloud.mastra.ai) and sign in with either:
|
|
31
|
-
|
|
32
|
-
- **GitHub**
|
|
33
|
-
- **Google**
|
|
34
|
-
|
|
35
|
-
</StepItem>
|
|
36
|
-
|
|
37
|
-
<StepItem>
|
|
38
|
-
|
|
39
|
-
When prompted, install the Mastra GitHub app.
|
|
40
|
-
|
|
41
|
-

|
|
42
|
-
|
|
43
|
-
</StepItem>
|
|
44
|
-
|
|
45
|
-
<StepItem>
|
|
46
|
-
|
|
47
|
-
Click the **Create new project** button to create a new project.
|
|
48
|
-
|
|
49
|
-

|
|
50
|
-
|
|
51
|
-
</StepItem>
|
|
52
|
-
|
|
53
|
-
<StepItem>
|
|
54
|
-
|
|
55
|
-
Search for a repository, then click **Import**.
|
|
56
|
-
|
|
57
|
-

|
|
58
|
-
|
|
59
|
-
</StepItem>
|
|
60
|
-
|
|
61
|
-
<StepItem>
|
|
62
|
-
|
|
63
|
-
Mastra Cloud automatically detects the right build settings, but you can customize them using the options described below.
|
|
64
|
-
|
|
65
|
-

|
|
66
|
-
|
|
67
|
-
- **Importing from GitHub**: The GitHub repository name
|
|
68
|
-
- **Project name**: Customize the project name
|
|
69
|
-
- **Branch**: The branch to deploy from
|
|
70
|
-
- **Project root**: The root directory of your project
|
|
71
|
-
- **Mastra directory**: Where Mastra files are located
|
|
72
|
-
- **Environment variables**: Add environment variables used by the application
|
|
73
|
-
- **Build and Store settings**:
|
|
74
|
-
- **Install command**: Runs pre-build to install project dependencies
|
|
75
|
-
- **Project setup command**: Runs pre-build to prepare any external dependencies
|
|
76
|
-
- **Port**: The network port the server will use
|
|
77
|
-
- **Store settings**: Use Mastra Cloud's built-in [LibSQLStore](/reference/v1/storage/libsql) storage
|
|
78
|
-
- **Deploy Project**: Starts the deployment process
|
|
79
|
-
|
|
80
|
-
</StepItem>
|
|
81
|
-
|
|
82
|
-
<StepItem>
|
|
83
|
-
|
|
84
|
-
Click **Deploy Project** to create and deploy your application using the configuration you've set.
|
|
85
|
-
|
|
86
|
-
</StepItem>
|
|
87
|
-
|
|
88
|
-
</Steps>
|
|
89
|
-
|
|
90
|
-
## Successful deployment
|
|
91
|
-
|
|
92
|
-
After a successful deployment you'll be shown the **Overview** screen where you can view your project's status, domains, latest deployments and connected agents and workflows.
|
|
93
|
-
|
|
94
|
-

|
|
95
|
-
|
|
96
|
-
## Continuous integration
|
|
97
|
-
|
|
98
|
-
Your project is now configured with automatic deployments which occur whenever you push to the configured branch of your GitHub repository.
|
|
99
|
-
|
|
100
|
-
## Testing your application
|
|
101
|
-
|
|
102
|
-
After a successful deployment you can test your agents and workflows [Studio](/docs/v1/mastra-cloud/dashboard#studio) in Mastra Cloud, or interact with them using our [Client SDK](/docs/v1/server/mastra-client).
|
|
103
|
-
|
|
104
|
-
## Next steps
|
|
105
|
-
|
|
106
|
-
- [Navigating the Dashboard](/docs/v1/mastra-cloud/dashboard)
|