@mastra/mcp-docs-server 0.13.30-alpha.0 → 0.13.30-alpha.2

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

@@ -7,8 +7,6 @@ description: Documentation for the Hallucination Scorer in Mastra, which evaluat
 
 The `createHallucinationScorer()` function evaluates whether an LLM generates factually correct information by comparing its output against the provided context. This scorer measures hallucination by identifying direct contradictions between the context and the output.
 
-For a usage example, see the [Hallucination Examples](/examples/scorers/hallucination).
-
 ## Parameters
 
 The `createHallucinationScorer()` function accepts a single options object with the following properties:
@@ -117,16 +115,135 @@ Final score: `(hallucinated_statements / total_statements) * scale`
 
 ### Score interpretation
 
-(0 to scale, default 0-1)
+A hallucination score between 0 and 1:
 
-- 1.0: Complete hallucination - contradicts all context statements
-- 0.75: High hallucination - contradicts 75% of context statements
-- 0.5: Moderate hallucination - contradicts half of context statements
-- 0.25: Low hallucination - contradicts 25% of context statements
-- 0.0: No hallucination - output aligns with all context statements
+- **0.0**: No hallucination — all claims match the context.
+- **0.3–0.4**: Low hallucination — a few contradictions.
+- **0.5–0.6**: Mixed hallucination — several contradictions.
+- **0.7–0.8**: High hallucination — many contradictions.
+- **0.9–1.0**: Complete hallucination — most or all claims contradict the context.
 
 **Note:** The score represents the degree of hallucination - lower scores indicate better factual alignment with the provided context
 
+## Examples
+
+### No hallucination example
+
+In this example, the response is fully aligned with the provided context. All claims are factually correct and directly supported by the source material, resulting in a low hallucination score.
+
+```typescript filename="src/example-no-hallucination.ts" showLineNumbers copy
+import { openai } from "@ai-sdk/openai";
+import { createHallucinationScorer } from "@mastra/evals/scorers/llm";
+
+const scorer = createHallucinationScorer({ model: openai("gpt-4o-mini"), options: {
+  context: [
+    "The iPhone was first released in 2007.",
+    "Steve Jobs unveiled it at Macworld.",
+    "The original model had a 3.5-inch screen."
+  ]
+});
+
+const query = "When was the first iPhone released?";
+const response = "The iPhone was first released in 2007, when Steve Jobs unveiled it at Macworld. The original iPhone featured a 3.5-inch screen.";
+
+const result = await scorer.run({
+  input: [{ role: 'user', content: query }],
+  output: { text: response },
+});
+
+console.log(result);
+```
+
+#### No hallucination output
+
+The response receives a score of 0 because there are no contradictions. Every statement is consistent with the context, and no new or fabricated information has been introduced.
+
+```typescript
+{
+  score: 0,
+  reason: 'The score is 0 because none of the statements from the context were contradicted by the output.'
+}
+```
+
+### Mixed hallucination example
+
+In this example, the response includes both accurate and inaccurate claims. Some details align with the context, while others directly contradict it—such as inflated numbers or incorrect locations. These contradictions increase the hallucination score.
+
+```typescript filename="src/example-mixed-hallucination.ts" showLineNumbers copy
+import { openai } from "@ai-sdk/openai";
+import { createHallucinationScorer } from "@mastra/evals/scorers/llm";
+
+const scorer = createHallucinationScorer({ model: openai("gpt-4o-mini"), options: {
+  context: [
+    "The first Star Wars movie was released in 1977.",
+    "It was directed by George Lucas.",
+    "The film earned $775 million worldwide.",
+    "The movie was filmed in Tunisia and England."
+  ]
+});
+
+const query = "Tell me about the first Star Wars movie.";
+const response = "The first Star Wars movie came out in 1977 and was directed by George Lucas. It made over $1 billion at the box office and was filmed entirely in California.";
+
+const result = await scorer.run({
+  input: [{ role: 'user', content: query }],
+  output: { text: response },
+});
+
+console.log(result);
+```
+
+#### Mixed hallucination output
+
+The Scorer assigns a mid-range score because parts of the response conflict with the context. While some facts are correct, others are inaccurate or fabricated, reducing overall reliability.
+
+```typescript
+{
+  score: 0.5,
+  reason: 'The score is 0.5 because two out of four statements from the output were contradicted by claims in the context, indicating a balance of accurate and inaccurate information.'
+}
+```
+
+### Complete hallucination example
+
+In this example, the response contradicts every key fact in the context. None of the claims can be verified, and all presented details are factually incorrect.
+
+```typescript filename="src/example-complete-hallucination.ts" showLineNumbers copy
+import { openai } from "@ai-sdk/openai";
+import { createHallucinationScorer } from "@mastra/evals/scorers/llm";
+
+const scorer = createHallucinationScorer({ model: openai("gpt-4o-mini"), options: {
+  context: [
+    "The Wright brothers made their first flight in 1903.",
+    "The flight lasted 12 seconds.",
+    "It covered a distance of 120 feet."
+  ]
+});
+
+const query = "When did the Wright brothers first fly?";
+const response = "The Wright brothers achieved their historic first flight in 1908. The flight lasted about 2 minutes and covered nearly a mile.";
+
+const result = await scorer.run({
+  input: [{ role: 'user', content: query }],
+  output: { text: response },
+});
+
+console.log(result);
+
+```
+
+#### Complete hallucination output
+
+The Scorer assigns a score of 1 because every statement in the response conflicts with the context. The details are fabricated or inaccurate across the board.
+
+```typescript
+{
+  score: 1,
+  reason: 'The score is 1.0 because all three statements from the output directly contradict the context: the first flight was in 1903, not 1908; it lasted 12 seconds, not about 2 minutes; and it covered 120 feet, not nearly a mile.'
+}
+```
+
+
 ## Related
 
 - [Faithfulness Scorer](./faithfulness)

package/.docs/raw/reference/scorers/keyword-coverage.mdx

@@ -7,8 +7,6 @@ description: Documentation for the Keyword Coverage Scorer in Mastra, which eval
 
 The `createKeywordCoverageScorer()` function evaluates how well an LLM's output covers the important keywords from the input. It analyzes keyword presence and matches while ignoring common words and stop words.
 
-For a usage example, see the [Keyword Coverage Examples](/examples/scorers/keyword-coverage).
-
 ## Parameters
 
 The `createKeywordCoverageScorer()` function does not take any options.
@@ -42,6 +40,23 @@ This function returns an instance of the MastraScorer class. See the [MastraScor
   ]}
 />
 
+`.run()` returns a result in the following shape:
+
+```typescript
+{
+  runId: string,
+  extractStepResult: {
+    referenceKeywords: Set<string>,
+    responseKeywords: Set<string>
+  },
+  analyzeStepResult: {
+    totalKeywords: number,
+    matchedKeywords: number
+  },
+  score: number
+}
+```
+
 ## Scoring Details
 
 The scorer evaluates keyword coverage by matching keywords with the following features:
@@ -66,15 +81,15 @@ Final score: `(matched_keywords / total_keywords) * scale`
 
 ### Score interpretation
 
-(0 to scale, default 0-1)
+A coverage score between 0 and 1:
 
-- 1.0: Perfect keyword coverage
-- 0.7-0.9: Good coverage with most keywords present
-- 0.4-0.6: Moderate coverage with some keywords missing
-- 0.1-0.3: Poor coverage with many keywords missing
-- 0.0: No keyword matches
+- **1.0**: Complete coverage – all keywords present.
+- **0.7–0.9**: High coverage – most keywords included.
+- **0.4–0.6**: Partial coverage – some keywords present.
+- **0.1–0.3**: Low coverage – few keywords matched.
+- **0.0**: No coverage – no keywords found.
 
-## Special Cases
+### Special Cases
 
 The scorer handles several special cases:
 
@@ -84,6 +99,123 @@ The scorer handles several special cases:
 - Case differences: "JavaScript" matches "javascript"
 - Common words: Ignored in scoring to focus on meaningful keywords
 
+## Examples
+
+### Full coverage example
+
+In this example, the response fully reflects the key terms from the input. All required keywords are present, resulting in complete coverage with no omissions.
+
+```typescript filename="src/example-full-keyword-coverage.ts" showLineNumbers copy
+import { createKeywordCoverageScorer } from "@mastra/evals/scorers/code";
+
+const scorer = createKeywordCoverageScorer();
+
+const input = 'JavaScript frameworks like React and Vue';
+const output = 'Popular JavaScript frameworks include React and Vue for web development';
+
+const result = await scorer.run({
+  input: [{ role: 'user', content: input }],
+  output: { role: 'assistant', text: output },
+});
+
+console.log('Score:', result.score);
+console.log('AnalyzeStepResult:', result.analyzeStepResult);
+```
+
+#### Full coverage output
+
+A score of 1 indicates that all expected keywords were found in the response. The `analyzeStepResult` field confirms that the number of matched keywords equals the total number extracted from the input.
+
+```typescript
+{
+  score: 1,
+  analyzeStepResult: {
+    totalKeywords: 4,
+    matchedKeywords: 4
+  }
+}
+```
+
+### Partial coverage example
+
+In this example, the response includes some, but not all, of the important keywords from the input. The score reflects partial coverage, with key terms either missing or only partially matched.
+
+```typescript filename="src/example-partial-keyword-coverage.ts" showLineNumbers copy
+import { createKeywordCoverageScorer } from "@mastra/evals/scorers/code";
+
+const scorer = createKeywordCoverageScorer();
+
+const input = 'TypeScript offers interfaces, generics, and type inference';
+const output = 'TypeScript provides type inference and some advanced features';
+
+const result = await scorer.run({
+  input: [{ role: 'user', content: input }],
+  output: { role: 'assistant', text: output },
+});
+
+console.log('Score:', result.score);
+console.log('AnalyzeStepResult:', result.analyzeStepResult);
+```
+
+#### Partial coverage output
+
+A score of 0.5 indicates that only half of the expected keywords were found in the response. The `analyzeStepResult` field shows how many terms were matched compared to the total identified in the input.
+
+```typescript
+{
+  score: 0.5,
+  analyzeStepResult: {
+    totalKeywords: 6,
+    matchedKeywords: 3
+  }
+}
+```
+
+### Minimal coverage example
+
+In this example, the response includes very few of the important keywords from the input. The score reflects minimal coverage, with most key terms missing or unaccounted for.
+
+```typescript filename="src/example-minimal-keyword-coverage.ts" showLineNumbers copy
+import { createKeywordCoverageScorer } from "@mastra/evals/scorers/code";
+
+const scorer = createKeywordCoverageScorer();
+
+const input = 'Machine learning models require data preprocessing, feature engineering, and hyperparameter tuning';
+const output = 'Data preparation is important for models';
+
+const result = await scorer.run({
+  input: [{ role: 'user', content: input }],
+  output: { role: 'assistant', text: output },
+});
+
+console.log('Score:', result.score);
+console.log('AnalyzeStepResult:', result.analyzeStepResult);
+```
+
+#### Minimal coverage output
+
+A low score indicates that only a small number of the expected keywords were present in the response. The `analyzeStepResult` field highlights the gap between total and matched keywords, signaling insufficient coverage.
+
+```typescript
+{
+  score: 0.2,
+  analyzeStepResult: {
+    totalKeywords: 10,
+    matchedKeywords: 2
+  }
+}
+```
+
+### Metric configuration
+
+You can create a `KeywordCoverageMetric` instance with default settings. No additional configuration is required.
+
+```typescript
+const metric = new KeywordCoverageMetric();
+```
+
+> See [KeywordCoverageScorer](/reference/scorers/keyword-coverage.mdx) for a full list of configuration options.
+
 ## Related
 
 - [Completeness Scorer](./completeness)