Server Overview
Mastra runs as an HTTP server that exposes your agents, workflows, and other functionality as API endpoints. The server handles request routing, middleware execution, authentication, and streaming responses.
This page covers the server configuration options passed to the Mastra constructor. For running Mastra with your own HTTP server (Hono, Express, etc.), visit Server Adapters.
Server architectureDirect link to Server architecture
Mastra uses Hono as its underlying HTTP server framework. When you build a Mastra application using mastra build, it generates a Hono-based HTTP server in the .mastra directory.
The server provides:
- API endpoints for all registered agents and workflows
- Custom API routes and middleware
- Authentication with multiple providers
- Request context for dynamic configuration
- Stream data redaction for secure responses
ConfigurationDirect link to Configuration
Configure the server by passing a server object to the Mastra constructor:
import { Mastra } from "@mastra/core";
export const mastra = new Mastra({
server: {
port: 3000, // Defaults to 4111
host: "0.0.0.0", // Defaults to 'localhost'
},
});
Visit the configuration reference for a full list of available server options.
Server featuresDirect link to Server features
- Middleware: Intercept requests for authentication, logging, CORS, or injecting request-specific context.
- Custom API Routes: Extend the server with your own HTTP endpoints that have access to the Mastra instance.
- Request Context: Pass request-specific values to agents, tools, and workflows based on runtime conditions.
- Server Adapters: Run Mastra with Express, Hono, or your own HTTP server instead of the generated server.
- Custom Adapters: Build adapters for frameworks not officially supported.
- Mastra Client SDK: Type-safe client for calling agents, workflows, and tools from browser or server environments.
- Authentication: Secure endpoints with JWT, Clerk, Supabase, Firebase, Auth0, or WorkOS.
Stream data redactionDirect link to Stream data redaction
When streaming agent responses, the HTTP layer redacts system prompts, tool definitions, API keys, and similar data from each chunk before sending it to clients. This is enabled by default.
This behavior is only configurable by using server adapters. For server adapters, stream data redaction is enabled by default, too.
TypeScript configurationDirect link to TypeScript configuration
Mastra requires module and moduleResolution settings compatible with modern Node.js. Legacy options like CommonJS or node are not supported.
{
"compilerOptions": {
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "bundler",
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"strict": true,
"skipLibCheck": true,
"noEmit": true,
"outDir": "dist"
},
"include": ["src/**/*"]
}