@mastra/mcp-docs-server 1.1.7-alpha.0 → 1.1.8-alpha.0

package/.docs/reference/rag/rerankWithScorer.md

@@ -35,45 +35,53 @@ const rerankedResults = await rerank({
 
 ## Parameters
 
-**results:** (`QueryResult[]`): The vector search results to rerank
+**results** (`QueryResult[]`): The vector search results to rerank
 
-**query:** (`string`): The search query text used to evaluate relevance
+**query** (`string`): The search query text used to evaluate relevance
 
-**scorer:** (`RelevanceScoreProvider`): The relevance scorer to use for reranking
+**scorer** (`RelevanceScoreProvider`): The relevance scorer to use for reranking
 
-**options?:** (`RerankerFunctionOptions`): Options for the reranking model
+**options** (`RerankerFunctionOptions`): Options for the reranking model
 
-The `rerankWithScorer` function accepts any `RelevanceScoreProvider` from @mastra/rag.
+**options.weights** (`WeightConfig`): Weights for different scoring components (must add up to 1)
 
-> **Note:** For semantic scoring to work properly during re-ranking, each result must include the text content in its `metadata.text` field.
+**options.weights.semantic** (`number (default: 0.4)`): Weight for semantic relevance
+
+**options.weights.vector** (`number (default: 0.4)`): Weight for vector similarity
+
+**options.weights.position** (`number (default: 0.2)`): Weight for position-based scoring
 
-### RerankerFunctionOptions
+**options.queryEmbedding** (`number[]`): Embedding of the query
 
-**weights?:** (`WeightConfig`): numbersemantic?:number (default: 0.4)Weight for semantic relevancenumbervector?:number (default: 0.4)Weight for vector similaritynumberposition?:number (default: 0.2)Weight for position-based scoring
+**options.topK** (`number`): Number of top results to return
 
-**queryEmbedding?:** (`number[]`): Embedding of the query
+The `rerankWithScorer` function accepts any `RelevanceScoreProvider` from @mastra/rag.
 
-**topK?:** (`number`): Number of top results to return (Default: `3`)
+> **Note:** For semantic scoring to work properly during re-ranking, each result must include the text content in its `metadata.text` field.
 
 ## Returns
 
 The function returns an array of `RerankResult` objects:
 
-**result:** (`QueryResult`): The original query result
+**result** (`QueryResult`): The original query result
 
-**score:** (`number`): Combined reranking score (0-1)
+**score** (`number`): Combined reranking score (0-1)
 
-**details:** (`ScoringDetails`): Detailed scoring information
+**details** (`ScoringDetails`): Detailed scoring information
 
 ### ScoringDetails
 
-**semantic:** (`number`): Semantic relevance score (0-1)
+**semantic** (`number`): Semantic relevance score (0-1)
+
+**vector** (`number`): Vector similarity score (0-1)
+
+**position** (`number`): Position-based score (0-1)
 
-**vector:** (`number`): Vector similarity score (0-1)
+**queryAnalysis** (`object`): Query analysis details
 
-**position:** (`number`): Position-based score (0-1)
+**queryAnalysis.magnitude**: Magnitude of the query
 
-**queryAnalysis?:** (`object`): numbermagnitude:Magnitude of the querynumber\[]dominantFeatures:Dominant features of the query
+**queryAnalysis.dominantFeatures**: Dominant features of the query
 
 ## Related
 

package/.docs/reference/server/create-route.md

@@ -18,33 +18,33 @@ function createRoute<TPath, TQuery, TBody, TResponse, TResponseType>(
 
 ## Parameters
 
-**method:** (`'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'ALL'`): HTTP method
+**method** (`'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'ALL'`): HTTP method
 
-**path:** (`string`): Route path with optional params (e.g., \`/api/items/:id\`)
+**path** (`string`): Route path with optional params (e.g., \`/api/items/:id\`)
 
-**responseType:** (`'json' | 'stream'`): Response format. Internal routes may use additional types (\`datastream-response\`, \`mcp-http\`, \`mcp-sse\`).
+**responseType** (`'json' | 'stream'`): Response format. Internal routes may use additional types (\`datastream-response\`, \`mcp-http\`, \`mcp-sse\`).
 
-**handler:** (`ServerRouteHandler`): Route handler function
+**handler** (`ServerRouteHandler`): Route handler function
 
-**pathParamSchema?:** (`ZodSchema`): Validates URL path parameters
+**pathParamSchema** (`ZodSchema`): Validates URL path parameters
 
-**queryParamSchema?:** (`ZodSchema`): Validates query string parameters
+**queryParamSchema** (`ZodSchema`): Validates query string parameters
 
-**bodySchema?:** (`ZodSchema`): Validates request body
+**bodySchema** (`ZodSchema`): Validates request body
 
-**responseSchema?:** (`ZodSchema`): Documents response shape for OpenAPI
+**responseSchema** (`ZodSchema`): Documents response shape for OpenAPI
 
-**streamFormat?:** (`'sse' | 'stream'`): Stream format (when responseType is 'stream')
+**streamFormat** (`'sse' | 'stream'`): Stream format (when responseType is 'stream')
 
-**maxBodySize?:** (`number`): Override default body size limit in bytes
+**maxBodySize** (`number`): Override default body size limit in bytes
 
-**summary?:** (`string`): OpenAPI summary
+**summary** (`string`): OpenAPI summary
 
-**description?:** (`string`): OpenAPI description
+**description** (`string`): OpenAPI description
 
-**tags?:** (`string[]`): OpenAPI tags
+**tags** (`string[]`): OpenAPI tags
 
-**deprecated?:** (`boolean`): Mark route as deprecated
+**deprecated** (`boolean`): Mark route as deprecated
 
 ## Handler parameters
 

package/.docs/reference/server/express-adapter.md

@@ -54,25 +54,25 @@ app.listen(4111, () => {
 
 ## Constructor parameters
 
-**app:** (`Application`): Express app instance
+**app** (`Application`): Express app instance
 
-**mastra:** (`Mastra`): Mastra instance
+**mastra** (`Mastra`): Mastra instance
 
-**prefix?:** (`string`): Route path prefix (e.g., \`/api/v2\`) (Default: `''`)
+**prefix** (`string`): Route path prefix (e.g., \`/api/v2\`) (Default: `''`)
 
-**openapiPath?:** (`string`): Path to serve OpenAPI spec (e.g., \`/openapi.json\`) (Default: `''`)
+**openapiPath** (`string`): Path to serve OpenAPI spec (e.g., \`/openapi.json\`) (Default: `''`)
 
-**bodyLimitOptions?:** (`{ maxSize: number, onError: (err) => unknown }`): Request body size limits
+**bodyLimitOptions** (`{ maxSize: number, onError: (err) => unknown }`): Request body size limits
 
-**streamOptions?:** (`{ redact?: boolean }`): Stream redaction config. When true, redacts sensitive data from streams. (Default: `{ redact: true }`)
+**streamOptions** (`{ redact?: boolean }`): Stream redaction config. When true, redacts sensitive data from streams. (Default: `{ redact: true }`)
 
-**customRouteAuthConfig?:** (`Map<string, boolean>`): Per-route auth overrides. Keys are \`METHOD:PATH\` (e.g., \`GET:/api/health\`). Value \`false\` makes route public, \`true\` requires auth.
+**customRouteAuthConfig** (`Map<string, boolean>`): Per-route auth overrides. Keys are \`METHOD:PATH\` (e.g., \`GET:/api/health\`). Value \`false\` makes route public, \`true\` requires auth.
 
-**tools?:** (`Record<string, Tool>`): Available tools for the server
+**tools** (`Record<string, Tool>`): Available tools for the server
 
-**taskStore?:** (`InMemoryTaskStore`): Task store for A2A (Agent-to-Agent) operations
+**taskStore** (`InMemoryTaskStore`): Task store for A2A (Agent-to-Agent) operations
 
-**mcpOptions?:** (`MCPOptions`): MCP transport options. Set \`serverless: true\` for stateless environments like Cloudflare Workers or Vercel Edge.
+**mcpOptions** (`MCPOptions`): MCP transport options. Set \`serverless: true\` for stateless environments like Cloudflare Workers or Vercel Edge.
 
 ## Differences from Hono
 

package/.docs/reference/server/fastify-adapter.md

@@ -55,25 +55,25 @@ app.listen({ port: 3000 }, (err, address) => {
 
 ## Constructor parameters
 
-**app:** (`FastifyInstance`): Fastify app instance
+**app** (`FastifyInstance`): Fastify app instance
 
-**mastra:** (`Mastra`): Mastra instance
+**mastra** (`Mastra`): Mastra instance
 
-**prefix?:** (`string`): Route path prefix (e.g., \`/api/v2\`) (Default: `''`)
+**prefix** (`string`): Route path prefix (e.g., \`/api/v2\`) (Default: `''`)
 
-**openapiPath?:** (`string`): Path to serve OpenAPI spec (e.g., \`/openapi.json\`) (Default: `''`)
+**openapiPath** (`string`): Path to serve OpenAPI spec (e.g., \`/openapi.json\`) (Default: `''`)
 
-**bodyLimitOptions?:** (`BodyLimitOptions`): Request body size limits
+**bodyLimitOptions** (`BodyLimitOptions`): Request body size limits
 
-**streamOptions?:** (`StreamOptions`): Stream redaction config. When true (default), redacts sensitive data (system prompts, tool definitions, API keys) from stream chunks before sending to clients. (Default: `{ redact: true }`)
+**streamOptions** (`StreamOptions`): Stream redaction config. When true (default), redacts sensitive data (system prompts, tool definitions, API keys) from stream chunks before sending to clients. (Default: `{ redact: true }`)
 
-**customRouteAuthConfig?:** (`Map<string, boolean>`): Per-route auth overrides. Keys are \`METHOD:PATH\` (e.g., \`GET:/api/health\`). Value \`false\` makes route public, \`true\` requires auth.
+**customRouteAuthConfig** (`Map<string, boolean>`): Per-route auth overrides. Keys are \`METHOD:PATH\` (e.g., \`GET:/api/health\`). Value \`false\` makes route public, \`true\` requires auth.
 
-**tools?:** (`ToolsInput`): Available tools for the server
+**tools** (`ToolsInput`): Available tools for the server
 
-**taskStore?:** (`InMemoryTaskStore`): Task store for A2A (Agent-to-Agent) operations
+**taskStore** (`InMemoryTaskStore`): Task store for A2A (Agent-to-Agent) operations
 
-**mcpOptions?:** (`MCPOptions`): MCP transport options. Set \`serverless: true\` for stateless environments like Cloudflare Workers or Vercel Edge.
+**mcpOptions** (`MCPOptions`): MCP transport options. Set \`serverless: true\` for stateless environments like Cloudflare Workers or Vercel Edge.
 
 ## Manual initialization
 

package/.docs/reference/server/hono-adapter.md

@@ -49,25 +49,25 @@ export default app
 
 ## Constructor parameters
 
-**app:** (`Hono`): Hono app instance
+**app** (`Hono`): Hono app instance
 
-**mastra:** (`Mastra`): Mastra instance
+**mastra** (`Mastra`): Mastra instance
 
-**prefix?:** (`string`): Route path prefix (e.g., \`/api/v2\`) (Default: `''`)
+**prefix** (`string`): Route path prefix (e.g., \`/api/v2\`) (Default: `''`)
 
-**openapiPath?:** (`string`): Path to serve OpenAPI spec (e.g., \`/openapi.json\`) (Default: `''`)
+**openapiPath** (`string`): Path to serve OpenAPI spec (e.g., \`/openapi.json\`) (Default: `''`)
 
-**bodyLimitOptions?:** (`{ maxSize: number, onError: (err) => unknown }`): Request body size limits
+**bodyLimitOptions** (`{ maxSize: number, onError: (err) => unknown }`): Request body size limits
 
-**streamOptions?:** (`{ redact?: boolean }`): Stream redaction config. When true, redacts sensitive data from streams. (Default: `{ redact: true }`)
+**streamOptions** (`{ redact?: boolean }`): Stream redaction config. When true, redacts sensitive data from streams. (Default: `{ redact: true }`)
 
-**customRouteAuthConfig?:** (`Map<string, boolean>`): Per-route auth overrides. Keys are \`METHOD:PATH\` (e.g., \`GET:/api/health\`). Value \`false\` makes route public, \`true\` requires auth.
+**customRouteAuthConfig** (`Map<string, boolean>`): Per-route auth overrides. Keys are \`METHOD:PATH\` (e.g., \`GET:/api/health\`). Value \`false\` makes route public, \`true\` requires auth.
 
-**tools?:** (`Record<string, Tool>`): Available tools for the server
+**tools** (`Record<string, Tool>`): Available tools for the server
 
-**taskStore?:** (`InMemoryTaskStore`): Task store for A2A (Agent-to-Agent) operations
+**taskStore** (`InMemoryTaskStore`): Task store for A2A (Agent-to-Agent) operations
 
-**mcpOptions?:** (`MCPOptions`): MCP transport options. Set \`serverless: true\` for stateless environments like Cloudflare Workers or Vercel Edge.
+**mcpOptions** (`MCPOptions`): MCP transport options. Set \`serverless: true\` for stateless environments like Cloudflare Workers or Vercel Edge.
 
 ## Adding custom routes
 

package/.docs/reference/server/koa-adapter.md

@@ -54,25 +54,25 @@ app.listen(3000, () => {
 
 ## Constructor parameters
 
-**app:** (`Koa`): Koa app instance
+**app** (`Koa`): Koa app instance
 
-**mastra:** (`Mastra`): Mastra instance
+**mastra** (`Mastra`): Mastra instance
 
-**prefix?:** (`string`): Route path prefix (e.g., \`/api/v2\`) (Default: `''`)
+**prefix** (`string`): Route path prefix (e.g., \`/api/v2\`) (Default: `''`)
 
-**openapiPath?:** (`string`): Path to serve OpenAPI spec (e.g., \`/openapi.json\`) (Default: `''`)
+**openapiPath** (`string`): Path to serve OpenAPI spec (e.g., \`/openapi.json\`) (Default: `''`)
 
-**bodyLimitOptions?:** (`BodyLimitOptions`): Request body size limits
+**bodyLimitOptions** (`BodyLimitOptions`): Request body size limits
 
-**streamOptions?:** (`StreamOptions`): Stream redaction config. When true (default), redacts sensitive data (system prompts, tool definitions, API keys) from stream chunks before sending to clients. (Default: `{ redact: true }`)
+**streamOptions** (`StreamOptions`): Stream redaction config. When true (default), redacts sensitive data (system prompts, tool definitions, API keys) from stream chunks before sending to clients. (Default: `{ redact: true }`)
 
-**customRouteAuthConfig?:** (`Map<string, boolean>`): Per-route auth overrides. Keys are \`METHOD:PATH\` (e.g., \`GET:/api/health\`). Value \`false\` makes route public, \`true\` requires auth.
+**customRouteAuthConfig** (`Map<string, boolean>`): Per-route auth overrides. Keys are \`METHOD:PATH\` (e.g., \`GET:/api/health\`). Value \`false\` makes route public, \`true\` requires auth.
 
-**tools?:** (`ToolsInput`): Available tools for the server
+**tools** (`ToolsInput`): Available tools for the server
 
-**taskStore?:** (`InMemoryTaskStore`): Task store for A2A (Agent-to-Agent) operations
+**taskStore** (`InMemoryTaskStore`): Task store for A2A (Agent-to-Agent) operations
 
-**mcpOptions?:** (`MCPOptions`): MCP transport options. Set \`serverless: true\` for stateless environments like Cloudflare Workers or Vercel Edge.
+**mcpOptions** (`MCPOptions`): MCP transport options. Set \`serverless: true\` for stateless environments like Cloudflare Workers or Vercel Edge.
 
 ## Error handling
 

package/.docs/reference/server/mastra-server.md

@@ -28,25 +28,25 @@ constructor(options: MastraServerOptions<TApp>)
 
 ### Options
 
-**app:** (`TApp`): Framework app instance
+**app** (`TApp`): Framework app instance
 
-**mastra:** (`Mastra`): Mastra instance
+**mastra** (`Mastra`): Mastra instance
 
-**prefix?:** (`string`): Route path prefix (e.g., \`/api/v2\`) (Default: `''`)
+**prefix** (`string`): Route path prefix (e.g., \`/api/v2\`) (Default: `''`)
 
-**openapiPath?:** (`string`): Path to serve OpenAPI spec (Default: `''`)
+**openapiPath** (`string`): Path to serve OpenAPI spec (Default: `''`)
 
-**bodyLimitOptions?:** (`BodyLimitOptions`): Request body size limits
+**bodyLimitOptions** (`BodyLimitOptions`): Request body size limits
 
-**streamOptions?:** (`StreamOptions`): Stream redaction config (Default: `{ redact: true }`)
+**streamOptions** (`StreamOptions`): Stream redaction config (Default: `{ redact: true }`)
 
-**customRouteAuthConfig?:** (`Map<string, boolean>`): Per-route auth overrides
+**customRouteAuthConfig** (`Map<string, boolean>`): Per-route auth overrides
 
-**tools?:** (`Record<string, Tool>`): Available tools for the server
+**tools** (`Record<string, Tool>`): Available tools for the server
 
-**taskStore?:** (`InMemoryTaskStore`): Task store for A2A (Agent-to-Agent) operations
+**taskStore** (`InMemoryTaskStore`): Task store for A2A (Agent-to-Agent) operations
 
-**mcpOptions?:** (`MCPOptions`): MCP transport options for serverless environments
+**mcpOptions** (`MCPOptions`): MCP transport options for serverless environments
 
 ## Abstract methods
 

package/.docs/reference/server/register-api-route.md

@@ -22,35 +22,35 @@ registerApiRoute("/items/:itemId", { ... })
 
 ### options
 
-**method:** (`'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'ALL'`): HTTP method for the route
+**method** (`'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'ALL'`): HTTP method for the route
 
-**handler?:** (`Handler`): Route handler function receiving Hono Context. Use either \`handler\` or \`createHandler\`, not both.
+**handler** (`Handler`): Route handler function receiving Hono Context. Use either \`handler\` or \`createHandler\`, not both.
 
-**createHandler?:** (`(c: Context) => Promise<Handler>`): Async factory function to create the handler. Use either \`handler\` or \`createHandler\`, not both.
+**createHandler** (`(c: Context) => Promise<Handler>`): Async factory function to create the handler. Use either \`handler\` or \`createHandler\`, not both.
 
-**middleware?:** (`MiddlewareHandler | MiddlewareHandler[]`): Route-specific middleware functions
+**middleware** (`MiddlewareHandler | MiddlewareHandler[]`): Route-specific middleware functions
 
-**openapi?:** (`DescribeRouteOptions`): OpenAPI metadata for Swagger UI documentation
+**openapi** (`DescribeRouteOptions`): OpenAPI metadata for Swagger UI documentation
 
 ## OpenAPI Options
 
 The `openapi` property accepts standard OpenAPI 3.1 operation fields from [hono-openapi](https://github.com/honojs/middleware/tree/main/packages/openapi). Routes without an `openapi` property are not included in Swagger UI.
 
-**summary?:** (`string`): Short summary of the operation
+**summary** (`string`): Short summary of the operation
 
-**description?:** (`string`): Detailed description of the operation
+**description** (`string`): Detailed description of the operation
 
-**tags?:** (`string[]`): Tags for grouping in Swagger UI. Defaults to \['custom'] if not specified.
+**tags** (`string[]`): Tags for grouping in Swagger UI. Defaults to \['custom'] if not specified.
 
-**deprecated?:** (`boolean`): Mark the operation as deprecated
+**deprecated** (`boolean`): Mark the operation as deprecated
 
-**parameters?:** (`ParameterObject[]`): Path, query, and header parameters
+**parameters** (`ParameterObject[]`): Path, query, and header parameters
 
-**requestBody?:** (`RequestBodyObject`): Request body specification
+**requestBody** (`RequestBodyObject`): Request body specification
 
-**responses?:** (`ResponsesObject`): Response specifications by status code
+**responses** (`ResponsesObject`): Response specifications by status code
 
-**security?:** (`SecurityRequirementObject[]`): Security requirements for the operation
+**security** (`SecurityRequirementObject[]`): Security requirements for the operation
 
 ## Return Value
 

package/.docs/reference/storage/cloudflare-d1.md

@@ -129,15 +129,15 @@ Or in `wrangler.jsonc`:
 
 ## Parameters
 
-**binding?:** (`D1Database`): Cloudflare D1 Workers binding (for Workers runtime)
+**binding** (`D1Database`): Cloudflare D1 Workers binding (for Workers runtime)
 
-**accountId?:** (`string`): Cloudflare Account ID (for REST API)
+**accountId** (`string`): Cloudflare Account ID (for REST API)
 
-**databaseId?:** (`string`): Cloudflare D1 Database ID (for REST API)
+**databaseId** (`string`): Cloudflare D1 Database ID (for REST API)
 
-**apiToken?:** (`string`): Cloudflare API Token (for REST API)
+**apiToken** (`string`): Cloudflare API Token (for REST API)
 
-**tablePrefix?:** (`string`): Optional prefix for all table names (useful for environment isolation)
+**tablePrefix** (`string`): Optional prefix for all table names (useful for environment isolation)
 
 ## Additional Notes
 

package/.docs/reference/storage/cloudflare.md

@@ -57,17 +57,17 @@ const storageRest = new CloudflareStore({
 
 ## Parameters
 
-**id:** (`string`): Unique identifier for this storage instance.
+**id** (`string`): Unique identifier for this storage instance.
 
-**bindings?:** (`Record<string, KVNamespace>`): Cloudflare Workers KV bindings (for Workers runtime)
+**bindings** (`Record<string, KVNamespace>`): Cloudflare Workers KV bindings (for Workers runtime)
 
-**accountId?:** (`string`): Cloudflare Account ID (for REST API)
+**accountId** (`string`): Cloudflare Account ID (for REST API)
 
-**apiToken?:** (`string`): Cloudflare API Token (for REST API)
+**apiToken** (`string`): Cloudflare API Token (for REST API)
 
-**namespacePrefix?:** (`string`): Optional prefix for all namespace names (useful for environment isolation)
+**namespacePrefix** (`string`): Optional prefix for all namespace names (useful for environment isolation)
 
-**keyPrefix?:** (`string`): Optional prefix for all keys (useful for environment isolation)
+**keyPrefix** (`string`): Optional prefix for all keys (useful for environment isolation)
 
 ### Additional Notes
 

package/.docs/reference/storage/composite.md

@@ -120,23 +120,23 @@ export const mastra = new Mastra({
 
 ## Options
 
-**id:** (`string`): Unique identifier for this storage instance.
+**id** (`string`): Unique identifier for this storage instance.
 
-**default?:** (`MastraCompositeStore`): Default storage adapter. Domains not explicitly specified in \`domains\` will use this storage's domains as fallbacks.
+**default** (`MastraCompositeStore`): Default storage adapter. Domains not explicitly specified in \`domains\` will use this storage's domains as fallbacks.
 
-**domains?:** (`object`): Individual domain overrides. Each domain can come from a different storage adapter. These take precedence over the default storage.
+**domains** (`object`): Individual domain overrides. Each domain can come from a different storage adapter. These take precedence over the default storage.
 
-**domains.memory?:** (`MemoryStorage`): Storage for threads, messages, and resources.
+**domains.memory** (`MemoryStorage`): Storage for threads, messages, and resources.
 
-**domains.workflows?:** (`WorkflowsStorage`): Storage for workflow snapshots.
+**domains.workflows** (`WorkflowsStorage`): Storage for workflow snapshots.
 
-**domains.scores?:** (`ScoresStorage`): Storage for evaluation scores.
+**domains.scores** (`ScoresStorage`): Storage for evaluation scores.
 
-**domains.observability?:** (`ObservabilityStorage`): Storage for traces and spans.
+**domains.observability** (`ObservabilityStorage`): Storage for traces and spans.
 
-**domains.agents?:** (`AgentsStorage`): Storage for stored agent configurations.
+**domains.agents** (`AgentsStorage`): Storage for stored agent configurations.
 
-**disableInit?:** (`boolean`): When true, automatic initialization is disabled. You must call init() explicitly.
+**disableInit** (`boolean`): When true, automatic initialization is disabled. You must call init() explicitly.
 
 ## Initialization
 

package/.docs/reference/storage/convex.md

@@ -97,11 +97,11 @@ const storage = new ConvexStore({
 
 ## Parameters
 
-**deploymentUrl:** (`string`): Convex deployment URL (e.g., https\://your-project.convex.cloud)
+**deploymentUrl** (`string`): Convex deployment URL (e.g., https\://your-project.convex.cloud)
 
-**adminAuthToken:** (`string`): Convex admin authentication token for backend access
+**adminAuthToken** (`string`): Convex admin authentication token for backend access
 
-**storageFunction?:** (`string`): Path to the storage mutation function (default: 'mastra/storage:handle') (Default: `mastra/storage:handle`)
+**storageFunction** (`string`): Path to the storage mutation function (default: 'mastra/storage:handle') (Default: `mastra/storage:handle`)
 
 ## Constructor Examples
 

package/.docs/reference/storage/dynamodb.md

@@ -108,17 +108,17 @@ For local development, you can use [DynamoDB Local](https://docs.aws.amazon.com/
 
 ## Parameters
 
-**id:** (`string`): Unique identifier for this storage instance.
+**id** (`string`): Unique identifier for this storage instance.
 
-**config.tableName:** (`string`): The name of your DynamoDB table.
+**config.tableName** (`string`): The name of your DynamoDB table.
 
-**config.region?:** (`string`): AWS region. Defaults to 'us-east-1'. For local development, can be set to 'localhost' or similar.
+**config.region** (`string`): AWS region. Defaults to 'us-east-1'. For local development, can be set to 'localhost' or similar.
 
-**config.endpoint?:** (`string`): Custom endpoint for DynamoDB (e.g., 'http\://localhost:8000' for local development).
+**config.endpoint** (`string`): Custom endpoint for DynamoDB (e.g., 'http\://localhost:8000' for local development).
 
-**config.credentials?:** (`object`): AWS credentials object with \`accessKeyId\` and \`secretAccessKey\`. If not provided, the AWS SDK will attempt to source credentials from environment variables, IAM roles (e.g., for EC2/Lambda), or the shared AWS credentials file.
+**config.credentials** (`object`): AWS credentials object with \`accessKeyId\` and \`secretAccessKey\`. If not provided, the AWS SDK will attempt to source credentials from environment variables, IAM roles (e.g., for EC2/Lambda), or the shared AWS credentials file.
 
-**config.ttl?:** (`object`): TTL (Time To Live) configuration for automatic data expiration. Configure per entity type: thread, message, trace, eval, workflow\_snapshot, resource, score. Each entity config includes: enabled (boolean), attributeName (string, default: 'ttl'), defaultTtlSeconds (number).
+**config.ttl** (`object`): TTL (Time To Live) configuration for automatic data expiration. Configure per entity type: thread, message, trace, eval, workflow\_snapshot, resource, score. Each entity config includes: enabled (boolean), attributeName (string, default: 'ttl'), defaultTtlSeconds (number).
 
 ## TTL (Time To Live) Configuration
 
@@ -188,11 +188,11 @@ TTL can be configured for these entity types:
 
 Each entity type accepts the following configuration:
 
-**enabled:** (`boolean`): Whether TTL is enabled for this entity type.
+**enabled** (`boolean`): Whether TTL is enabled for this entity type.
 
-**attributeName?:** (`string`): The DynamoDB attribute name to use for TTL. Must match the TTL attribute configured on your DynamoDB table. Defaults to 'ttl'.
+**attributeName** (`string`): The DynamoDB attribute name to use for TTL. Must match the TTL attribute configured on your DynamoDB table. Defaults to 'ttl'.
 
-**defaultTtlSeconds?:** (`number`): Default TTL in seconds from item creation time. Items will be automatically deleted by DynamoDB after this duration.
+**defaultTtlSeconds** (`number`): Default TTL in seconds from item creation time. Items will be automatically deleted by DynamoDB after this duration.
 
 ### Enabling TTL on Your DynamoDB Table
 

package/.docs/reference/storage/lance.md

@@ -53,11 +53,11 @@ const storage = await LanceStorage.create('my-storage', 's3://bucket/db', {
 
 ### LanceStorage.create()
 
-**name:** (`string`): Name identifier for the storage instance
+**name** (`string`): Name identifier for the storage instance
 
-**uri:** (`string`): URI to connect to the LanceDB database. Can be a local path, cloud DB URL, or S3 bucket URL
+**uri** (`string`): URI to connect to the LanceDB database. Can be a local path, cloud DB URL, or S3 bucket URL
 
-**options?:** (`ConnectionOptions`): Connection options for LanceDB, such as timeout settings, authentication, etc.
+**options** (`ConnectionOptions`): Connection options for LanceDB, such as timeout settings, authentication, etc.
 
 ## Additional Notes
 

package/.docs/reference/storage/libsql.md

@@ -89,9 +89,9 @@ storage: new LibSQLStore({
 
 ## Options
 
-**url:** (`string`): Database URL. Use \`:memory:\` for in-memory database, \`file:filename.db\` for a file database, or a libSQL connection string (e.g., \`libsql://your-database.turso.io\`) for remote storage.
+**url** (`string`): Database URL. Use \`:memory:\` for in-memory database, \`file:filename.db\` for a file database, or a libSQL connection string (e.g., \`libsql://your-database.turso.io\`) for remote storage.
 
-**authToken?:** (`string`): Authentication token for remote libSQL databases.
+**authToken** (`string`): Authentication token for remote libSQL databases.
 
 ## Initialization
 

package/.docs/reference/storage/mongodb.md

@@ -44,15 +44,15 @@ const storage = new MongoDBStore({
 
 ## Parameters
 
-**id:** (`string`): Unique identifier for this storage instance.
+**id** (`string`): Unique identifier for this storage instance.
 
-**uri:** (`string`): MongoDB connection string (e.g., mongodb+srv://user:password\@cluster.mongodb.net)
+**uri** (`string`): MongoDB connection string (e.g., mongodb+srv://user:password\@cluster.mongodb.net)
 
-**url?:** (`string`): Deprecated. Use uri instead. MongoDB connection string (supported for backward compatibility).
+**url** (`string`): Deprecated. Use uri instead. MongoDB connection string (supported for backward compatibility).
 
-**dbName:** (`string`): The name of the database you want the storage to use.
+**dbName** (`string`): The name of the database you want the storage to use.
 
-**options?:** (`MongoClientOptions`): MongoDB client options for advanced configuration (SSL, connection pooling, etc.).
+**options** (`MongoClientOptions`): MongoDB client options for advanced configuration (SSL, connection pooling, etc.).
 
 > **Deprecation Notice:** The `url` parameter is deprecated but still supported for backward compatibility. Please use `uri` instead in all new code.
 

package/.docs/reference/storage/mssql.md

@@ -41,9 +41,9 @@ const storage = new MSSQLStore({
 
 ## Parameters
 
-**connectionString:** (`string`): MSSQL connection string (e.g., Server=localhost,1433;Database=mydb;User Id=sa;Password=password;Encrypt=true;TrustServerCertificate=true)
+**connectionString** (`string`): MSSQL connection string (e.g., Server=localhost,1433;Database=mydb;User Id=sa;Password=password;Encrypt=true;TrustServerCertificate=true)
 
-**schemaName?:** (`string`): The name of the schema you want the storage to use. Will use the default schema if not provided.
+**schemaName** (`string`): The name of the schema you want the storage to use. Will use the default schema if not provided.
 
 ## Constructor Examples