@mastra/mcp-docs-server 1.1.17 → 1.1.18-alpha.4
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/docs/agents/overview.md +4 -4
- package/.docs/docs/agents/processors.md +1 -1
- package/.docs/docs/community/licensing.md +7 -9
- package/.docs/docs/deployment/monorepo.md +0 -6
- package/.docs/docs/evals/built-in-scorers.md +1 -1
- package/.docs/docs/{observability → evals}/datasets/overview.md +12 -12
- package/.docs/docs/{observability → evals}/datasets/running-experiments.md +9 -9
- package/.docs/docs/evals/overview.md +8 -9
- package/.docs/docs/getting-started/manual-install.md +1 -2
- package/.docs/docs/index.md +1 -1
- package/.docs/docs/mastra-cloud/deployment.md +2 -2
- package/.docs/docs/mastra-cloud/observability.md +2 -2
- package/.docs/docs/mastra-cloud/overview.md +1 -1
- package/.docs/docs/mastra-cloud/setup.md +3 -3
- package/.docs/docs/mcp/publishing-mcp-server.md +20 -0
- package/.docs/docs/memory/message-history.md +6 -4
- package/.docs/docs/memory/observational-memory.md +20 -11
- package/.docs/docs/memory/overview.md +4 -4
- package/.docs/docs/memory/semantic-recall.md +28 -19
- package/.docs/docs/memory/storage.md +4 -4
- package/.docs/docs/observability/metrics/overview.md +114 -0
- package/.docs/docs/observability/overview.md +13 -5
- package/.docs/docs/observability/tracing/exporters/default.md +2 -4
- package/.docs/docs/observability/tracing/exporters/laminar.md +4 -4
- package/.docs/docs/observability/tracing/exporters/sentry.md +4 -4
- package/.docs/docs/observability/tracing/overview.md +2 -2
- package/.docs/docs/rag/chunking-and-embedding.md +2 -2
- package/.docs/docs/server/auth/composite-auth.md +1 -7
- package/.docs/docs/server/auth/custom-auth-provider.md +2 -4
- package/.docs/docs/server/auth/jwt.md +1 -1
- package/.docs/docs/server/auth/simple-auth.md +1 -7
- package/.docs/docs/server/auth.md +3 -3
- package/.docs/docs/server/custom-adapters.md +3 -1
- package/.docs/docs/server/custom-api-routes.md +1 -1
- package/.docs/docs/server/mastra-client.md +1 -3
- package/.docs/docs/server/mastra-server.md +8 -0
- package/.docs/docs/server/request-context.md +17 -17
- package/.docs/docs/server/server-adapters.md +8 -8
- package/.docs/docs/streaming/events.md +1 -90
- package/.docs/docs/streaming/overview.md +0 -42
- package/.docs/docs/studio/auth.md +142 -0
- package/.docs/docs/{deployment/studio.md → studio/deployment.md} +42 -16
- package/.docs/docs/studio/observability.md +98 -0
- package/.docs/docs/studio/overview.md +127 -0
- package/.docs/docs/workflows/agents-and-tools.md +7 -10
- package/.docs/docs/workflows/control-flow.md +1 -1
- package/.docs/docs/workflows/overview.md +12 -7
- package/.docs/docs/workflows/suspend-and-resume.md +1 -1
- package/.docs/guides/concepts/multi-agent-systems.md +4 -4
- package/.docs/guides/deployment/vercel.md +1 -1
- package/.docs/guides/getting-started/next-js.md +1 -1
- package/.docs/guides/getting-started/quickstart.md +1 -1
- package/.docs/guides/guide/ai-recruiter.md +1 -1
- package/.docs/guides/guide/chef-michel.md +1 -1
- package/.docs/guides/guide/code-review-bot.md +1 -1
- package/.docs/guides/guide/dev-assistant.md +1 -1
- package/.docs/guides/guide/docs-manager.md +1 -1
- package/.docs/guides/guide/github-actions-pr-description.md +1 -1
- package/.docs/guides/guide/notes-mcp-server.md +1 -1
- package/.docs/guides/guide/stock-agent.md +1 -1
- package/.docs/guides/guide/web-search.md +2 -2
- package/.docs/guides/index.md +1 -1
- package/.docs/guides/migrations/upgrade-to-v1/client.md +1 -1
- package/.docs/guides/migrations/upgrade-to-v1/tracing.md +1 -1
- package/.docs/models/gateways/netlify.md +65 -66
- package/.docs/models/gateways/openrouter.md +2 -1
- package/.docs/models/gateways/vercel.md +3 -1
- package/.docs/models/index.md +2 -2
- package/.docs/models/providers/aihubmix.md +17 -102
- package/.docs/models/providers/opencode.md +3 -2
- package/.docs/models/providers/synthetic.md +2 -1
- package/.docs/models/providers/vultr.md +11 -16
- package/.docs/models/providers/zenmux.md +2 -31
- package/.docs/models/providers.md +0 -1
- package/.docs/reference/agents/agent.md +1 -1
- package/.docs/reference/cli/mastra.md +3 -3
- package/.docs/reference/client-js/workflows.md +2 -2
- package/.docs/reference/configuration.md +4 -4
- package/.docs/reference/deployer/cloudflare.md +1 -1
- package/.docs/reference/deployer/vercel.md +1 -1
- package/.docs/reference/index.md +16 -14
- package/.docs/reference/memory/observational-memory.md +1 -1
- package/.docs/reference/observability/metrics/automatic-metrics.md +132 -0
- package/.docs/reference/storage/cloudflare-d1.md +1 -1
- package/.docs/reference/storage/cloudflare.md +3 -3
- package/.docs/reference/storage/convex.md +1 -1
- package/.docs/reference/storage/dynamodb.md +1 -1
- package/.docs/reference/storage/lance.md +1 -1
- package/.docs/reference/storage/upstash.md +1 -1
- package/.docs/reference/workspace/vercel.md +118 -0
- package/CHANGELOG.md +22 -0
- package/package.json +5 -5
- package/.docs/docs/getting-started/studio.md +0 -113
- package/.docs/docs/mastra-cloud/studio.md +0 -24
|
@@ -1,113 +0,0 @@
|
|
|
1
|
-
# Studio
|
|
2
|
-
|
|
3
|
-
Studio provides an interactive UI for building, testing, and managing your agents, workflows, and tools. Run it locally during development, or [deploy it](https://mastra.ai/docs/deployment/studio) to production so your team can manage agents, monitor performance, and gain insights through built-in observability.
|
|
4
|
-
|
|
5
|
-
Add [authentication](https://mastra.ai/docs/server/auth) to protect your deployed Studio with login screens, role-based access control, and permission-based UI rendering so you can control what each team member can see and do. You can also [create a project in Mastra Cloud](https://mastra.ai/docs/mastra-cloud/setup) for a hosted option.
|
|
6
|
-
|
|
7
|
-
[YouTube video player](https://www.youtube-nocookie.com/embed/ojGu6Bi4wYk)
|
|
8
|
-
|
|
9
|
-
## Start Studio
|
|
10
|
-
|
|
11
|
-
If you created your application with `create mastra`, start the development server using the `dev` script. You can also run it directly with `mastra dev`.
|
|
12
|
-
|
|
13
|
-
**npm**:
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
npm run dev
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
**pnpm**:
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
|
-
pnpm run dev
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
**Yarn**:
|
|
26
|
-
|
|
27
|
-
```bash
|
|
28
|
-
yarn dev
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
**Bun**:
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
bun run dev
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
Once the server is running, you can:
|
|
38
|
-
|
|
39
|
-
- Open the Studio UI at <http://localhost:4111/> to interact with your agents, workflows, and tools.
|
|
40
|
-
- Visit <http://localhost:4111/swagger-ui> to discover and interact with the underlying REST API.
|
|
41
|
-
|
|
42
|
-
To run Studio in production, see [Deploy Studio](https://mastra.ai/docs/deployment/studio).
|
|
43
|
-
|
|
44
|
-
## Studio UI
|
|
45
|
-
|
|
46
|
-
The Studio UI lets you interact with your agents, workflows, and tools, observe exactly what happens under the hood with each interaction, and tweak things as you go.
|
|
47
|
-
|
|
48
|
-
### Agents
|
|
49
|
-
|
|
50
|
-
Chat with your agent directly, dynamically switch [models](https://mastra.ai/models), and tweak settings like temperature and top-p to understand how they affect the output.
|
|
51
|
-
|
|
52
|
-
When you interact with your agent, you can follow each step of its reasoning, view tool call outputs, and [observe](#observability) traces and logs to see how responses are generated. You can also attach [scorers](#scorers) to measure and compare response quality over time.
|
|
53
|
-
|
|
54
|
-
### Workflows
|
|
55
|
-
|
|
56
|
-
Visualize your workflow as a graph and run it step by step with a custom input. During execution, the interface updates in real time to show the active step and the path taken.
|
|
57
|
-
|
|
58
|
-
When running a workflow, you can also view detailed traces showing tool calls, raw JSON outputs, and any errors that might have occurred along the way.
|
|
59
|
-
|
|
60
|
-
### Tools
|
|
61
|
-
|
|
62
|
-
Run tools in isolation to observe their behavior. Test them before assigning them to your agent, or isolate them to debug issues should something go wrong.
|
|
63
|
-
|
|
64
|
-
### Processors
|
|
65
|
-
|
|
66
|
-
View the input and output processors attached to each agent. The agent detail panel lists every processor by name and type, so you can verify your guardrails, token limiters, and custom processors are wired up correctly before testing.
|
|
67
|
-
|
|
68
|
-
See [Processors](https://mastra.ai/docs/agents/processors) and [Guardrails](https://mastra.ai/docs/agents/guardrails) for configuration details.
|
|
69
|
-
|
|
70
|
-
### MCP
|
|
71
|
-
|
|
72
|
-
List the MCP servers attached to your Mastra instance and explore their available tools.
|
|
73
|
-
|
|
74
|
-
### Observability
|
|
75
|
-
|
|
76
|
-
When you run an agent or workflow, the Observability tab displays traces that highlight the key AI operations such as model calls, tool executions, and workflow steps. Follow these traces to see how data moves, where time is spent, and what's happening under the hood.
|
|
77
|
-
|
|
78
|
-
Tracing filters out low-level framework details so your traces stay focused and readable.
|
|
79
|
-
|
|
80
|
-
### Scorers
|
|
81
|
-
|
|
82
|
-
The Scorers tab displays the results of your agent's scorers as they run. When messages pass through your agent, the defined scorers evaluate each output asynchronously and render their results here. This allows you to understand how your scorers respond to different interactions, compare performance across test cases, and identify areas for improvement.
|
|
83
|
-
|
|
84
|
-
### Datasets
|
|
85
|
-
|
|
86
|
-
Create and manage collections of test cases to evaluate your agents and workflows. Import items from CSV or JSON, define input and ground-truth schemas, and pin to specific versions so you can reproduce experiments exactly. Run experiments with [scorers](https://mastra.ai/docs/evals/overview) to compare quality across prompts, models, or code changes.
|
|
87
|
-
|
|
88
|
-
See [Datasets overview](https://mastra.ai/docs/observability/datasets/overview) for the full API and versioning details.
|
|
89
|
-
|
|
90
|
-
## REST API
|
|
91
|
-
|
|
92
|
-
Studio is backed by a complete set of REST API routes that let you programmatically interact with your agents, workflows, and tools. These are the same routes exposed by the [Mastra Server](https://mastra.ai/docs/server/mastra-server), so everything you build against locally works identically in production.
|
|
93
|
-
|
|
94
|
-
You can explore all available endpoints in the OpenAPI specification at <http://localhost:4111/api/openapi.json>, which details every endpoint and its request and response schemas.
|
|
95
|
-
|
|
96
|
-
To explore the API interactively, visit the Swagger UI at <http://localhost:4111/swagger-ui>. Here, you can discover endpoints and test them directly from your browser.
|
|
97
|
-
|
|
98
|
-
> **Note:** The OpenAPI and Swagger endpoints are disabled in production by default. To enable them, set [`server.build.openAPIDocs`](https://mastra.ai/reference/configuration) and [`server.build.swaggerUI`](https://mastra.ai/reference/configuration) to `true` respectively.
|
|
99
|
-
|
|
100
|
-
## Configuration
|
|
101
|
-
|
|
102
|
-
By default, Studio runs at <http://localhost:4111>. You can change the [`host`](https://mastra.ai/reference/configuration), [`port`](https://mastra.ai/reference/configuration), and [`studioBase`](https://mastra.ai/reference/configuration) in the Mastra server configuration.
|
|
103
|
-
|
|
104
|
-
For production deployments, see [Deploy Studio](https://mastra.ai/docs/deployment/studio) to learn about hosting Studio alongside your server, as a standalone SPA, or on a CDN.
|
|
105
|
-
|
|
106
|
-
Add [authentication](https://mastra.ai/docs/server/auth) to control who can access Studio in production. Studio displays the appropriate login UI, which can be an SSO button, an email/password form, or both. All API routes require authentication. This applies to any request made to your Mastra API, whether from Studio or a direct API call.
|
|
107
|
-
|
|
108
|
-
Mastra also supports HTTPS development through the [`--https`](https://mastra.ai/reference/cli/mastra) flag, which automatically creates and manages certificates for your project. When you run `mastra dev --https`, a private key and certificate are generated for localhost (or your configured host). Visit the [HTTPS reference](https://mastra.ai/reference/configuration) to learn more.
|
|
109
|
-
|
|
110
|
-
## Next steps
|
|
111
|
-
|
|
112
|
-
- Learn more about Mastra's suggested [project structure](https://mastra.ai/docs/getting-started/project-structure).
|
|
113
|
-
- Integrate Mastra with your frontend framework of choice - [Next.js](https://mastra.ai/guides/getting-started/next-js), [React](https://mastra.ai/guides/getting-started/vite-react), or [Astro](https://mastra.ai/guides/getting-started/astro).
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# Studio
|
|
2
|
-
|
|
3
|
-
[YouTube video player](https://www.youtube-nocookie.com/embed/ojGu6Bi4wYk)
|
|
4
|
-
|
|
5
|
-
Mastra Cloud provides a hosted version of [Studio](https://mastra.ai/docs/getting-started/studio) that gives your team a shared environment for interacting with and testing your agents. Team members can chat with agents, review traces, give feedback, and tweak system prompts - without needing to run the project locally.
|
|
6
|
-
|
|
7
|
-
[Set up your project](https://mastra.ai/docs/mastra-cloud/setup) to access Studio in the cloud.
|
|
8
|
-
|
|
9
|
-
See the [Studio documentation](https://mastra.ai/docs/getting-started/studio) for details on features like the Agents playground, Workflows runner, Tools testing, and MCP Servers.
|
|
10
|
-
|
|
11
|
-
> **Note:** You don't need to deploy your agent to use Studio. Studio runs in a sandbox environment separate from your production deployment
|
|
12
|
-
|
|
13
|
-
## Sharing access
|
|
14
|
-
|
|
15
|
-
To invite team members, go to [Mastra Cloud](https://cloud.mastra.ai), select **Team Settings**, then **Members** to add them. Once invited, they can sign in and access your project's Studio.
|
|
16
|
-
|
|
17
|
-

|
|
18
|
-
|
|
19
|
-
> **Warning:** Team members can view environment variables and delete projects. Only invite people you trust.
|
|
20
|
-
|
|
21
|
-
## Next steps
|
|
22
|
-
|
|
23
|
-
- [Deployment](https://mastra.ai/docs/mastra-cloud/deployment) - Manage deployments and settings
|
|
24
|
-
- [Observability](https://mastra.ai/docs/mastra-cloud/observability) - Monitor traces and logs
|