npm - @mastra/mcp-docs-server - Versions diffs - 1.2.15 → 1.2.16-alpha.3 - Mend

@mastra/mcp-docs-server 1.2.15 → 1.2.16-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (141) hide show

package/.docs/guides/guide/ai-recruiter.md DELETED Viewed

@@ -1,228 +0,0 @@
-> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
-# Building an AI recruiter
-In this guide, you'll learn how Mastra helps you build workflows with LLMs.
-You'll create a workflow that gathers information from a candidate's resume, then branches to either a technical or behavioral question based on the candidate's profile. Along the way, you'll see how to structure workflow steps, handle branching, and integrate LLM calls.
-## Prerequisites
-- Node.js `v22.13.0` or later installed
-- An API key from a supported [Model Provider](https://mastra.ai/models)
-- An existing Mastra project (Follow the [installation guide](https://mastra.ai/guides/getting-started/quickstart) to set up a new project)
-## Building the workflow
-Set up the Workflow, define steps to extract and classify candidate data, and then ask suitable follow-up questions.
-1. Create a new file `src/mastra/workflows/candidate-workflow.ts` and define your workflow:
-   ```ts
-   import { createWorkflow, createStep } from '@mastra/core/workflows'
-   import { z } from 'zod'
-   export const candidateWorkflow = createWorkflow({
-     id: 'candidate-workflow',
-     inputSchema: z.object({
-       resumeText: z.string(),
-     }),
-     outputSchema: z.object({
-       askAboutSpecialty: z.object({
-         question: z.string(),
-       }),
-       askAboutRole: z.object({
-         question: z.string(),
-       }),
-     }),
-   }).commit()
-   ```
-2. You want to extract candidate details from the resume text and classify the person as "technical" or "non-technical". This step calls an LLM to parse the resume and returns structured JSON, including the name, technical status, specialty, and the original resume text. Defined through the `inputSchema` you get access to the `resumeText` inside `execute()`. Use it to prompt an LLM and return the organized fields.
-   To the existing `src/mastra/workflows/candidate-workflow.ts` file add the following:
-   ```ts
-   import { Agent } from '@mastra/core/agent'
-   const recruiter = new Agent({
-     id: 'recruiter-agent',
-     name: 'Recruiter Agent',
-     instructions: `You are a recruiter.`,
-     model: 'openai/gpt-5.6-sol',
-   })
-   const gatherCandidateInfo = createStep({
-     id: 'gatherCandidateInfo',
-     inputSchema: z.object({
-       resumeText: z.string(),
-     }),
-     outputSchema: z.object({
-       candidateName: z.string(),
-       isTechnical: z.boolean(),
-       specialty: z.string(),
-       resumeText: z.string(),
-     }),
-     execute: async ({ inputData }) => {
-       const resumeText = inputData?.resumeText
-       const prompt = `Extract details from the resume text:
-   "${resumeText}"`
-       const res = await recruiter.generate(prompt, {
-         structuredOutput: {
-           schema: z.object({
-             candidateName: z.string(),
-             isTechnical: z.boolean(),
-             specialty: z.string(),
-             resumeText: z.string(),
-           }),
-         },
-       })
-       return res.object
-     },
-   })
-   ```
-   Since you're using a Recruiter agent inside `execute()` you need to define it above the step and add the necessary imports.
-3. This step prompts a candidate who is identified as "technical" for more information about how they got into their specialty. It uses the entire resume text so the LLM can craft a relevant follow-up question.
-   To the existing `src/mastra/workflows/candidate-workflow.ts` file add the following:
-   ```ts
-   const askAboutSpecialty = createStep({
-     id: 'askAboutSpecialty',
-     inputSchema: z.object({
-       candidateName: z.string(),
-       isTechnical: z.boolean(),
-       specialty: z.string(),
-       resumeText: z.string(),
-     }),
-     outputSchema: z.object({
-       question: z.string(),
-     }),
-     execute: async ({ inputData: candidateInfo }) => {
-       const prompt = `You are a recruiter. Given the resume below, craft a short question
-   for ${candidateInfo?.candidateName} about how they got into "${candidateInfo?.specialty}".
-   Resume: ${candidateInfo?.resumeText}`
-       const res = await recruiter.generate(prompt)
-       return { question: res?.text?.trim() || '' }
-     },
-   })
-   ```
-4. If the candidate is "non-technical", you want a different follow-up question. This step asks what interests them most about the role, again referencing their complete resume text. The `execute()` function solicits a role-focused query from the LLM.
-   To the existing `src/mastra/workflows/candidate-workflow.ts` file add the following:
-   ```ts
-   const askAboutRole = createStep({
-     id: 'askAboutRole',
-     inputSchema: z.object({
-       candidateName: z.string(),
-       isTechnical: z.boolean(),
-       specialty: z.string(),
-       resumeText: z.string(),
-     }),
-     outputSchema: z.object({
-       question: z.string(),
-     }),
-     execute: async ({ inputData: candidateInfo }) => {
-       const prompt = `You are a recruiter. Given the resume below, craft a short question
-   for ${candidateInfo?.candidateName} asking what interests them most about this role.
-   Resume: ${candidateInfo?.resumeText}`
-       const res = await recruiter.generate(prompt)
-       return { question: res?.text?.trim() || '' }
-     },
-   })
-   ```
-5. You now combine the steps to implement branching logic based on the candidate's technical status. The workflow first gathers candidate data, then either asks about their specialty or about their role, depending on `isTechnical`. This is done by chaining `gatherCandidateInfo` with `askAboutSpecialty` and `askAboutRole`.
-   To the existing `src/mastra/workflows/candidate-workflow.ts` file change the `candidateWorkflow` like so:
-   ```ts
-   export const candidateWorkflow = createWorkflow({
-     id: 'candidate-workflow',
-     inputSchema: z.object({
-       resumeText: z.string(),
-     }),
-     outputSchema: z.object({
-       askAboutSpecialty: z.object({
-         question: z.string(),
-       }),
-       askAboutRole: z.object({
-         question: z.string(),
-       }),
-     }),
-   })
-     .then(gatherCandidateInfo)
-     .branch([
-       [async ({ inputData: { isTechnical } }) => isTechnical, askAboutSpecialty],
-       [async ({ inputData: { isTechnical } }) => !isTechnical, askAboutRole],
-     ])
-     .commit()
-   ```
-6. In your `src/mastra/index.ts` file, register the workflow:
-   ```ts
-   import { Mastra } from '@mastra/core'
-   import { candidateWorkflow } from './workflows/candidate-workflow'
-   export const mastra = new Mastra({
-     workflows: { candidateWorkflow },
-   })
-   ```
-## Testing the workflow
-You can test your workflow inside [Studio](https://mastra.ai/docs/studio/overview) by starting the development server:
-```bash
-mastra dev
-```
-In the sidebar, navigate to **Workflows** and select **candidate-workflow**. In the middle you'll see a graph view of your workflow and on the right sidebar the **Run** tab is selected by default. Inside this tab you can enter a resume text, for example:
-```text
-Knowledgeable Software Engineer with more than 10 years of experience in software development. Proven expertise in the design and development of software databases and optimization of user interfaces.
-```
-After entering the resume text, press the **Run** button. You should now see two status boxes (`GatherCandidateInfo` and `AskAboutSpecialty`) which contain the output of the workflow steps.
-You can also test the workflow programmatically by calling [`.createRun()`](https://mastra.ai/reference/workflows/workflow-methods/create-run) and [`.start()`](https://mastra.ai/reference/workflows/run-methods/start). Create a new file `src/test-workflow.ts` and add the following:
-```ts
-import { mastra } from './mastra'
-const run = await mastra.getWorkflow('candidateWorkflow').createRun()
-const res = await run.start({
-  inputData: {
-    resumeText:
-      'Knowledgeable Software Engineer with more than 10 years of experience in software development. Proven expertise in the design and development of software databases and optimization of user interfaces.',
-  },
-})
-// Dump the complete workflow result (includes status, steps and result)
-console.log(JSON.stringify(res, null, 2))
-// Get the workflow output value
-if (res.status === 'success') {
-  const question = res.result.askAboutRole?.question ?? res.result.askAboutSpecialty?.question
-  console.log(`Output value: ${question}`)
-}
-```
-Now, run the workflow and get output in your terminal:
-```bash
-npx tsx src/test-workflow.ts
-```
-You've built a workflow to parse a resume and decide which question to ask based on the candidate's technical abilities. Congrats and happy hacking!

package/.docs/guides/guide/code-review-bot.md DELETED Viewed

@@ -1,228 +0,0 @@
-> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
-# Building a code review bot
-In this guide, you'll build a code review bot that automatically reviews pull requests using workspace skills. The bot loads coding standards from skill files and provides structured feedback. You'll create a workspace with a skills directory and define an [Agent Skill](https://agentskills.io) with review instructions and reference files. Then you'll connect the skill to an agent that performs automated reviews.
-## Prerequisites
-- Node.js `v22.13.0` or later installed
-- An API key from a supported [Model Provider](https://mastra.ai/models)
-- An existing Mastra project (Follow the [installation guide](https://mastra.ai/guides/getting-started/quickstart) to set up a new project)
-## Create the workspace
-In your `src/mastra/index.ts` file, import the [`Workspace`](https://mastra.ai/reference/workspace/workspace-class) and [`LocalFilesystem`](https://mastra.ai/reference/workspace/local-filesystem) classes. On the `Workspace` instance, configure the `skills` option to point to a skills directory. The `skills` directory will live inside the filesystem's `basePath`.
-```typescript
-import { Mastra } from '@mastra/core'
-import { resolve } from 'node:path'
-import { Workspace, LocalFilesystem } from '@mastra/core/workspace'
-const workspace = new Workspace({
-  filesystem: new LocalFilesystem({
-    basePath: resolve(import.meta.dirname, '../../workspace'),
-  }),
-  skills: ['skills'],
-})
-export const mastra = new Mastra({
-  workspace,
-})
-```
-At the root of your project, create a new folder called `workspace`. Inside that, create a `skills` folder. This is where you'll define the code standards skill in the next step.
-## Create the code standards skill
-Skills are structured directories containing a `SKILL.md` file with instructions for the agent. The code standards skill defines the review process and references a style guide.
-Inside `workspace/skills`, create a new folder called `code-standards`. Create a file called `SKILL.md` and add the review instructions.
-```markdown
----
-name: code-standards
-description: Automated code review standards and checks
----
-# Code Review Standards
-Review code systematically using these steps:
-1. **Critical Issues**: Security vulnerabilities, memory leaks, logic bugs, missing error handling
-2. **Code Quality**: Functions over 50 lines, code duplication, confusing names, missing types
-3. **Style Guide**: Check references/style-guide.md for naming and organization
-4. **Linting**: Flag common issues like use of `var`, leftover `console.log` statements, and `debugger` statements
-Provide feedback in this format:
-**Summary**: One sentence overview
-**Critical Issues**: List with line numbers
-**Suggestions**: Improvements that would help
-**Positive Notes**: What the code does well
-```
-Inside `workspace/skills/code-standards`, create a `references` folder to hold reference materials for the skill. Author a style guide file that outlines the project's coding conventions with the file name `style-guide.md`.
-````markdown
-# Style Guide
-## Naming
-- Variables/Functions: `camelCase`
-- Constants: `UPPER_SNAKE_CASE`
-- Files: `kebab-case.ts`
-- Booleans: Start with `is`, `has`, `should`
-## Code organization
-```typescript
-// 1. Imports
-import { foo } from 'bar'
-// 2. Constants
-const MAX_SIZE = 100
-// 3. Types
-interface User {
-  id: string
-}
-// 4. Functions
-function doSomething() {}
-// 5. Exports
-export { doSomething }
-```
-## Error handling
-Always handle errors explicitly - never silently catch.
-## Comments
-Write "why" not "what".
-````
-## Create the review agent
-Now it's time to create the code review bot agent that uses the code-standards skill. Create a new file at `src/mastra/agents/code-reviewer.ts` and define the agent:
-```typescript
-import { Agent } from '@mastra/core/agent'
-export const codeReviewer = new Agent({
-  id: 'code-reviewer',
-  name: 'Code Review Bot',
-  instructions: `You are an automated code reviewer.
-When asked to review code:
-1. Activate the 'code-standards' skill
-2. Follow the review process from the skill
-3. Check against the style guide in skill references
-4. Be constructive and specific with line numbers`,
-  model: 'openai/gpt-5.6-sol',
-})
-```
-Define the agent by importing it inside `src/mastra/index.ts` and registering it with the `Mastra` instance:
-```typescript
-import { Mastra } from '@mastra/core'
-import { resolve } from 'node:path'
-import { Workspace, LocalFilesystem } from '@mastra/core/workspace'
-import { codeReviewer } from './agents/code-reviewer'
-const workspace = new Workspace({
-  filesystem: new LocalFilesystem({
-    basePath: resolve(import.meta.dirname, '../../workspace'),
-  }),
-  skills: ['skills'],
-})
-export const mastra = new Mastra({
-  workspace,
-  agents: { codeReviewer },
-})
-```
-## Test the bot
-Start [Studio](https://mastra.ai/docs/studio/overview) and interact with the code review bot to see it in action.
-**npm**:
-```bash
-npm run dev
-```
-**pnpm**:
-```bash
-pnpm run dev
-```
-**Yarn**:
-```bash
-yarn dev
-```
-**Bun**:
-```bash
-bun run dev
-```
-Open [localhost:4111](http://localhost:4111) and navigate to the code reviewer agent.
-Inside the chat input, provide a code snippet for review, such as:
-```text
-Review this code:
-function getData(id) {
-  var result = fetch('/api/data/' + id);
-  console.log(result);
-  return result;
-}
-```
-The bot should activate the `code-standards` skill and provide structured feedback. Since agent responses are non-deterministic, your output may vary, but you should see something similar to:
-```md
-**Summary**: Function has several issues with variable declaration,
-debugging statements, and missing error handling.
-**Critical Issues**:
-- Missing error handling for fetch (line 2)
-- No async/await for asynchronous operation (line 2)
-**Suggestions**:
-- Use const instead of var (line 2)
-- Remove console.log before committing (line 3)
-- Add TypeScript type for id parameter
-- Use template literals instead of concatenation
-**Positive Notes**:
-- Function name is clear and descriptive
-```
-## Next steps
-You can extend this bot to:
-- Add skills for different languages or frameworks
-- Create skills for security checks and performance reviews
-- Integrate with GitHub Actions for automatic PR reviews
-- Build a PR comment bot that leaves inline feedback
-Learn more:
-- [Agent Skills spec](https://agentskills.io)