@mastra/mcp-docs-server 0.13.37 → 0.13.38

package/.docs/raw/frameworks/servers/express.mdx

@@ -1,10 +1,8 @@
 ---
-title: "Getting started with Mastra and Express | Mastra Guides"
+title: "Integrate Mastra in your Express project | Frameworks | Mastra Docs"
 description: A step-by-step guide to integrating Mastra with an Express backend.
 ---
 
-import { Callout } from "nextra/components";
-
 # Integrate Mastra in your Express project
 
 Mastra integrates with Express, making it easy to:
@@ -33,81 +31,82 @@ npm install mastra@latest @mastra/core@latest @mastra/libsql@latest zod@^3.0.0 @
 
 If not existent yet, create an `.env` file and add your OpenAI API key:
 
-```bash filename=".env" copy
+```bash title=".env" copy
 OPENAI_API_KEY=<your-api-key>
 ```
 
-<Callout>
-Each LLM provider uses a different env var. See [Model Capabilities](/docs/getting-started/model-capability) for more information.
-</Callout>
+:::note
+
+Each LLM provider uses a different env var. See [Model Capabilities](https://sdk.vercel.ai/providers) for more information.
+
+:::
 
 Create a Mastra configuration file at `src/mastra/index.ts`:
 
-```ts filename="src/mastra/index.ts" copy
-import { Mastra } from '@mastra/core/mastra';
+```ts title="src/mastra/index.ts" copy
+import { Mastra } from "@mastra/core/mastra";
 
 export const mastra = new Mastra({});
 ```
 
 Create a `weatherTool` that the `weatherAgent` will use at `src/mastra/tools/weather-tool.ts`. It returns a placeholder value inside the `execute()` function (you'd put your API calls in here).
 
-```ts filename="src/mastra/tools/weather-tool.ts" copy
+```ts title="src/mastra/tools/weather-tool.ts" copy
 import { createTool } from "@mastra/core/tools";
 import { z } from "zod";
- 
+
 export const weatherTool = createTool({
   id: "get-weather",
   description: "Get current weather for a location",
   inputSchema: z.object({
-    location: z.string().describe("City name")
+    location: z.string().describe("City name"),
   }),
   outputSchema: z.object({
-    output: z.string()
+    output: z.string(),
   }),
   execute: async () => {
     return {
-      output: "The weather is sunny"
+      output: "The weather is sunny",
     };
-  }
+  },
 });
 ```
 
 Add a `weatherAgent` at `src/mastra/agents/weather-agent.ts`:
 
-```ts filename="src/mastra/agents/weather-agent.ts" copy
+```ts title="src/mastra/agents/weather-agent.ts" copy
 import { openai } from "@ai-sdk/openai";
 import { Agent } from "@mastra/core/agent";
 import { weatherTool } from "../tools/weather-tool";
- 
+
 export const weatherAgent = new Agent({
-  name: 'Weather Agent',
+  name: "Weather Agent",
   instructions: `
       You are a helpful weather assistant that provides accurate weather information.
- 
+
       Your primary function is to help users get weather details for specific locations. When responding:
       - Always ask for a location if none is provided
       - If the location name isn’t in English, please translate it
       - If giving a location with multiple parts (e.g. "New York, NY"), use the most relevant part (e.g. "New York")
       - Include relevant details like humidity, wind conditions, and precipitation
       - Keep responses concise but informative
- 
+
       Use the weatherTool to fetch current weather data.
 `,
-  model: openai('gpt-4o-mini'),
-  tools: { weatherTool }
+  model: openai("gpt-4o-mini"),
+  tools: { weatherTool },
 });
 ```
 
 Lastly, add the `weatherAgent` to `src/mastra/index.ts`:
 
-```ts filename="src/mastra/index.ts" copy {2, 5}
-import { Mastra } from '@mastra/core/mastra';
-import { weatherAgent } from './agents/weather-agent';
+```ts title="src/mastra/index.ts" copy {2, 5}
+import { Mastra } from "@mastra/core/mastra";
+import { weatherAgent } from "./agents/weather-agent";
 
 export const mastra = new Mastra({
   agents: { weatherAgent },
 });
-
 ```
 
 Now you're done with setting up the Mastra boilerplate code and are ready to integrate it into your Express routes.
@@ -118,14 +117,14 @@ Create an `/api/weather` endpoint that expects a `city` query parameter. The `ci
 
 You might have a file like this in your existing project:
 
-```ts filename="src/server.ts" copy
-import express, { Request, Response } from 'express';
+```ts title="src/server.ts" copy
+import express, { Request, Response } from "express";
 
 const app = express();
 const port = 3456;
 
-app.get('/', (req: Request, res: Response) => {
-  res.send('Hello, world!');
+app.get("/", (req: Request, res: Response) => {
+  res.send("Hello, world!");
 });
 
 app.listen(port, () => {
@@ -135,26 +134,26 @@ app.listen(port, () => {
 
 Adding the `/api/weather` endpoint looks like this:
 
-```ts filename="src/server.ts" copy {2, 11-27}
-import express, { Request, Response } from 'express';
-import { mastra } from "./mastra"
+```ts title="src/server.ts" copy {2, 11-27}
+import express, { Request, Response } from "express";
+import { mastra } from "./mastra";
 
 const app = express();
 const port = 3456;
 
-app.get('/', (req: Request, res: Response) => {
-  res.send('Hello, world!');
+app.get("/", (req: Request, res: Response) => {
+  res.send("Hello, world!");
 });
 
 app.get("/api/weather", async (req: Request, res: Response) => {
   const { city } = req.query as { city?: string };
- 
+
   if (!city) {
     return res.status(400).send("Missing 'city' query parameter");
   }
- 
+
   const agent = mastra.getAgent("weatherAgent");
- 
+
   try {
     const result = await agent.generate(`What's the weather like in ${city}?`);
     res.send(result.text);
@@ -169,11 +168,13 @@ app.listen(port, () => {
 });
 ```
 
-By importing the `src/mastra/index.ts` file you can use methods like [`.getAgent()`](/reference/agents/getAgent) to get programmatic access. With [`.generate()`](/reference/agents/generate) you then can interact with the respective agent.
+By importing the `src/mastra/index.ts` file you can use methods like [`.getAgent()`](/reference/core/getAgent) to get programmatic access. With [`.generate()`](/reference/agents/generate) you then can interact with the respective agent.
+
+:::note
 
-<Callout>
 Read the [Agent reference docs](/reference/agents/agent) to learn more.
-</Callout>
+
+:::
 
 Start your Express server and visit the `/api/weather` endpoint. For example:
 
@@ -189,15 +190,15 @@ The weather in London is currently sunny. If you need more details like humidity
 
 ## Running the Agent Server
 
-In production it's not necessary to run Mastra alongside your Express server. But for development Mastra offers a [Local Development Environment](/docs/server-db/local-dev-playground) which you can use to improve and debug your agent.
+In production it's not necessary to run Mastra alongside your Express server. But for development Mastra offers a [Local Development Environment](/docs/getting-started/studio) which you can use to improve and debug your agent.
 
 Add a script to your `package.json`:
 
-```json filename="package.json" copy
+```json title="package.json" copy
 {
   "scripts": {
     "mastra:dev": "mastra dev"
-  },
+  }
 }
 ```