@mastra/mcp-docs-server 0.13.27 → 0.13.28-alpha.2

package/.docs/raw/reference/cli/dev.mdx

@@ -1,249 +0,0 @@
----
-title: "mastra dev | Development Server | Mastra CLI"
-description: Documentation for the mastra dev command, which starts a development server for agents, tools, and workflows.
----
-
-# mastra dev
-
-The `mastra dev` command starts a development server that exposes REST endpoints for your agents, tools, and workflows.
-
-## Usage
-
-```bash
-mastra dev [options]
-```
-
-## Options
-
-<PropertiesTable
-  content={[
-    {
-      name: "--dir",
-      type: "string",
-      description: "Path to your mastra folder",
-      isOptional: true,
-    },
-    {
-      name: "--root",
-      type: "string",
-      description: "Path to your root folder",
-      isOptional: true,
-    },
-    {
-      name: "--tools",
-      type: "string",
-      description: "Comma-separated list of paths to tool files to include",
-      isOptional: true,
-    },
-    {
-      name: "--port",
-      type: "number",
-      description:
-        "deprecated: Port number for the development server (defaults to 4111)",
-      isOptional: true,
-    },
-    {
-      name: "--env",
-      type: "string",
-      description: "Path to custom environment file",
-      isOptional: true,
-    },
-    {
-      name: "--inspect",
-      type: "boolean",
-      description: "Start the dev server in inspect mode for debugging (cannot be used with --inspect-brk)",
-      isOptional: true,
-    },
-    {
-      name: "--inspect-brk",
-      type: "boolean",
-      description: "Start the dev server in inspect mode and break at the beginning of the script (cannot be used with --inspect)",
-      isOptional: true,
-    },
-    {
-      name: "--custom-args",
-      type: "string",
-      description: "Comma-separated list of custom arguments to pass to the dev server. IE: --experimental-transform-types",
-      isOptional: true,
-    },
-    {
-      name: "--help",
-      type: "boolean",
-      description: "display help for command",
-      isOptional: true,
-    },
-    {
-      name: "--https",
-      type: "boolean",
-      description: "Enable local HTTPS",
-      isOptional: true,
-    },
-  ]}
-/>
-
-## Routes
-
-Starting the server with `mastra dev` exposes a set of REST routes by default:
-
-### System Routes
-
-- **GET `/api`**: Get API status.
-
-### Agent Routes
-
-Agents are expected to be exported from `src/mastra/agents`.
-
-- **GET `/api/agents`**: Lists the registered agents found in your Mastra folder.
-- **GET `/api/agents/:agentId`**: Get agent by ID.
-- **GET `/api/agents/:agentId/evals/ci`**: Get CI evals by agent ID.
-- **GET `/api/agents/:agentId/evals/live`**: Get live evals by agent ID.
-- **POST `/api/agents/:agentId/generate`**: Sends a text-based prompt to the specified agent, returning the agent's response.
-- **POST `/api/agents/:agentId/stream`**: Stream a response from an agent.
-- **POST `/api/agents/:agentId/instructions`**: Update an agent's instructions.
-- **POST `/api/agents/:agentId/instructions/enhance`**: Generate an improved system prompt from instructions.
-- **GET `/api/agents/:agentId/speakers`**: Get available speakers for an agent.
-- **POST `/api/agents/:agentId/speak`**: Convert text to speech using the agent's voice provider.
-- **POST `/api/agents/:agentId/listen`**: Convert speech to text using the agent's voice provider.
-- **POST `/api/agents/:agentId/tools/:toolId/execute`**: Execute a tool through an agent.
-
-### Tool Routes
-
-Tools are expected to be exported from `src/mastra/tools` (or the configured tools directory).
-
-- **GET `/api/tools`**: Get all tools.
-- **GET `/api/tools/:toolId`**: Get tool by ID.
-- **POST `/api/tools/:toolId/execute`**: Invokes a specific tool by name, passing input data in the request body.
-
-### Workflow Routes
-
-Workflows are expected to be exported from `src/mastra/workflows` (or the configured workflows directory).
-
-- **GET `/api/workflows`**: Get all workflows.
-- **GET `/api/workflows/:workflowId`**: Get workflow by ID.
-- **POST `/api/workflows/:workflowName/start`**: Starts the specified workflow.
-- **POST `/api/workflows/:workflowName/:instanceId/event`**: Sends an event or trigger signal to an existing workflow instance.
-- **GET `/api/workflows/:workflowName/:instanceId/status`**: Returns status info for a running workflow instance.
-- **POST `/api/workflows/:workflowId/resume`**: Resume a suspended workflow step.
-- **POST `/api/workflows/:workflowId/resume-async`**: Resume a suspended workflow step asynchronously.
-- **POST `/api/workflows/:workflowId/createRun`**: Create a new workflow run.
-- **POST `/api/workflows/:workflowId/start-async`**: Execute/Start a workflow asynchronously.
-- **GET `/api/workflows/:workflowId/watch`**: Watch workflow transitions in real-time.
-
-### Memory Routes
-
-- **GET `/api/memory/status`**: Get memory status.
-- **GET `/api/memory/threads`**: Get all threads.
-- **GET `/api/memory/threads/:threadId`**: Get thread by ID.
-- **GET `/api/memory/threads/:threadId/messages`**: Get messages for a thread.
-- **GET `/api/memory/threads/:threadId/messages/paginated`**: Get paginated messages for a thread.
-- **POST `/api/memory/threads`**: Create a new thread.
-- **PATCH `/api/memory/threads/:threadId`**: Update a thread.
-- **DELETE `/api/memory/threads/:threadId`**: Delete a thread.
-- **POST `/api/memory/save-messages`**: Save messages.
-
-### Telemetry Routes
-
-- **GET `/api/telemetry`**: Get all traces.
-
-### Log Routes
-
-- **GET `/api/logs`**: Get all logs.
-- **GET `/api/logs/transports`**: List of all log transports.
-- **GET `/api/logs/:runId`**: Get logs by run ID.
-
-### Vector Routes
-
-- **POST `/api/vector/:vectorName/upsert`**: Upsert vectors into an index.
-- **POST `/api/vector/:vectorName/create-index`**: Create a new vector index.
-- **POST `/api/vector/:vectorName/query`**: Query vectors from an index.
-- **GET `/api/vector/:vectorName/indexes`**: List all indexes for a vector store.
-- **GET `/api/vector/:vectorName/indexes/:indexName`**: Get details about a specific index.
-- **DELETE `/api/vector/:vectorName/indexes/:indexName`**: Delete a specific index.
-
-### OpenAPI Specification
-
-- **GET `/openapi.json`**: Returns an auto-generated OpenAPI specification for your project's routes.
-- **GET `/swagger-ui`**: Access Swagger UI for API documentation.
-
-## Additional Notes
-
-The port defaults to `4111`. The port, hostname, and HTTPS settings can also be configured via the Mastra server configuration. See [Launch Development Server](/docs/server-db/local-dev-playground) for configuration details.
-
-Make sure you have your environment variables set up in your `.env.development` or `.env` file for any providers you use (e.g., `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, etc.).
-
-Make sure the `index.ts` file in your Mastra folder exports the Mastra instance for the dev server to read.
-
-### Example request
-
-To test an agent after running `mastra dev`:
-
-```bash copy
-curl -X POST http://localhost:4111/api/agents/myAgent/generate \
-  -H "Content-Type: application/json" \
-  -d '{
-    "messages": [
-      { "role": "user", "content": "Hello, how can you assist me today?" }
-    ]
-  }'
-```
-
-## Advanced usage
-
-The `mastra dev` server obeys a few extra environment variables that can
-be handy during development:
-
-### Disable build caching
-
-Set `MASTRA_DEV_NO_CACHE=1` to force a full rebuild rather than using
-the cached assets under `.mastra/`:
-
-```bash copy
-MASTRA_DEV_NO_CACHE=1 mastra dev
-```
-
-This helps when you are debugging bundler plugins or suspect stale
-output.
-
-### Limit parallelism
-
-`MASTRA_CONCURRENCY` caps how many expensive operations run in parallel
-(primarily build and evaluation steps). For example:
-
-```bash copy
-MASTRA_CONCURRENCY=4 mastra dev
-```
-
-Leave it unset to let the CLI pick a sensible default for the machine.
-
-### Custom provider endpoints
-
-When using providers supported by the Vercel AI SDK you can redirect
-requests through proxies or internal gateways by setting a base URL. For
-OpenAI:
-
-```bash copy
-OPENAI_API_KEY=<your-api-key> \
-OPENAI_BASE_URL=https://openrouter.example/v1 \
-mastra dev
-```
-
-and for Anthropic:
-
-```bash copy
-OPENAI_API_KEY=<your-api-key> \
-ANTHROPIC_BASE_URL=https://anthropic.internal \
-mastra dev
-```
-
-These are forwarded by the AI SDK and work with any `openai()` or
-`anthropic()` calls.
-
-### Disable telemetry
-
-To opt out of anonymous CLI analytics set
-`MASTRA_TELEMETRY_DISABLED=1`. This also prevents tracking within the
-local playground.
-
-```bash copy
-MASTRA_TELEMETRY_DISABLED=1 mastra dev
-```

package/.docs/raw/reference/cli/init.mdx

@@ -1,97 +0,0 @@
----
-title: "mastra init | Initialize Project | Mastra CLI"
-description: Documentation for the mastra init command, which creates a new Mastra project with interactive setup options.
----
-
-# mastra init
-
-The `mastra init` command **initializes** Mastra in an existing project. Use this command to scaffold the necessary folders and configuration without generating a new project.
-
-## Usage
-
-```bash
-mastra init [options]
-```
-
-## Options
-
-<PropertiesTable
-  content={[
-    {
-      name: "--default",
-      type: "boolean",
-      description: "Quick start with defaults (src, OpenAI, no examples)",
-      isOptional: true,
-    },
-    {
-      name: "--dir",
-      type: "string",
-      description: "Directory for Mastra files (defaults to src/)",
-      isOptional: false,
-    },
-    {
-      name: "--components",
-      type: "string",
-      description:
-        "Comma-separated list of components (agents, tools, workflows)",
-      isOptional: false,
-    },
-    {
-      name: "--llm",
-      type: "string",
-      description:
-        "Default model provider (openai, anthropic, groq, google or cerebras)",
-      isOptional: false,
-    },
-    {
-      name: "--llm-api-key",
-      type: "string",
-      description: "API key for the model provider",
-      isOptional: false,
-    },
-    {
-      name: "--example",
-      type: "boolean",
-      description: "Include example code",
-      isOptional: true,
-    },
-    {
-      name: "--no-example",
-      type: "boolean",
-      description: "Do not include example code",
-      isOptional: true,
-    },
-    {
-      name: "--mcp",
-      type: "string",
-      description:
-        "MCP Server for code editor (cursor, cursor-global, windsurf, vscode)",
-      isOptional: false,
-    },
-    {
-      name: "--help",
-      type: "boolean",
-      description: "Display help for command",
-      isOptional: true,
-    },
-  ]}
-/>
-
-## Advanced usage
-
-### Disable analytics
-
-If you prefer not to send anonymous usage data then set the
-`MASTRA_TELEMETRY_DISABLED=1` environment variable when running the
-command:
-
-```bash copy
-MASTRA_TELEMETRY_DISABLED=1 mastra init
-```
-
-### Custom provider endpoints
-
-Initialized projects respect the `OPENAI_BASE_URL` and
-`ANTHROPIC_BASE_URL` variables if present. This lets you route provider
-traffic through proxies or private gateways when starting the dev server
-later on.

package/.docs/raw/reference/cli/lint.mdx

@@ -1,56 +0,0 @@
----
-title: "mastra lint | Validate Project | Mastra CLI"
-description: "Lint your Mastra project"
----
-
-# mastra lint
-
-The `mastra lint` command validates the structure and code of your Mastra project to ensure it follows best practices and is error-free.
-
-## Usage
-
-```bash
-mastra lint [options]
-```
-
-## Options
-
-<PropertiesTable
-  content={[
-    {
-      name: "--dir",
-      type: "string",
-      description: "Path to your Mastra folder",
-      isOptional: true,
-    },
-    {
-      name: "--root",
-      type: "string",
-      description: "Path to your root folder",
-      isOptional: true,
-    },
-    {
-      name: "--tools",
-      type: "string",
-      description: "Comma-separated list of paths to tool files to include",
-      isOptional: true,
-    },
-    {
-      name: "--help",
-      type: "boolean",
-      description: "display help for command",
-      isOptional: true,
-    },
-  ]}
-/>
-
-## Advanced usage
-
-### Disable telemetry
-
-To disable CLI analytics while running linting (and other commands) set
-`MASTRA_TELEMETRY_DISABLED=1`:
-
-```bash copy
-MASTRA_TELEMETRY_DISABLED=1 mastra lint
-```

package/.docs/raw/reference/cli/mcp-docs-server.mdx

@@ -1,82 +0,0 @@
----
-title: "@mastra/mcp-docs-server"
-description: "Serve Mastra docs, examples and blog posts over MCP"
----
-
-The `@mastra/mcp-docs-server` package runs a small [Model Context
-Protocol](https://github.com/modelcontextprotocol/mcp) server that makes
-Mastra documentation, code examples, blog posts and changelogs
-queryable by an LLM agent. It can be invoked manually from the command
-line or configured inside an MCP-aware IDE such as Cursor or Windsurf.
-
-## Running from the CLI
-
-```bash
-npx -y @mastra/mcp-docs-server
-```
-
-The command above runs a stdio based MCP server. The process will keep
-reading requests from `stdin` and returning responses on `stdout`. This
-is the same command that IDE integrations use. When run manually it can
-be pointed at the `@wong2/mcp-cli` package for exploration.
-
-### Examples
-
-Rebuild the docs before serving (useful if you've modified docs locally):
-
-```bash
-REBUILD_DOCS_ON_START=true npx -y @mastra/mcp-docs-server
-```
-
-Enable verbose logging while experimenting:
-
-```bash
-DEBUG=1 npx -y @mastra/mcp-docs-server
-```
-
-Serve blog posts from a custom domain:
-
-```bash
-BLOG_URL=https://my-blog.example npx -y @mastra/mcp-docs-server
-```
-
-## Environment variables
-
-`@mastra/mcp-docs-server` honours a few environment variables that tweak
-its behaviour:
-
-- **`REBUILD_DOCS_ON_START`** - when set to `true` the server rebuilds
-  the `.docs` directory before binding to stdio. This can be helpful
-  after editing or adding documentation locally.
-- **`PREPARE`** - the docs build step (`pnpm mcp-docs-server
-prepare-docs`) looks for `PREPARE=true` to copy Markdown sources from
-  the repository into `.docs`.
-- **`BLOG_URL`** - base URL used for fetching blog posts.
-  Defaults to `https://mastra.ai`.
-- **`DEBUG`** or **`NODE_ENV=development`** - increase logging written
-  to `stderr`.
-
-No other variables are required for a basic run; the server ships with a
-pre-built docs directory.
-
-## Rebuilding with custom docs
-
-The package includes a precompiled copy of the documentation. If you
-want to experiment with additional content you can rebuild the
-`.docs` directory locally:
-
-```bash
-pnpm mcp-docs-server prepare-docs
-```
-
-The script will copy documentation from
-`mastra/docs/src/content/en/docs` and
-`mastra/docs/src/content/en/reference` into the package. Once rebuilt,
-start the server with `REBUILD_DOCS_ON_START=true` so the fresh content
-is served.
-
-A rebuild is only necessary if you need to serve customised docs. For
-regular use you can rely on the published package contents.
-
-For IDE configuration details see the
-[Getting started guide](/docs/getting-started/mcp-docs-server).

package/.docs/raw/reference/cli/scorers.mdx

@@ -1,160 +0,0 @@
----
-title: "mastra scorers | Evaluation Management | Mastra CLI"
-description: "Manage scorers for evaluating AI outputs with the Mastra CLI"
----
-
-# mastra scorers
-
-The `mastra scorers` command provides management capabilities for evaluation scorers that measure the quality, accuracy, and performance of AI-generated outputs.
-
-## Usage
-
-```bash
-mastra scorers <command> [options]
-```
-
-## Commands
-
-### mastra scorers add
-
-Add a new scorer template to your project.
-
-```bash
-mastra scorers add [scorer-name] [options]
-```
-
-#### Options
-
-<PropertiesTable
-  content={[
-    {
-      name: "--dir",
-      type: "string", 
-      description: "Path to your Mastra directory (default: auto-detect)",
-      isOptional: true,
-    },
-    {
-      name: "--help",
-      type: "boolean",
-      description: "Display help for command",
-      isOptional: true,
-    },
-  ]}
-/>
-
-#### Examples
-
-Add a specific scorer by name:
-
-```bash copy
-mastra scorers add answer-relevancy
-```
-
-Interactive scorer selection (when no name provided):
-
-```bash copy
-mastra scorers add
-```
-
-Add scorer to custom directory:
-
-```bash copy  
-mastra scorers add toxicity-detection --dir ./custom/scorers
-```
-
-### mastra scorers list
-
-List all available scorer templates.
-
-```bash
-mastra scorers list
-```
-
-This command displays built-in scorer templates organized by category:
-
-- **Accuracy and Reliability**: answer-relevancy, bias-detection, faithfulness, hallucination, toxicity-detection
-- **Output Quality**: completeness, content-similarity, keyword-coverage, textual-difference, tone-consistency
-
-## Available Scorers
-
-When running `mastra scorers add` without specifying a scorer name, you can select from these built-in templates:
-
-### Accuracy and Reliability
-
-- **answer-relevancy**: Evaluates how relevant an AI response is to the input question
-- **bias-detection**: Identifies potential biases in AI-generated content  
-- **faithfulness**: Measures how faithful the response is to provided context
-- **hallucination**: Detects when AI generates information not grounded in the input
-- **toxicity-detection**: Identifies harmful or inappropriate content
-
-### Output Quality
-
-- **completeness**: Assesses whether the response fully addresses the input
-- **content-similarity**: Measures semantic similarity between expected and actual outputs
-- **keyword-coverage**: Evaluates coverage of expected keywords or topics
-- **textual-difference**: Measures textual differences between responses
-- **tone-consistency**: Evaluates consistency of tone and style
-
-## What It Does
-
-1. **Dependency Management**: Automatically installs `@mastra/evals` package if needed
-2. **Template Selection**: Provides interactive selection when no scorer specified  
-3. **File Generation**: Creates scorer files from built-in templates
-4. **Directory Structure**: Places scorers in `src/mastra/scorers/` or custom directory
-5. **Duplicate Detection**: Prevents overwriting existing scorer files
-
-## Integration
-
-After adding scorers, integrate them with your agents or workflows:
-
-### With Agents
-
-```typescript filename="src/mastra/agents/evaluated-agent.ts"
-import { Agent } from "@mastra/core/agent";
-import { openai } from "@ai-sdk/openai";
-import { createAnswerRelevancyScorer } from "../scorers/answer-relevancy-scorer";
-
-export const evaluatedAgent = new Agent({
-  // ... other config
-  scorers: {
-    relevancy: {
-      scorer: createAnswerRelevancyScorer({ model: openai("gpt-4o-mini") }),
-      sampling: { type: "ratio", rate: 0.5 }
-    }
-  }
-});
-```
-
-### With Workflow Steps
-
-```typescript filename="src/mastra/workflows/content-generation.ts"
-import { createWorkflow, createStep } from "@mastra/core/workflows";
-import { customStepScorer } from "../scorers/custom-step-scorer";
-
-const contentStep = createStep({
-  // ... other config
-  scorers: {
-    customStepScorer: {
-      scorer: customStepScorer(),
-      sampling: { type: "ratio", rate: 1 }
-    }
-  },
-});
-```
-
-## Testing Scorers
-
-Use the [Local Dev Playground](/docs/server-db/local-dev-playground) to test your scorers:
-
-```bash copy
-mastra dev
-```
-
-Navigate to [http://localhost:4111/](http://localhost:4111/) and access the scorers section to run individual scorers against test inputs and view detailed results.
-
-## Next Steps
-
-- Learn about scorer implementation in [Creating Custom Scorers](/docs/scorers/custom-scorers)
-- Explore built-in options in [Off-the-shelf Scorers](/docs/scorers/off-the-shelf-scorers)  
-- See [Scorers Overview](/docs/scorers/overview) for evaluation pipeline details
-- Test scorers with the [Local Dev Playground](/docs/server-db/local-dev-playground)

package/.docs/raw/reference/cli/start.mdx

@@ -1,50 +0,0 @@
----
-title: 'mastra start'
-description: 'Start your built Mastra application'
----
-
-# mastra start
-
-Start your built Mastra application. This command is used to run your built Mastra application in production mode.
-Telemetry is enabled by default.
-
-## Usage
-After building your project with `mastra build` run:
-
-```bash
-mastra start [options]
-```
-
-## Options
-
-| Option | Description |
-|--------|-------------|
-| `-d, --dir <path>` | Path to your built Mastra output directory (default: .mastra/output) |
-| `-e, --env <env>` | Custom env file to include in the start (default: .env.production, .env) |
-| `-nt, --no-telemetry` | Disable telemetry on start |
-
-## Examples
-
-Start the application with default settings:
-
-```bash
-mastra start
-```
-
-Start from a custom output directory:
-
-```bash
-mastra start --dir ./my-output
-```
-
-Start with a custom environment file:
-
-```bash
-mastra start --env .env.staging
-```
-
-Start with telemetry disabled:
-
-```bash
-mastra start -nt
-```