@mastra/mcp-docs-server 1.1.24 → 1.1.25-alpha.3
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/deployment/cloud-providers.md +5 -1
- package/.docs/docs/deployment/overview.md +11 -8
- package/.docs/docs/index.md +2 -2
- package/.docs/docs/mastra-platform/configuration.md +36 -0
- package/.docs/docs/mastra-platform/overview.md +76 -0
- package/.docs/docs/memory/storage.md +0 -2
- package/.docs/docs/observability/logging.md +1 -1
- package/.docs/docs/observability/overview.md +1 -1
- package/.docs/docs/observability/tracing/exporters/cloud.md +126 -73
- package/.docs/docs/observability/tracing/exporters/default.md +1 -1
- package/.docs/docs/observability/tracing/overview.md +3 -3
- package/.docs/docs/server/middleware.md +46 -18
- package/.docs/docs/server/request-context.md +12 -1
- package/.docs/docs/studio/deployment.md +24 -6
- package/.docs/docs/studio/observability.md +1 -1
- package/.docs/docs/studio/overview.md +2 -4
- package/.docs/guides/deployment/mastra-platform.md +70 -0
- package/.docs/guides/migrations/mastra-cloud.md +247 -0
- package/.docs/guides/migrations/upgrade-to-v1/tracing.md +1 -1
- package/.docs/reference/cli/mastra.md +140 -0
- package/.docs/reference/client-js/agents.md +0 -14
- package/.docs/reference/configuration.md +4 -1
- package/.docs/reference/index.md +1 -0
- package/.docs/reference/logging/pino-logger.md +0 -2
- package/.docs/reference/mastra-platform/api.md +108 -0
- package/CHANGELOG.md +14 -0
- package/package.json +3 -3
- package/.docs/docs/mastra-cloud/deployment.md +0 -77
- package/.docs/docs/mastra-cloud/observability.md +0 -38
- package/.docs/docs/mastra-cloud/overview.md +0 -23
- package/.docs/docs/mastra-cloud/setup.md +0 -42
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
# API reference
|
|
2
|
+
|
|
3
|
+
## Members API
|
|
4
|
+
|
|
5
|
+
The root URL for the endpoints below is: `/v1/org/members`
|
|
6
|
+
|
|
7
|
+
| Method | Endpoint | Description |
|
|
8
|
+
| ------ | ------------------ | -------------------- |
|
|
9
|
+
| GET | `/` | List members |
|
|
10
|
+
| POST | `/invitations` | Send an invitation |
|
|
11
|
+
| GET | `/invitations` | List invitations |
|
|
12
|
+
| DELETE | `/invitations/:id` | Revoke an invitation |
|
|
13
|
+
| PATCH | `/:id` | Update member role |
|
|
14
|
+
| DELETE | `/:id` | Remove a member |
|
|
15
|
+
|
|
16
|
+
## API tokens
|
|
17
|
+
|
|
18
|
+
The root URL for the endpoints below is: `/v1/auth/tokens`
|
|
19
|
+
|
|
20
|
+
| Method | Endpoint | Description |
|
|
21
|
+
| ------ | -------- | ------------------- |
|
|
22
|
+
| POST | `/` | Create an API token |
|
|
23
|
+
| GET | `/` | List API tokens |
|
|
24
|
+
| DELETE | `/:id` | Delete an API token |
|
|
25
|
+
|
|
26
|
+
## Studio API
|
|
27
|
+
|
|
28
|
+
The root URL for the endpoints below is: `/v1/studio`
|
|
29
|
+
|
|
30
|
+
| Method | Endpoint | Description |
|
|
31
|
+
| ------ | ------------------------------ | ------------------------------ |
|
|
32
|
+
| GET | `/projects` | List studio projects |
|
|
33
|
+
| POST | `/projects` | Create a project |
|
|
34
|
+
| GET | `/projects/:id` | Get project detail and deploys |
|
|
35
|
+
| DELETE | `/projects/:id` | Delete a project |
|
|
36
|
+
| POST | `/deploys` | Create a deploy |
|
|
37
|
+
| POST | `/deploys/:id/upload-complete` | Confirm artifact upload |
|
|
38
|
+
| GET | `/deploys/:id` | Get deploy status |
|
|
39
|
+
| GET | `/deploys/:id/logs` | Get deploy logs |
|
|
40
|
+
| GET | `/deploys/:id/logs/stream` | Stream deploy logs (SSE) |
|
|
41
|
+
|
|
42
|
+
## Server API
|
|
43
|
+
|
|
44
|
+
The root URL for the endpoints below is: `/v1/server`
|
|
45
|
+
|
|
46
|
+
| Method | Endpoint | Description |
|
|
47
|
+
| ------ | ------------------------------ | ------------------------------------- |
|
|
48
|
+
| GET | `/projects` | List server projects |
|
|
49
|
+
| POST | `/projects` | Create a project |
|
|
50
|
+
| GET | `/projects/:id` | Get project detail |
|
|
51
|
+
| DELETE | `/projects/:id` | Delete a project |
|
|
52
|
+
| PUT | `/projects/:id/env` | Set environment variables |
|
|
53
|
+
| GET | `/projects/:id/env` | Get environment variables |
|
|
54
|
+
| POST | `/projects/:id/env/restart` | Restart after env change |
|
|
55
|
+
| GET | `/projects/:id/domains` | List domains |
|
|
56
|
+
| POST | `/projects/:id/domains` | Add a custom domain |
|
|
57
|
+
| GET | `/projects/:id/runtime-logs` | Get runtime logs |
|
|
58
|
+
| POST | `/projects/:id/redeploy` | Trigger redeploy |
|
|
59
|
+
| POST | `/projects/:id/always-on` | Enable always-on |
|
|
60
|
+
| DELETE | `/projects/:id/always-on` | Disable always-on |
|
|
61
|
+
| POST | `/deploys` | Create a deploy |
|
|
62
|
+
| POST | `/deploys/:id/upload-complete` | Confirm artifact upload |
|
|
63
|
+
| GET | `/deploys/:id` | Get deploy status |
|
|
64
|
+
| GET | `/deploys/:id/logs` | Get deploy logs |
|
|
65
|
+
| POST | `/deploys/:id/cancel` | Cancel a queued or in-progress deploy |
|
|
66
|
+
| DELETE | `/deploys/:id` | Stop a running deploy |
|
|
67
|
+
|
|
68
|
+
## Gateway API
|
|
69
|
+
|
|
70
|
+
The root URL for the endpoints below is: `/v1/gateway`
|
|
71
|
+
|
|
72
|
+
| Method | Endpoint | Description |
|
|
73
|
+
| ------ | ------------------------------------------------------------- | ------------------------------------------- |
|
|
74
|
+
| GET | `/projects` | List gateway projects |
|
|
75
|
+
| GET | `/projects/:id` | Get project detail |
|
|
76
|
+
| PATCH | `/projects/:id` | Update project settings |
|
|
77
|
+
| DELETE | `/projects/:id` | Delete a project |
|
|
78
|
+
| POST | `/projects/provision` | Provision a new gateway project |
|
|
79
|
+
| GET | `/projects/:id/keys` | List API keys |
|
|
80
|
+
| POST | `/projects/:id/keys` | Create an API key |
|
|
81
|
+
| DELETE | `/projects/:id/keys/:keyId` | Revoke an API key |
|
|
82
|
+
| GET | `/projects/:id/keys/:keyId/bindings` | List key-level provider bindings |
|
|
83
|
+
| POST | `/projects/:id/keys/:keyId/bindings` | Add a key-level provider binding (BYOK) |
|
|
84
|
+
| DELETE | `/projects/:id/keys/:keyId/bindings/:provider` | Remove a key-level binding |
|
|
85
|
+
| GET | `/projects/:id/bindings` | List project-level provider bindings |
|
|
86
|
+
| POST | `/projects/:id/bindings` | Add a project-level provider binding (BYOK) |
|
|
87
|
+
| DELETE | `/projects/:id/bindings/:provider` | Remove a project-level binding |
|
|
88
|
+
| GET | `/projects/:id/usage/has-activity` | Check whether project has any requests |
|
|
89
|
+
| GET | `/projects/:id/usage/activity` | Get aggregated usage activity |
|
|
90
|
+
| GET | `/projects/:id/usage/memory-activity` | Get memory-token totals over a time range |
|
|
91
|
+
| GET | `/projects/:id/usage/logs` | Get request logs |
|
|
92
|
+
| GET | `/projects/:id/usage/logs/facets` | Get log filter facets |
|
|
93
|
+
| GET | `/projects/:id/usage/logs/:requestId` | Get specific request detail |
|
|
94
|
+
| GET | `/projects/:id/memory/threads` | List threads (dashboard) |
|
|
95
|
+
| POST | `/projects/:id/memory/threads` | Create a thread (dashboard) |
|
|
96
|
+
| GET | `/projects/:id/memory/threads/:threadId` | Get thread (dashboard) |
|
|
97
|
+
| PATCH | `/projects/:id/memory/threads/:threadId` | Update thread (dashboard) |
|
|
98
|
+
| DELETE | `/projects/:id/memory/threads/:threadId` | Delete thread (dashboard) |
|
|
99
|
+
| POST | `/projects/:id/memory/threads/:threadId/clone` | Clone thread (dashboard) |
|
|
100
|
+
| GET | `/projects/:id/memory/threads/:threadId/messages` | List messages (dashboard) |
|
|
101
|
+
| POST | `/projects/:id/memory/threads/:threadId/messages` | Save messages (dashboard) |
|
|
102
|
+
| DELETE | `/projects/:id/memory/threads/:threadId/messages` | Delete messages (dashboard) |
|
|
103
|
+
| GET | `/projects/:id/memory/threads/:threadId/observations/history` | Observation history (dashboard) |
|
|
104
|
+
| GET | `/models` | List available models |
|
|
105
|
+
|
|
106
|
+
## Gateway proxy endpoints
|
|
107
|
+
|
|
108
|
+
Visit the [Memory Gateway documentation](https://gateway.mastra.ai/docs) for more details.
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @mastra/mcp-docs-server
|
|
2
2
|
|
|
3
|
+
## 1.1.25-alpha.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies [[`8fad147`](https://github.com/mastra-ai/mastra/commit/8fad14759804179c8e080ce4d9dec6ef1a808b31), [`582644c`](https://github.com/mastra-ai/mastra/commit/582644c4a87f83b4f245a84d72b9e8590585012e), [`5d84914`](https://github.com/mastra-ai/mastra/commit/5d84914e0e520c642a40329b210b413fcd139898), [`fd2f314`](https://github.com/mastra-ai/mastra/commit/fd2f31473d3449b6b97e837ef8641264377f41a7), [`e80fead`](https://github.com/mastra-ai/mastra/commit/e80fead1412cc0d1b2f7d6a1ce5017d9e0098ff7), [`0287b64`](https://github.com/mastra-ai/mastra/commit/0287b644a5c3272755cf3112e71338106664103b)]:
|
|
8
|
+
- @mastra/core@1.25.0-alpha.1
|
|
9
|
+
|
|
10
|
+
## 1.1.25-alpha.0
|
|
11
|
+
|
|
12
|
+
### Patch Changes
|
|
13
|
+
|
|
14
|
+
- Updated dependencies [[`87df955`](https://github.com/mastra-ai/mastra/commit/87df955c028660c075873fd5d74af28233ce32eb), [`075e91a`](https://github.com/mastra-ai/mastra/commit/075e91a4549baf46ad7a42a6a8ac8dfa78cc09e6)]:
|
|
15
|
+
- @mastra/core@1.24.2-alpha.0
|
|
16
|
+
|
|
3
17
|
## 1.1.24
|
|
4
18
|
|
|
5
19
|
### Patch Changes
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mastra/mcp-docs-server",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.25-alpha.3",
|
|
4
4
|
"description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"jsdom": "^26.1.0",
|
|
30
30
|
"local-pkg": "^1.1.2",
|
|
31
31
|
"zod": "^4.3.6",
|
|
32
|
-
"@mastra/core": "1.
|
|
32
|
+
"@mastra/core": "1.25.0-alpha.1",
|
|
33
33
|
"@mastra/mcp": "^1.4.2"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
"vitest": "4.0.18",
|
|
49
49
|
"@internal/types-builder": "0.0.57",
|
|
50
50
|
"@internal/lint": "0.0.82",
|
|
51
|
-
"@mastra/core": "1.
|
|
51
|
+
"@mastra/core": "1.25.0-alpha.1"
|
|
52
52
|
},
|
|
53
53
|
"homepage": "https://mastra.ai",
|
|
54
54
|
"repository": {
|
|
@@ -1,77 +0,0 @@
|
|
|
1
|
-
# Deployment
|
|
2
|
-
|
|
3
|
-
Deploy your Mastra application to production and expose your agents, tools, and workflows as REST API endpoints.
|
|
4
|
-
|
|
5
|
-
> **Info:** Mastra Cloud is currently in beta, but many teams are already using it to deploy their agents. It's the easiest way to run Mastra agents in a managed environment.
|
|
6
|
-
|
|
7
|
-
## Enable deployments
|
|
8
|
-
|
|
9
|
-
After [setting up your project](https://mastra.ai/docs/mastra-cloud/setup), select **Deployment** in the sidebar and select **Enable Deployments**.
|
|
10
|
-
|
|
11
|
-
Once enabled, your project automatically builds and deploys. Future pushes to your main branch trigger automatic redeployments.
|
|
12
|
-
|
|
13
|
-
## Dashboard
|
|
14
|
-
|
|
15
|
-
The **Overview** page shows your project's domain URL, status, latest deployment, and connected agents and workflows.
|
|
16
|
-
|
|
17
|
-

|
|
18
|
-
|
|
19
|
-
Click the **Deployments** menu item to view build logs. Open **Settings** to configure environment variables, branch, storage, and endpoint URLs.
|
|
20
|
-
|
|
21
|
-
> **Note:** Changes to settings require a new deployment to take effect
|
|
22
|
-
|
|
23
|
-
## Storage configuration
|
|
24
|
-
|
|
25
|
-
Mastra Cloud offers two storage options:
|
|
26
|
-
|
|
27
|
-
1. **Mastra Cloud Store**: Managed storage provided by Mastra Cloud
|
|
28
|
-
2. **Bring your own database**: Connect to your own external database
|
|
29
|
-
|
|
30
|
-
### Using Mastra Cloud Store
|
|
31
|
-
|
|
32
|
-
When using the managed Mastra Cloud Store (enabled in your project settings), storage must be configured on the `Mastra` instance, not on individual agent `Memory` instances.
|
|
33
|
-
|
|
34
|
-
Configure storage on your Mastra instance:
|
|
35
|
-
|
|
36
|
-
```typescript
|
|
37
|
-
import { Mastra } from '@mastra/core'
|
|
38
|
-
import { LibSQLStore } from '@mastra/libsql'
|
|
39
|
-
|
|
40
|
-
export const mastra = new Mastra({
|
|
41
|
-
storage: new LibSQLStore({
|
|
42
|
-
id: 'mastra-store',
|
|
43
|
-
url: 'file:./mastra.db',
|
|
44
|
-
}),
|
|
45
|
-
agents: { myAgent },
|
|
46
|
-
})
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
Agents can use Memory without specifying storage as they inherit from the Mastra instance:
|
|
50
|
-
|
|
51
|
-
```typescript
|
|
52
|
-
import { Agent } from '@mastra/core/agent'
|
|
53
|
-
import { Memory } from '@mastra/memory'
|
|
54
|
-
|
|
55
|
-
export const myAgent = new Agent({
|
|
56
|
-
id: 'my-agent',
|
|
57
|
-
memory: new Memory({
|
|
58
|
-
// No storage here - uses instance-level storage from Mastra Cloud Store
|
|
59
|
-
options: {
|
|
60
|
-
lastMessages: 20,
|
|
61
|
-
},
|
|
62
|
-
}),
|
|
63
|
-
})
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
### Bring your own database
|
|
67
|
-
|
|
68
|
-
If you don't use Mastra Cloud Store, you can use any [storage provider](https://mastra.ai/docs/memory/storage) with any configuration. Set your database connection strings as environment variables in your project's **Settings** page.
|
|
69
|
-
|
|
70
|
-
## Using your deployment
|
|
71
|
-
|
|
72
|
-
After deployment, interact with your agents using the [Mastra Client](https://mastra.ai/docs/server/mastra-client) or call the REST API endpoints directly.
|
|
73
|
-
|
|
74
|
-
## Next steps
|
|
75
|
-
|
|
76
|
-
- [Studio](https://mastra.ai/docs/mastra-cloud/overview): Test your agents in the cloud
|
|
77
|
-
- [Observability](https://mastra.ai/docs/mastra-cloud/observability): Monitor traces and logs
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
# Observability
|
|
2
|
-
|
|
3
|
-
Cloud provides observability for production applications, giving you insight into how your agents and workflows behave. Observability works whether your application is deployed to Mastra Cloud, running locally, or hosted on your own infrastructure. Any Mastra project can send traces and logs to the platform regardless of where it's running.
|
|
4
|
-
|
|
5
|
-
For details on configuring observability, see the [Cloud Exporter](https://mastra.ai/docs/observability/tracing/exporters/cloud) docs.
|
|
6
|
-
|
|
7
|
-
## Traces
|
|
8
|
-
|
|
9
|
-
Traces are available for both agents and workflows by enabling [observability](https://mastra.ai/docs/observability/tracing/overview) using one of the [supported providers](https://mastra.ai/docs/observability/tracing/overview).
|
|
10
|
-
|
|
11
|
-
### Agents
|
|
12
|
-
|
|
13
|
-
With observability enabled, you can view detailed outputs from your agents in the **Traces** section in [Studio](https://mastra.ai/docs/mastra-cloud/overview).
|
|
14
|
-
|
|
15
|
-

|
|
16
|
-
|
|
17
|
-
Agent traces break a run into clear steps: model calls, tool calls, and intermediate chunks. Each includes timing, inputs, outputs, and errors. Drill into any span to inspect prompts, token usage, and results.
|
|
18
|
-
|
|
19
|
-
### Workflows
|
|
20
|
-
|
|
21
|
-
With observability enabled, you can view detailed outputs from your workflows in the **Traces** section in [Studio](https://mastra.ai/docs/mastra-cloud/overview).
|
|
22
|
-
|
|
23
|
-

|
|
24
|
-
|
|
25
|
-
Workflow traces capture each step in the run, including transitions, branching, timing, and any tool calls. Inspect inputs, outputs, and errors for every step to debug long-running or multi-step processes.
|
|
26
|
-
|
|
27
|
-
## Logs
|
|
28
|
-
|
|
29
|
-
The **Logs** page in the [project dashboard](https://mastra.ai/docs/mastra-cloud/deployment) displays detailed information for debugging and monitoring your application's behavior.
|
|
30
|
-
|
|
31
|
-

|
|
32
|
-
|
|
33
|
-
Each log entry includes its severity level and a detailed message showing agent, workflow, or storage activity.
|
|
34
|
-
|
|
35
|
-
## Next steps
|
|
36
|
-
|
|
37
|
-
- [Logging](https://mastra.ai/docs/observability/logging)
|
|
38
|
-
- [Tracing](https://mastra.ai/docs/observability/tracing/overview)
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
# Mastra Cloud
|
|
2
|
-
|
|
3
|
-
[Mastra Cloud](https://cloud.mastra.ai) is a platform for deploying, managing, and monitoring Mastra applications. [Import your project](https://mastra.ai/docs/mastra-cloud/setup) to get started.
|
|
4
|
-
|
|
5
|
-
## Studio
|
|
6
|
-
|
|
7
|
-
Run [Studio](https://mastra.ai/docs/studio/overview) in the cloud and share access with your team via a link. Team members can test agents and workflows, tweak system prompts, and give feedback without running the project locally.
|
|
8
|
-
|
|
9
|
-
## Deploy
|
|
10
|
-
|
|
11
|
-
Enable [deployments](https://mastra.ai/docs/mastra-cloud/deployment) and Mastra Cloud hosts your server for you. Connect your GitHub repository for automatic deployments whenever you push to your configured branch. Mastra Cloud exposes your agents, tools, and workflows as REST API endpoints.
|
|
12
|
-
|
|
13
|
-
Once deployed, the project dashboard gives you visibility into:
|
|
14
|
-
|
|
15
|
-
- Deployment status and history
|
|
16
|
-
- Build logs and configuration
|
|
17
|
-
- Environment variables and settings
|
|
18
|
-
|
|
19
|
-
## Observability
|
|
20
|
-
|
|
21
|
-
[Observability](https://mastra.ai/docs/mastra-cloud/observability) provides insight into how your agents and workflows behave in production. View detailed traces of agent runs, workflow executions, and logs to debug issues and understand performance.
|
|
22
|
-
|
|
23
|
-
> **Info:** You don’t need to deploy to Mastra Cloud to use Observability. You can send traces to Mastra from any environment
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
# Setup
|
|
2
|
-
|
|
3
|
-
Import your Mastra project to [Mastra Cloud](https://cloud.mastra.ai) to use [Studio](https://mastra.ai/docs/mastra-cloud/overview) and optionally [deploy](https://mastra.ai/docs/mastra-cloud/deployment) your agent.
|
|
4
|
-
|
|
5
|
-
## Before you begin
|
|
6
|
-
|
|
7
|
-
- [Sign in](https://cloud.mastra.ai) to Cloud
|
|
8
|
-
- Push your [Mastra project](https://mastra.ai/docs) to GitHub
|
|
9
|
-
|
|
10
|
-
## Options
|
|
11
|
-
|
|
12
|
-

|
|
13
|
-
|
|
14
|
-
When you create a new project, you can choose from three options:
|
|
15
|
-
|
|
16
|
-
1. **Create from GitHub** - Import a Mastra project from GitHub
|
|
17
|
-
2. **Create from your server** - Connect a self-hosted Mastra instance to [Studio](https://mastra.ai/docs/mastra-cloud/overview)
|
|
18
|
-
3. **Create from template** - Start from a [pre-built template](https://mastra.ai/templates)
|
|
19
|
-
|
|
20
|
-
To create a project from GitHub, follow these steps:
|
|
21
|
-
|
|
22
|
-
## Create from GitHub
|
|
23
|
-
|
|
24
|
-
1. Connect to GitHub when prompted
|
|
25
|
-
|
|
26
|
-

|
|
27
|
-
|
|
28
|
-
2. Search for your repository and click **Import**
|
|
29
|
-
|
|
30
|
-

|
|
31
|
-
|
|
32
|
-
3. Configure your project settings. Mastra Cloud auto-detects most settings, but you'll still need to enter the environment variables for your configured [model provider](https://mastra.ai/models):
|
|
33
|
-
|
|
34
|
-

|
|
35
|
-
|
|
36
|
-
4. Click **Create Project**
|
|
37
|
-
|
|
38
|
-
## Next steps
|
|
39
|
-
|
|
40
|
-
Once your project is imported, [Studio](https://mastra.ai/docs/mastra-cloud/overview) automatically creates a sandbox where you can interact with your agents and share access with your team.
|
|
41
|
-
|
|
42
|
-
When you're ready for production, enable [Deployment](https://mastra.ai/docs/mastra-cloud/deployment) settings and hit deploy!
|