@mastra/mcp-docs-server 1.1.5 → 1.1.6-alpha.0

package/.docs/reference/index.md

@@ -0,0 +1,277 @@
+# Reference
+
+The Reference section provides documentation of Mastra's API, including parameters, types and usage examples.
+
+- [Agent Class](https://mastra.ai/reference/agents/agent)
+- [.generate()](https://mastra.ai/reference/agents/generate)
+- [.generateLegacy()](https://mastra.ai/reference/agents/generateLegacy)
+- [.getDefaultGenerateOptionsLegacy()](https://mastra.ai/reference/agents/getDefaultGenerateOptions)
+- [.getDefaultOptions()](https://mastra.ai/reference/agents/getDefaultOptions)
+- [.getDefaultStreamOptionsLegacy()](https://mastra.ai/reference/agents/getDefaultStreamOptions)
+- [.getDescription()](https://mastra.ai/reference/agents/getDescription)
+- [.getInstructions()](https://mastra.ai/reference/agents/getInstructions)
+- [.getLLM()](https://mastra.ai/reference/agents/getLLM)
+- [.getMemory()](https://mastra.ai/reference/agents/getMemory)
+- [.getModel()](https://mastra.ai/reference/agents/getModel)
+- [.getTools()](https://mastra.ai/reference/agents/getTools)
+- [.getVoice()](https://mastra.ai/reference/agents/getVoice)
+- [.listAgents()](https://mastra.ai/reference/agents/listAgents)
+- [.listScorers()](https://mastra.ai/reference/agents/listScorers)
+- [.listTools()](https://mastra.ai/reference/agents/listTools)
+- [.listWorkflows()](https://mastra.ai/reference/agents/listWorkflows)
+- [.network()](https://mastra.ai/reference/agents/network)
+- [chatRoute()](https://mastra.ai/reference/ai-sdk/chat-route)
+- [handleChatStream()](https://mastra.ai/reference/ai-sdk/handle-chat-stream)
+- [handleNetworkStream()](https://mastra.ai/reference/ai-sdk/handle-network-stream)
+- [handleWorkflowStream()](https://mastra.ai/reference/ai-sdk/handle-workflow-stream)
+- [networkRoute()](https://mastra.ai/reference/ai-sdk/network-route)
+- [toAISdkStream()](https://mastra.ai/reference/ai-sdk/to-ai-sdk-stream)
+- [toAISdkV4Messages()](https://mastra.ai/reference/ai-sdk/to-ai-sdk-v4-messages)
+- [toAISdkV5Messages()](https://mastra.ai/reference/ai-sdk/to-ai-sdk-v5-messages)
+- [withMastra()](https://mastra.ai/reference/ai-sdk/with-mastra)
+- [workflowRoute()](https://mastra.ai/reference/ai-sdk/workflow-route)
+- [Auth0](https://mastra.ai/reference/auth/auth0)
+- [Better Auth](https://mastra.ai/reference/auth/better-auth)
+- [Clerk](https://mastra.ai/reference/auth/clerk)
+- [Firebase](https://mastra.ai/reference/auth/firebase)
+- [JSON Web Token](https://mastra.ai/reference/auth/jwt)
+- [Supabase](https://mastra.ai/reference/auth/supabase)
+- [WorkOS](https://mastra.ai/reference/auth/workos)
+- [create-mastra](https://mastra.ai/reference/cli/create-mastra)
+- [mastra](https://mastra.ai/reference/cli/mastra)
+- [Agents API](https://mastra.ai/reference/client-js/agents)
+- [Error Handling](https://mastra.ai/reference/client-js/error-handling)
+- [Logs API](https://mastra.ai/reference/client-js/logs)
+- [Mastra Client SDK](https://mastra.ai/reference/client-js/mastra-client)
+- [Memory API](https://mastra.ai/reference/client-js/memory)
+- [Observability API](https://mastra.ai/reference/client-js/observability)
+- [Telemetry API](https://mastra.ai/reference/client-js/telemetry)
+- [Tools API](https://mastra.ai/reference/client-js/tools)
+- [Vectors API](https://mastra.ai/reference/client-js/vectors)
+- [Workflows API](https://mastra.ai/reference/client-js/workflows)
+- [Mastra Class](https://mastra.ai/reference/core/mastra-class)
+- [MastraModelGateway](https://mastra.ai/reference/core/mastra-model-gateway)
+- [.addGateway()](https://mastra.ai/reference/core/addGateway)
+- [.getAgent()](https://mastra.ai/reference/core/getAgent)
+- [.getAgentById()](https://mastra.ai/reference/core/getAgentById)
+- [.getDeployer()](https://mastra.ai/reference/core/getDeployer)
+- [.getGateway()](https://mastra.ai/reference/core/getGateway)
+- [.getGatewayById()](https://mastra.ai/reference/core/getGatewayById)
+- [.getLogger()](https://mastra.ai/reference/core/getLogger)
+- [.getMCPServer()](https://mastra.ai/reference/core/getMCPServer)
+- [.getMCPServerById()](https://mastra.ai/reference/core/getMCPServerById)
+- [.getMemory()](https://mastra.ai/reference/core/getMemory)
+- [.getScorer()](https://mastra.ai/reference/core/getScorer)
+- [.getScorerById()](https://mastra.ai/reference/core/getScorerById)
+- [.getServer()](https://mastra.ai/reference/core/getServer)
+- [.getStorage()](https://mastra.ai/reference/core/getStorage)
+- [.getStoredAgentById()](https://mastra.ai/reference/core/getStoredAgentById)
+- [.getTelemetry()](https://mastra.ai/reference/core/getTelemetry)
+- [.getVector()](https://mastra.ai/reference/core/getVector)
+- [.getWorkflow()](https://mastra.ai/reference/core/getWorkflow)
+- [.listAgents()](https://mastra.ai/reference/core/listAgents)
+- [.listGateways()](https://mastra.ai/reference/core/listGateways)
+- [.listLogs()](https://mastra.ai/reference/core/listLogs)
+- [.listLogsByRunId()](https://mastra.ai/reference/core/listLogsByRunId)
+- [.listMCPServers()](https://mastra.ai/reference/core/listMCPServers)
+- [.listMemory()](https://mastra.ai/reference/core/listMemory)
+- [.listScorers()](https://mastra.ai/reference/core/listScorers)
+- [.listStoredAgents()](https://mastra.ai/reference/core/listStoredAgents)
+- [.listVectors()](https://mastra.ai/reference/core/listVectors)
+- [.listWorkflows()](https://mastra.ai/reference/core/listWorkflows)
+- [.setLogger()](https://mastra.ai/reference/core/setLogger)
+- [.setStorage()](https://mastra.ai/reference/core/setStorage)
+- [Cloudflare](https://mastra.ai/reference/deployer/cloudflare)
+- [Deployer](https://mastra.ai/reference/deployer)
+- [Netlify](https://mastra.ai/reference/deployer/netlify)
+- [Vercel](https://mastra.ai/reference/deployer/vercel)
+- [Answer Relevancy Scorer](https://mastra.ai/reference/evals/answer-relevancy)
+- [Answer Similarity Scorer](https://mastra.ai/reference/evals/answer-similarity)
+- [Bias](https://mastra.ai/reference/evals/bias)
+- [Completeness](https://mastra.ai/reference/evals/completeness)
+- [Content Similarity Scorer](https://mastra.ai/reference/evals/content-similarity)
+- [Context Precision Scorer](https://mastra.ai/reference/evals/context-precision)
+- [Context Relevance Scorer](https://mastra.ai/reference/evals/context-relevance)
+- [createScorer()](https://mastra.ai/reference/evals/create-scorer)
+- [Faithfulness](https://mastra.ai/reference/evals/faithfulness)
+- [Hallucination](https://mastra.ai/reference/evals/hallucination)
+- [Keyword Coverage Scorer](https://mastra.ai/reference/evals/keyword-coverage)
+- [MastraScorer](https://mastra.ai/reference/evals/mastra-scorer)
+- [Noise Sensitivity Scorer](https://mastra.ai/reference/evals/noise-sensitivity)
+- [Prompt Alignment Scorer](https://mastra.ai/reference/evals/prompt-alignment)
+- [runEvals()](https://mastra.ai/reference/evals/run-evals)
+- [Scorer Utils](https://mastra.ai/reference/evals/scorer-utils)
+- [Textual Difference Scorer](https://mastra.ai/reference/evals/textual-difference)
+- [Tone Consistency Scorer](https://mastra.ai/reference/evals/tone-consistency)
+- [Tool Call Accuracy Scorers](https://mastra.ai/reference/evals/tool-call-accuracy)
+- [Toxicity](https://mastra.ai/reference/evals/toxicity)
+- [Harness Class](https://mastra.ai/reference/harness/harness-class)
+- [createMastraCode()](https://mastra.ai/reference/mastra-code/createMastraCode)
+- [Cloned Thread Utilities](https://mastra.ai/reference/memory/clone-utilities)
+- [Memory Class](https://mastra.ai/reference/memory/memory-class)
+- [Observational Memory](https://mastra.ai/reference/memory/observational-memory)
+- [.cloneThread()](https://mastra.ai/reference/memory/cloneThread)
+- [.createThread()](https://mastra.ai/reference/memory/createThread)
+- [.deleteMessages()](https://mastra.ai/reference/memory/deleteMessages)
+- [.getThreadById()](https://mastra.ai/reference/memory/getThreadById)
+- [.listThreads()](https://mastra.ai/reference/memory/listThreads)
+- [.recall()](https://mastra.ai/reference/memory/recall)
+- [Dataset Class](https://mastra.ai/reference/datasets/dataset)
+- [DatasetsManager Class](https://mastra.ai/reference/datasets/datasets-manager)
+- [.addItem()](https://mastra.ai/reference/datasets/addItem)
+- [.addItems()](https://mastra.ai/reference/datasets/addItems)
+- [.compareExperiments()](https://mastra.ai/reference/datasets/compareExperiments)
+- [.create()](https://mastra.ai/reference/datasets/create)
+- [.delete()](https://mastra.ai/reference/datasets/delete)
+- [.deleteExperiment()](https://mastra.ai/reference/datasets/deleteExperiment)
+- [.deleteItem()](https://mastra.ai/reference/datasets/deleteItem)
+- [.deleteItems()](https://mastra.ai/reference/datasets/deleteItems)
+- [.get()](https://mastra.ai/reference/datasets/get)
+- [.getDetails()](https://mastra.ai/reference/datasets/getDetails)
+- [.getExperiment()](https://mastra.ai/reference/datasets/getExperiment)
+- [.getItem()](https://mastra.ai/reference/datasets/getItem)
+- [.getItemHistory()](https://mastra.ai/reference/datasets/getItemHistory)
+- [.list()](https://mastra.ai/reference/datasets/list)
+- [.listExperimentResults()](https://mastra.ai/reference/datasets/listExperimentResults)
+- [.listExperiments()](https://mastra.ai/reference/datasets/listExperiments)
+- [.listItems()](https://mastra.ai/reference/datasets/listItems)
+- [.listVersions()](https://mastra.ai/reference/datasets/listVersions)
+- [.startExperiment()](https://mastra.ai/reference/datasets/startExperiment)
+- [.startExperimentAsync()](https://mastra.ai/reference/datasets/startExperimentAsync)
+- [.update()](https://mastra.ai/reference/datasets/update)
+- [.updateItem()](https://mastra.ai/reference/datasets/updateItem)
+- [PinoLogger](https://mastra.ai/reference/logging/pino-logger)
+- [Configuration](https://mastra.ai/reference/observability/tracing/configuration)
+- [Instances](https://mastra.ai/reference/observability/tracing/instances)
+- [Interfaces](https://mastra.ai/reference/observability/tracing/interfaces)
+- [Spans](https://mastra.ai/reference/observability/tracing/spans)
+- [BatchPartsProcessor](https://mastra.ai/reference/processors/batch-parts-processor)
+- [LanguageDetector](https://mastra.ai/reference/processors/language-detector)
+- [MessageHistory](https://mastra.ai/reference/processors/message-history-processor)
+- [ModerationProcessor](https://mastra.ai/reference/processors/moderation-processor)
+- [PIIDetector](https://mastra.ai/reference/processors/pii-detector)
+- [Processor Interface](https://mastra.ai/reference/processors/processor-interface)
+- [PromptInjectionDetector](https://mastra.ai/reference/processors/prompt-injection-detector)
+- [SemanticRecall](https://mastra.ai/reference/processors/semantic-recall-processor)
+- [SystemPromptScrubber](https://mastra.ai/reference/processors/system-prompt-scrubber)
+- [TokenLimiterProcessor](https://mastra.ai/reference/processors/token-limiter-processor)
+- [ToolCallFilter](https://mastra.ai/reference/processors/tool-call-filter)
+- [ToolSearchProcessor](https://mastra.ai/reference/processors/tool-search-processor)
+- [UnicodeNormalizer](https://mastra.ai/reference/processors/unicode-normalizer)
+- [WorkingMemory](https://mastra.ai/reference/processors/working-memory-processor)
+- [DatabaseConfig](https://mastra.ai/reference/rag/database-config)
+- [Embed](https://mastra.ai/reference/rag/embeddings)
+- [ExtractParams](https://mastra.ai/reference/rag/extract-params)
+- [GraphRAG](https://mastra.ai/reference/rag/graph-rag)
+- [MDocument](https://mastra.ai/reference/rag/document)
+- [Metadata Filters](https://mastra.ai/reference/rag/metadata-filters)
+- [rerank()](https://mastra.ai/reference/rag/rerank)
+- [rerankWithScorer()](https://mastra.ai/reference/rag/rerankWithScorer)
+- [.chunk()](https://mastra.ai/reference/rag/chunk)
+- [createRoute()](https://mastra.ai/reference/server/create-route)
+- [Express Adapter](https://mastra.ai/reference/server/express-adapter)
+- [Fastify Adapter](https://mastra.ai/reference/server/fastify-adapter)
+- [Hono Adapter](https://mastra.ai/reference/server/hono-adapter)
+- [Koa Adapter](https://mastra.ai/reference/server/koa-adapter)
+- [MastraServer](https://mastra.ai/reference/server/mastra-server)
+- [registerApiRoute()](https://mastra.ai/reference/server/register-api-route)
+- [Server Routes](https://mastra.ai/reference/server/routes)
+- [Overview](https://mastra.ai/reference/storage/overview)
+- [Cloudflare D1 Storage](https://mastra.ai/reference/storage/cloudflare-d1)
+- [Cloudflare KV Storage](https://mastra.ai/reference/storage/cloudflare)
+- [Composite Storage](https://mastra.ai/reference/storage/composite)
+- [Convex Storage](https://mastra.ai/reference/storage/convex)
+- [DynamoDB Storage](https://mastra.ai/reference/storage/dynamodb)
+- [LanceDB Storage](https://mastra.ai/reference/storage/lance)
+- [libSQL Storage](https://mastra.ai/reference/storage/libsql)
+- [MongoDB Storage](https://mastra.ai/reference/storage/mongodb)
+- [MSSQL Storage](https://mastra.ai/reference/storage/mssql)
+- [PostgreSQL Storage](https://mastra.ai/reference/storage/postgresql)
+- [Upstash Storage](https://mastra.ai/reference/storage/upstash)
+- [ChunkType](https://mastra.ai/reference/streaming/ChunkType)
+- [MastraModelOutput](https://mastra.ai/reference/streaming/agents/MastraModelOutput)
+- [.stream()](https://mastra.ai/reference/streaming/agents/stream)
+- [.streamLegacy()](https://mastra.ai/reference/streaming/agents/streamLegacy)
+- [.observeStream()](https://mastra.ai/reference/streaming/workflows/observeStream)
+- [.resumeStream()](https://mastra.ai/reference/streaming/workflows/resumeStream)
+- [.stream()](https://mastra.ai/reference/streaming/workflows/stream)
+- [.timeTravelStream()](https://mastra.ai/reference/streaming/workflows/timeTravelStream)
+- [Overview](https://mastra.ai/reference/templates/overview)
+- [createDocumentChunkerTool()](https://mastra.ai/reference/tools/document-chunker-tool)
+- [createGraphRAGTool()](https://mastra.ai/reference/tools/graph-rag-tool)
+- [createTool()](https://mastra.ai/reference/tools/create-tool)
+- [createVectorQueryTool()](https://mastra.ai/reference/tools/vector-query-tool)
+- [MCPClient](https://mastra.ai/reference/tools/mcp-client)
+- [MCPServer](https://mastra.ai/reference/tools/mcp-server)
+- [Amazon S3 Vector Store](https://mastra.ai/reference/vectors/s3vectors)
+- [Astra Vector Store](https://mastra.ai/reference/vectors/astra)
+- [Chroma Vector Store](https://mastra.ai/reference/vectors/chroma)
+- [Cloudflare Vector Store](https://mastra.ai/reference/vectors/vectorize)
+- [Convex Vector Store](https://mastra.ai/reference/vectors/convex)
+- [Couchbase Vector Store](https://mastra.ai/reference/vectors/couchbase)
+- [DuckDB Vector Store](https://mastra.ai/reference/vectors/duckdb)
+- [ElasticSearch Vector Store](https://mastra.ai/reference/vectors/elasticsearch)
+- [Lance Vector Store](https://mastra.ai/reference/vectors/lance)
+- [libSQL Vector Store](https://mastra.ai/reference/vectors/libsql)
+- [MongoDB Vector Store](https://mastra.ai/reference/vectors/mongodb)
+- [OpenSearch Vector Store](https://mastra.ai/reference/vectors/opensearch)
+- [PG Vector Store](https://mastra.ai/reference/vectors/pg)
+- [Pinecone Vector Store](https://mastra.ai/reference/vectors/pinecone)
+- [Qdrant Vector Store](https://mastra.ai/reference/vectors/qdrant)
+- [Turbopuffer Vector Store](https://mastra.ai/reference/vectors/turbopuffer)
+- [Upstash Vector Store](https://mastra.ai/reference/vectors/upstash)
+- [Azure](https://mastra.ai/reference/voice/azure)
+- [Cloudflare](https://mastra.ai/reference/voice/cloudflare)
+- [Composite Voice](https://mastra.ai/reference/voice/composite-voice)
+- [Deepgram](https://mastra.ai/reference/voice/deepgram)
+- [ElevenLabs](https://mastra.ai/reference/voice/elevenlabs)
+- [Events](https://mastra.ai/reference/voice/voice.events)
+- [Google](https://mastra.ai/reference/voice/google)
+- [Google Gemini Live](https://mastra.ai/reference/voice/google-gemini-live)
+- [Mastra Voice](https://mastra.ai/reference/voice/mastra-voice)
+- [Murf](https://mastra.ai/reference/voice/murf)
+- [OpenAI](https://mastra.ai/reference/voice/openai)
+- [OpenAI Realtime](https://mastra.ai/reference/voice/openai-realtime)
+- [PlayAI](https://mastra.ai/reference/voice/playai)
+- [Sarvam](https://mastra.ai/reference/voice/sarvam)
+- [Speechify](https://mastra.ai/reference/voice/speechify)
+- [.addInstructions()](https://mastra.ai/reference/voice/voice.addInstructions)
+- [.addTools()](https://mastra.ai/reference/voice/voice.addTools)
+- [.answer()](https://mastra.ai/reference/voice/voice.answer)
+- [.close()](https://mastra.ai/reference/voice/voice.close)
+- [.connect()](https://mastra.ai/reference/voice/voice.connect)
+- [.getSpeakers()](https://mastra.ai/reference/voice/voice.getSpeakers)
+- [.listen()](https://mastra.ai/reference/voice/voice.listen)
+- [.off()](https://mastra.ai/reference/voice/voice.off)
+- [.on()](https://mastra.ai/reference/voice/voice.on)
+- [.send()](https://mastra.ai/reference/voice/voice.send)
+- [.speak()](https://mastra.ai/reference/voice/voice.speak)
+- [.updateConfig()](https://mastra.ai/reference/voice/voice.updateConfig)
+- [Run Class](https://mastra.ai/reference/workflows/run)
+- [Step Class](https://mastra.ai/reference/workflows/step)
+- [Workflow Class](https://mastra.ai/reference/workflows/workflow)
+- [.branch()](https://mastra.ai/reference/workflows/workflow-methods/branch)
+- [.commit()](https://mastra.ai/reference/workflows/workflow-methods/commit)
+- [.createRun()](https://mastra.ai/reference/workflows/workflow-methods/create-run)
+- [.dountil()](https://mastra.ai/reference/workflows/workflow-methods/dountil)
+- [.dowhile()](https://mastra.ai/reference/workflows/workflow-methods/dowhile)
+- [.foreach()](https://mastra.ai/reference/workflows/workflow-methods/foreach)
+- [.map()](https://mastra.ai/reference/workflows/workflow-methods/map)
+- [.parallel()](https://mastra.ai/reference/workflows/workflow-methods/parallel)
+- [.sleep()](https://mastra.ai/reference/workflows/workflow-methods/sleep)
+- [.sleepUntil()](https://mastra.ai/reference/workflows/workflow-methods/sleepUntil)
+- [.then()](https://mastra.ai/reference/workflows/workflow-methods/then)
+- [.cancel()](https://mastra.ai/reference/workflows/run-methods/cancel)
+- [.restart()](https://mastra.ai/reference/workflows/run-methods/restart)
+- [.resume()](https://mastra.ai/reference/workflows/run-methods/resume)
+- [.start()](https://mastra.ai/reference/workflows/run-methods/start)
+- [.startAsync()](https://mastra.ai/reference/workflows/run-methods/startAsync)
+- [.timeTravel()](https://mastra.ai/reference/workflows/run-methods/timeTravel)
+- [E2BSandbox](https://mastra.ai/reference/workspace/e2b-sandbox)
+- [GCSFilesystem](https://mastra.ai/reference/workspace/gcs-filesystem)
+- [LocalFilesystem](https://mastra.ai/reference/workspace/local-filesystem)
+- [LocalSandbox](https://mastra.ai/reference/workspace/local-sandbox)
+- [S3Filesystem](https://mastra.ai/reference/workspace/s3-filesystem)
+- [Workspace Class](https://mastra.ai/reference/workspace/workspace-class)
+- [WorkspaceFilesystem](https://mastra.ai/reference/workspace/filesystem)
+- [WorkspaceSandbox](https://mastra.ai/reference/workspace/sandbox)

package/.docs/reference/logging/pino-logger.md

@@ -0,0 +1,117 @@
+# PinoLogger
+
+A Logger instance is created using `new PinoLogger()` and provides methods to record events at various severity levels.
+
+When deploying to Mastra Cloud, logs are displayed on the [Logs](https://mastra.ai/docs/mastra-cloud/observability) page. In self-hosted or custom environments, logs can be directed to files or external services depending on the configured transports.
+
+## Usage example
+
+```typescript
+import { Mastra } from '@mastra/core'
+import { PinoLogger } from '@mastra/loggers'
+
+export const mastra = new Mastra({
+  logger: new PinoLogger({
+    name: 'Mastra',
+    level: 'info',
+  }),
+})
+```
+
+## Parameters
+
+**name:** (`string`): A label used to group and identify logs from this logger.
+
+**level:** (`"debug" | "info" | "warn" | "error"`): Sets the minimum log level. Messages below this level are ignored.
+
+**transports:** (`Record<string, LoggerTransport>`): A map of transport instances used to persist logs.
+
+**overrideDefaultTransports?:** (`boolean`): If true, disables the default console transport.
+
+**formatters?:** (`pino.LoggerOptions['formatters']`): Custom Pino formatters for log serialization.
+
+## File transport (structured logs)
+
+Writes structured logs to a file using the `FileTransport`. The logger accepts a plain message as the first argument and structured metadata as the second argument. These are internally converted to a `BaseLogMessage` and persisted to the configured file path.
+
+```typescript
+import { FileTransport } from '@mastra/loggers/file'
+import { PinoLogger } from '@mastra/loggers/pino'
+
+export const fileLogger = new PinoLogger({
+  name: 'Mastra',
+  transports: { file: new FileTransport({ path: 'test-dir/test.log' }) },
+  level: 'warn',
+})
+```
+
+### File transport usage
+
+```typescript
+fileLogger.warn('Low disk space', {
+  destinationPath: 'system',
+  type: 'WORKFLOW',
+})
+```
+
+## Upstash transport (remote log drain)
+
+Streams structured logs to a remote Redis list using the `UpstashTransport`. The logger accepts a string message and a structured metadata object. This enables centralized logging for distributed environments, supporting filtering by `destinationPath`, `type`, and `runId`.
+
+```typescript
+import { UpstashTransport } from '@mastra/loggers/upstash'
+import { PinoLogger } from '@mastra/loggers/pino'
+
+export const upstashLogger = new PinoLogger({
+  name: 'Mastra',
+  transports: {
+    upstash: new UpstashTransport({
+      listName: 'production-logs',
+      upstashUrl: process.env.UPSTASH_URL!,
+      upstashToken: process.env.UPSTASH_TOKEN!,
+    }),
+  },
+  level: 'info',
+})
+```
+
+### Upstash transport usage
+
+```typescript
+upstashLogger.info('User signed in', {
+  destinationPath: 'auth',
+  type: 'AGENT',
+  runId: 'run_123',
+})
+```
+
+## Custom transport
+
+You can create custom transports using the `createCustomTransport` utility to integrate with any logging service or stream.
+
+### Sentry transport example
+
+Creates a custom transport using `createCustomTransport` and integrates it with a third-party logging stream such as `pino-sentry-transport`. This allows forwarding logs to an external system like Sentry for advanced monitoring and observability.
+
+```typescript
+import { createCustomTransport } from '@mastra/core/loggers'
+import { PinoLogger } from '@mastra/loggers/pino'
+import pinoSentry from 'pino-sentry-transport'
+
+const sentryStream = await pinoSentry({
+  sentry: {
+    dsn: 'YOUR_SENTRY_DSN',
+    _experiments: {
+      enableLogs: true,
+    },
+  },
+})
+
+const customTransport = createCustomTransport(sentryStream)
+
+export const sentryLogger = new PinoLogger({
+  name: 'Mastra',
+  level: 'info',
+  transports: { sentry: customTransport },
+})
+```

package/.docs/reference/mastra-code/createMastraCode.md

@@ -0,0 +1,108 @@
+# createMastraCode()
+
+`createMastraCode()` is the main factory function that bootstraps the Mastra Code coding agent. It wires together project detection, storage, authentication, MCP servers, hooks, modes, subagents, and the [Harness](https://mastra.ai/reference/harness/harness-class) that drives the TUI or any other frontend.
+
+## Usage example
+
+```typescript
+import { createMastraCode } from 'mastracode'
+
+const { harness, mcpManager, hookManager, authStorage } = createMastraCode()
+```
+
+Pass a config object to customize behavior:
+
+```typescript
+import { createMastraCode } from 'mastracode'
+
+const { harness } = createMastraCode({
+  cwd: '/path/to/project',
+  disableMcp: true,
+  initialState: { yolo: false },
+})
+
+await harness.init()
+await harness.selectOrCreateThread()
+await harness.sendMessage({ content: 'Explain the auth flow' })
+```
+
+## Parameters
+
+`createMastraCode()` accepts an optional `MastraCodeConfig` object:
+
+**cwd?:** (`string`): Working directory for project detection. Mastra Code uses this path to find the Git root, determine the project name, and scope threads. (Default: `process.cwd()`)
+
+**modes?:** (`HarnessMode[]`): Override the default agent modes. Each mode defines an agent, a default model, and a display color. When omitted, Mastra Code ships with Build, Plan, and Fast modes.
+
+**subagents?:** (`HarnessSubagent[]`): Override the default subagent definitions. When omitted, Mastra Code includes Explore (read-only codebase exploration), Plan (read-only analysis and planning), and Execute (task execution with write access).
+
+**extraTools?:** (`Record<string, any>`): Additional tools merged into the dynamic tool set available to the agent.
+
+**storage?:** (`{ url: string; authToken?: string }`): Custom LibSQL storage configuration. When omitted, Mastra Code auto-detects storage from environment variables, project config, global config, or falls back to a local SQLite database.
+
+**initialState?:** (`Record<string, unknown>`): Initial harness state overrides. Merged with defaults like \`yolo\`, \`thinkingLevel\`, and project info.
+
+**heartbeatHandlers?:** (`HeartbeatHandler[]`): Override the default periodic background tasks. The default handler syncs model gateways every 5 minutes.
+
+**disableMcp?:** (`boolean`): Disable MCP server discovery and connection. (Default: `false`)
+
+**disableHooks?:** (`boolean`): Disable the hooks system (lifecycle shell commands). (Default: `false`)
+
+## Return value
+
+`createMastraCode()` returns an object with four properties:
+
+**harness:** (`Harness`): The Harness instance that orchestrates modes, threads, state, memory, and agent interactions. This is the primary interface for sending messages, switching models, and managing conversations.
+
+**mcpManager:** (`McpManager | undefined`): The MCP manager for connecting to external MCP servers. \`undefined\` when \`disableMcp\` is \`true\`.
+
+**hookManager:** (`HookManager | undefined`): The hook manager for executing lifecycle shell commands. \`undefined\` when \`disableHooks\` is \`true\`.
+
+**authStorage:** (`AuthStorage`): The authentication storage instance. Manages OAuth credentials for AI providers (Anthropic Claude Max, OpenAI Codex).
+
+## Default modes
+
+When no `modes` are specified, Mastra Code creates three modes:
+
+| Mode                | Default model               | Description                                                            |
+| ------------------- | --------------------------- | ---------------------------------------------------------------------- |
+| **Build** (default) | `anthropic/claude-opus-4-6` | Full tool access. Read, write, edit files, and execute commands.       |
+| **Plan**            | `openai/gpt-5.2-codex`      | Read-only mode. Explore the codebase and produce implementation plans. |
+| **Fast**            | `cerebras/zai-glm-4.7`      | Quick answers and small edits with minimal overhead.                   |
+
+## Default subagents
+
+When no `subagents` are specified, Mastra Code creates three subagent types:
+
+| Subagent    | Tools                                                                                              | Description                                                                  |
+| ----------- | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| **Explore** | `view`, `search_content`, `find_files`                                                             | Read-only codebase exploration for answering questions about code structure. |
+| **Plan**    | `view`, `search_content`, `find_files`                                                             | Read-only analysis and planning with structured plan output.                 |
+| **Execute** | All read tools + `string_replace_lsp`, `write_file`, `execute_command`, `task_write`, `task_check` | Focused task execution with full write capabilities.                         |
+
+## Project detection
+
+Mastra Code automatically detects project identity from the working directory:
+
+1. **Git remote URL** — if available, normalizes SSH and HTTPS URLs to create a stable identifier shared across clones and worktrees.
+2. **Absolute path** — falls back to the filesystem path when Git isn't available.
+
+The resulting `resourceId` scopes threads to the project, so conversations are shared across clones, worktrees, and SSH/HTTPS URLs of the same repository.
+
+## Storage resolution
+
+Storage configuration is resolved in priority order:
+
+1. `storage` parameter passed to `createMastraCode()`
+2. `MASTRA_DB_URL` and `MASTRA_DB_AUTH_TOKEN` environment variables
+3. Project config at `.mastracode/database.json`
+4. Global config at `~/.mastracode/database.json`
+5. Local SQLite database at the platform-specific app data directory
+
+> **Note:** The returned `harness` object is a full [Harness](https://mastra.ai/reference/harness/harness-class) instance with methods for sending messages, switching modes and models, managing threads, and subscribing to events.
+
+## Related
+
+- [Mastra Code overview](https://mastra.ai/docs/mastra-code/overview)
+- [Harness Class reference](https://mastra.ai/reference/harness/harness-class)
+- [Mastra Code configuration](https://mastra.ai/docs/mastra-code/configuration)