@xano/developer-mcp 1.0.33 → 1.0.35

package/dist/tools/index.d.ts

@@ -29,33 +29,20 @@
  * const docs = xanoscriptDocs({ topic: 'syntax' });
  * ```
  */
-import { validateXanoscript, validateXanoscriptTool, validateXanoscriptToolDefinition, type ValidateXanoscriptArgs, type ValidationResult, type ParserDiagnostic } from "./validate_xanoscript.js";
+import { validateXanoscript, validateXanoscriptTool, validateXanoscriptToolDefinition, TYPE_ALIASES, RESERVED_VARIABLES, type ValidateXanoscriptArgs, type ValidationResult, type BatchValidationResult, type SingleFileValidationResult, type ParserDiagnostic } from "./validate_xanoscript.js";
 import { xanoscriptDocs, xanoscriptDocsTool, xanoscriptDocsToolDefinition, getXanoscriptDocsPath, setXanoscriptDocsPath, type XanoscriptDocsArgs, type XanoscriptDocsResult } from "./xanoscript_docs.js";
 import { mcpVersion, mcpVersionTool, mcpVersionToolDefinition, getServerVersion, setServerVersion, type McpVersionResult } from "./mcp_version.js";
 import { metaApiDocs, metaApiDocsTool, metaApiDocsToolDefinition, metaApiTopics, getMetaApiTopicNames, getMetaApiTopicDescriptions, type MetaApiDocsArgs, type MetaApiDocsResult } from "./meta_api_docs.js";
 import { runApiDocs, runApiDocsTool, runApiDocsToolDefinition, runApiTopics, getRunApiTopicNames, getRunApiTopicDescriptions, type RunApiDocsArgs, type RunApiDocsResult } from "./run_api_docs.js";
 import { cliDocs, cliDocsTool, cliDocsToolDefinition, cliTopics, getCliTopicNames, getCliTopicDescriptions, type CliDocsArgs, type CliDocsResult } from "./cli_docs.js";
 import { type ToolResult, toMcpResponse } from "./types.js";
-export { validateXanoscript, type ValidateXanoscriptArgs, type ValidationResult, type ParserDiagnostic, xanoscriptDocs, getXanoscriptDocsPath, setXanoscriptDocsPath, type XanoscriptDocsArgs, type XanoscriptDocsResult, mcpVersion, getServerVersion, setServerVersion, type McpVersionResult, metaApiDocs, metaApiTopics, getMetaApiTopicNames, getMetaApiTopicDescriptions, type MetaApiDocsArgs, type MetaApiDocsResult, runApiDocs, runApiTopics, getRunApiTopicNames, getRunApiTopicDescriptions, type RunApiDocsArgs, type RunApiDocsResult, cliDocs, cliTopics, getCliTopicNames, getCliTopicDescriptions, type CliDocsArgs, type CliDocsResult, type ToolResult, toMcpResponse, };
+export { validateXanoscript, TYPE_ALIASES, RESERVED_VARIABLES, type ValidateXanoscriptArgs, type ValidationResult, type BatchValidationResult, type SingleFileValidationResult, type ParserDiagnostic, xanoscriptDocs, getXanoscriptDocsPath, setXanoscriptDocsPath, type XanoscriptDocsArgs, type XanoscriptDocsResult, mcpVersion, getServerVersion, setServerVersion, type McpVersionResult, metaApiDocs, metaApiTopics, getMetaApiTopicNames, getMetaApiTopicDescriptions, type MetaApiDocsArgs, type MetaApiDocsResult, runApiDocs, runApiTopics, getRunApiTopicNames, getRunApiTopicDescriptions, type RunApiDocsArgs, type RunApiDocsResult, cliDocs, cliTopics, getCliTopicNames, getCliTopicDescriptions, type CliDocsArgs, type CliDocsResult, type ToolResult, toMcpResponse, };
 export { validateXanoscriptTool, xanoscriptDocsTool, mcpVersionTool, metaApiDocsTool, runApiDocsTool, cliDocsTool, };
 export { validateXanoscriptToolDefinition, xanoscriptDocsToolDefinition, mcpVersionToolDefinition, metaApiDocsToolDefinition, runApiDocsToolDefinition, cliDocsToolDefinition, };
 /**
  * All tool definitions for MCP server registration
  */
 export declare const toolDefinitions: ({
-    name: string;
-    description: string;
-    inputSchema: {
-        type: string;
-        properties: {
-            code: {
-                type: string;
-                description: string;
-            };
-        };
-        required: string[];
-    };
-} | {
     name: string;
     description: string;
     inputSchema: {

package/dist/tools/index.js

@@ -32,7 +32,7 @@
 // =============================================================================
 // Tool Imports
 // =============================================================================
-import { validateXanoscript, validateXanoscriptTool, validateXanoscriptToolDefinition, } from "./validate_xanoscript.js";
+import { validateXanoscript, validateXanoscriptTool, validateXanoscriptToolDefinition, TYPE_ALIASES, RESERVED_VARIABLES, } from "./validate_xanoscript.js";
 import { xanoscriptDocs, xanoscriptDocsTool, xanoscriptDocsToolDefinition, getXanoscriptDocsPath, setXanoscriptDocsPath, } from "./xanoscript_docs.js";
 import { mcpVersion, mcpVersionTool, mcpVersionToolDefinition, getServerVersion, setServerVersion, } from "./mcp_version.js";
 import { metaApiDocs, metaApiDocsTool, metaApiDocsToolDefinition, metaApiTopics, getMetaApiTopicNames, getMetaApiTopicDescriptions, } from "./meta_api_docs.js";
@@ -44,7 +44,7 @@ import { toMcpResponse } from "./types.js";
 // =============================================================================
 export { 
 // Validation
-validateXanoscript, 
+validateXanoscript, TYPE_ALIASES, RESERVED_VARIABLES, 
 // XanoScript Documentation
 xanoscriptDocs, getXanoscriptDocsPath, setXanoscriptDocsPath, 
 // MCP Version

package/dist/tools/validate_xanoscript.d.ts

@@ -3,11 +3,25 @@
  *
  * Validates XanoScript code for syntax errors using the XanoScript language server.
  * Can be used standalone or within the MCP server.
+ *
+ * Supports multiple input methods:
+ * - code: Raw XanoScript code as a string
+ * - file_path: Path to a single .xs file
+ * - file_paths: Array of file paths for batch validation
+ * - directory: Directory path with optional glob pattern
  */
 import type { ToolResult } from "./types.js";
 export interface ValidateXanoscriptArgs {
-    /** The XanoScript code to validate */
-    code: string;
+    /** The XanoScript code to validate (mutually exclusive with file_path/file_paths/directory) */
+    code?: string;
+    /** Path to a single XanoScript file to validate */
+    file_path?: string;
+    /** Array of file paths for batch validation */
+    file_paths?: string[];
+    /** Directory to validate (validates all .xs files recursively) */
+    directory?: string;
+    /** Glob pattern to filter files when using directory (default: "**\/*.xs") */
+    pattern?: string;
 }
 export interface ParserDiagnostic {
     range: {
@@ -23,14 +37,42 @@ export interface ParserDiagnostic {
     message: string;
     source: string;
 }
+export interface SingleFileValidationResult {
+    valid: boolean;
+    errors: ParserDiagnostic[];
+    message: string;
+    file_path?: string;
+}
 export interface ValidationResult {
     valid: boolean;
     errors: ParserDiagnostic[];
     message: string;
 }
+export interface BatchValidationResult {
+    valid: boolean;
+    total_files: number;
+    valid_files: number;
+    invalid_files: number;
+    results: SingleFileValidationResult[];
+    message: string;
+}
+/**
+ * Common type aliases that users might try
+ */
+declare const TYPE_ALIASES: Record<string, string>;
+/**
+ * Reserved variable names that cannot be used
+ */
+declare const RESERVED_VARIABLES: string[];
 /**
  * Validate XanoScript code for syntax errors.
  *
+ * Supports multiple input methods:
+ * - code: Raw XanoScript code as a string
+ * - file_path: Path to a single .xs file
+ * - file_paths: Array of file paths for batch validation
+ * - directory: Directory path with optional glob pattern
+ *
  * @param args - The validation arguments
  * @returns Validation result with errors if any
  *
@@ -38,15 +80,28 @@ export interface ValidationResult {
  * ```ts
  * import { validateXanoscript } from '@xano/developer-mcp';
  *
+ * // Validate code directly
  * const result = validateXanoscript({ code: 'return 1 + 1' });
- * if (result.valid) {
- *   console.log('Code is valid!');
- * } else {
- *   console.log('Errors:', result.errors);
- * }
+ *
+ * // Validate a single file
+ * const fileResult = validateXanoscript({ file_path: './functions/utils.xs' });
+ *
+ * // Validate multiple files
+ * const batchResult = validateXanoscript({
+ *   file_paths: ['./apis/users/get.xs', './apis/users/create.xs']
+ * });
+ *
+ * // Validate all .xs files in a directory
+ * const dirResult = validateXanoscript({ directory: './src' });
+ *
+ * // Validate with a specific pattern
+ * const patternResult = validateXanoscript({
+ *   directory: './src',
+ *   pattern: 'apis/**\/*.xs'
+ * });
  * ```
  */
-export declare function validateXanoscript(args: ValidateXanoscriptArgs): ValidationResult;
+export declare function validateXanoscript(args: ValidateXanoscriptArgs): ValidationResult | BatchValidationResult;
 /**
  * Validate XanoScript and return a simplified result.
  * Returns ToolResult format for consistent error handling.
@@ -62,7 +117,27 @@ export declare const validateXanoscriptToolDefinition: {
                 type: string;
                 description: string;
             };
+            file_path: {
+                type: string;
+                description: string;
+            };
+            file_paths: {
+                type: string;
+                items: {
+                    type: string;
+                };
+                description: string;
+            };
+            directory: {
+                type: string;
+                description: string;
+            };
+            pattern: {
+                type: string;
+                description: string;
+            };
         };
-        required: string[];
+        required: never[];
     };
 };
+export { TYPE_ALIASES, RESERVED_VARIABLES };

package/dist/tools/validate_xanoscript.js

@@ -3,47 +3,183 @@
  *
  * Validates XanoScript code for syntax errors using the XanoScript language server.
  * Can be used standalone or within the MCP server.
+ *
+ * Supports multiple input methods:
+ * - code: Raw XanoScript code as a string
+ * - file_path: Path to a single .xs file
+ * - file_paths: Array of file paths for batch validation
+ * - directory: Directory path with optional glob pattern
  */
 import { xanoscriptParser } from "@xano/xanoscript-language-server/parser/parser.js";
 import { getSchemeFromContent } from "@xano/xanoscript-language-server/utils.js";
+import { readFileSync, existsSync, readdirSync } from "fs";
+import { join, resolve, basename } from "path";
+import { minimatch } from "minimatch";
 // =============================================================================
-// Standalone Tool Function
+// Error Message Improvements
 // =============================================================================
 /**
- * Validate XanoScript code for syntax errors.
- *
- * @param args - The validation arguments
- * @returns Validation result with errors if any
- *
- * @example
- * ```ts
- * import { validateXanoscript } from '@xano/developer-mcp';
- *
- * const result = validateXanoscript({ code: 'return 1 + 1' });
- * if (result.valid) {
- *   console.log('Code is valid!');
- * } else {
- *   console.log('Errors:', result.errors);
- * }
- * ```
+ * Common type aliases that users might try
  */
-export function validateXanoscript(args) {
-    if (!args?.code) {
-        return {
-            valid: false,
-            errors: [],
-            message: "Error: 'code' parameter is required",
-        };
+const TYPE_ALIASES = {
+    boolean: "bool",
+    integer: "int",
+    string: "text",
+    number: "decimal",
+    float: "decimal",
+    double: "decimal",
+    array: "type[]",
+    list: "type[]",
+    object: "json",
+    map: "json",
+    dict: "json",
+    dictionary: "json",
+};
+/**
+ * Reserved variable names that cannot be used
+ */
+const RESERVED_VARIABLES = [
+    "$response",
+    "$output",
+    "$input",
+    "$auth",
+    "$env",
+    "$db",
+    "$this",
+    "$result",
+];
+/**
+ * Common syntax mistakes and their fixes
+ */
+const SYNTAX_SUGGESTIONS = [
+    {
+        pattern: /else\s+if/,
+        suggestion: 'Use "elseif" (one word) instead of "else if"',
+    },
+    {
+        pattern: /body\s*=/,
+        suggestion: 'Use "params" instead of "body" for api.request request body',
+    },
+    {
+        pattern: /\|default:/,
+        suggestion: 'There is no "default" filter. Use "first_notnull" or "??" operator instead',
+    },
+    {
+        pattern: /boolean/,
+        suggestion: 'Use "bool" instead of "boolean" for type declaration',
+    },
+    {
+        pattern: /integer(?!\s*\()/,
+        suggestion: 'Use "int" instead of "integer" for type declaration',
+    },
+    {
+        pattern: /string(?!\s*\()/,
+        suggestion: 'Use "text" instead of "string" for type declaration',
+    },
+];
+/**
+ * Enhance error message with helpful suggestions
+ */
+function enhanceErrorMessage(message, code, lineNumber) {
+    let enhanced = message;
+    const lines = code.split("\n");
+    const errorLine = lines[lineNumber] || "";
+    // Check for type aliases
+    for (const [alias, correct] of Object.entries(TYPE_ALIASES)) {
+        const regex = new RegExp(`\\b${alias}\\b`, "i");
+        if (regex.test(errorLine)) {
+            enhanced += `\n\n💡 Suggestion: Use "${correct}" instead of "${alias}"`;
+            break;
+        }
+    }
+    // Check for reserved variables
+    for (const reserved of RESERVED_VARIABLES) {
+        if (errorLine.includes(`var ${reserved}`) ||
+            errorLine.includes(`var.update ${reserved}`)) {
+            enhanced += `\n\n💡 "${reserved}" is a reserved variable name. Try a different name like "${reserved.replace("$", "$my_")}"`;
+            break;
+        }
+    }
+    // Check for common syntax mistakes
+    for (const { pattern, suggestion } of SYNTAX_SUGGESTIONS) {
+        if (pattern.test(errorLine) || pattern.test(code)) {
+            enhanced += `\n\n💡 Suggestion: ${suggestion}`;
+            break;
+        }
+    }
+    // Add the actual line of code for context
+    if (errorLine.trim()) {
+        enhanced += `\n\nCode at line ${lineNumber + 1}:\n  ${errorLine.trim()}`;
+    }
+    return enhanced;
+}
+// =============================================================================
+// File Reading Utilities
+// =============================================================================
+/**
+ * Read a file and return its contents
+ */
+function readFile(filePath) {
+    try {
+        const absolutePath = resolve(filePath);
+        if (!existsSync(absolutePath)) {
+            return { content: "", error: `File not found: ${filePath}` };
+        }
+        const content = readFileSync(absolutePath, "utf-8");
+        return { content };
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        return { content: "", error: `Error reading file: ${errorMessage}` };
+    }
+}
+/**
+ * Find all .xs files in a directory matching the pattern
+ */
+function findXsFiles(directory, pattern = "**/*.xs") {
+    const absoluteDir = resolve(directory);
+    if (!existsSync(absoluteDir)) {
+        return [];
+    }
+    const files = [];
+    function walkDir(dir, basePath = "") {
+        const entries = readdirSync(dir, { withFileTypes: true });
+        for (const entry of entries) {
+            const fullPath = join(dir, entry.name);
+            const relativePath = basePath ? join(basePath, entry.name) : entry.name;
+            if (entry.isDirectory()) {
+                walkDir(fullPath, relativePath);
+            }
+            else if (entry.isFile() && entry.name.endsWith(".xs")) {
+                if (minimatch(relativePath, pattern)) {
+                    files.push(fullPath);
+                }
+            }
+        }
     }
+    walkDir(absoluteDir);
+    return files;
+}
+// =============================================================================
+// Standalone Tool Function
+// =============================================================================
+/**
+ * Validate a single piece of XanoScript code.
+ * Internal function used by the public API.
+ */
+function validateCode(code, filePath) {
     try {
-        const text = args.code;
+        const text = code;
         const scheme = getSchemeFromContent(text);
         const parser = xanoscriptParser(text, scheme);
         if (parser.errors.length === 0) {
             return {
                 valid: true,
                 errors: [],
-                message: "XanoScript is valid. No syntax errors found.",
+                message: filePath
+                    ? `✓ ${basename(filePath)}: Valid`
+                    : "XanoScript is valid. No syntax errors found.",
+                file_path: filePath,
             };
         }
         const diagnostics = parser.errors.map((error) => {
@@ -55,12 +191,14 @@ export function validateXanoscript(args) {
             const endLines = text.substring(0, endOffset + 1).split("\n");
             const endLine = endLines.length - 1;
             const endCharacter = endLines[endLines.length - 1].length;
+            // Enhance error message with suggestions
+            const enhancedMessage = enhanceErrorMessage(error.message, text, line);
             return {
                 range: {
                     start: { line, character },
                     end: { line: endLine, character: endCharacter },
                 },
-                message: error.message,
+                message: enhancedMessage,
                 source: error.name || "XanoScript Parser",
             };
         });
@@ -68,10 +206,12 @@ export function validateXanoscript(args) {
             const location = `Line ${d.range.start.line + 1}, Column ${d.range.start.character + 1}`;
             return `${i + 1}. [${location}] ${d.message}`;
         });
+        const prefix = filePath ? `✗ ${basename(filePath)}: ` : "";
         return {
             valid: false,
             errors: diagnostics,
-            message: `Found ${diagnostics.length} error(s):\n\n${errorMessages.join("\n")}`,
+            message: `${prefix}Found ${diagnostics.length} error(s):\n\n${errorMessages.join("\n")}`,
+            file_path: filePath,
         };
     }
     catch (error) {
@@ -80,9 +220,156 @@ export function validateXanoscript(args) {
             valid: false,
             errors: [],
             message: `Validation error: ${errorMessage}`,
+            file_path: filePath,
         };
     }
 }
+/**
+ * Validate XanoScript code for syntax errors.
+ *
+ * Supports multiple input methods:
+ * - code: Raw XanoScript code as a string
+ * - file_path: Path to a single .xs file
+ * - file_paths: Array of file paths for batch validation
+ * - directory: Directory path with optional glob pattern
+ *
+ * @param args - The validation arguments
+ * @returns Validation result with errors if any
+ *
+ * @example
+ * ```ts
+ * import { validateXanoscript } from '@xano/developer-mcp';
+ *
+ * // Validate code directly
+ * const result = validateXanoscript({ code: 'return 1 + 1' });
+ *
+ * // Validate a single file
+ * const fileResult = validateXanoscript({ file_path: './functions/utils.xs' });
+ *
+ * // Validate multiple files
+ * const batchResult = validateXanoscript({
+ *   file_paths: ['./apis/users/get.xs', './apis/users/create.xs']
+ * });
+ *
+ * // Validate all .xs files in a directory
+ * const dirResult = validateXanoscript({ directory: './src' });
+ *
+ * // Validate with a specific pattern
+ * const patternResult = validateXanoscript({
+ *   directory: './src',
+ *   pattern: 'apis/**\/*.xs'
+ * });
+ * ```
+ */
+export function validateXanoscript(args) {
+    // Validate that at least one input method is provided
+    if (!args?.code && !args?.file_path && !args?.file_paths && !args?.directory) {
+        return {
+            valid: false,
+            errors: [],
+            message: "Error: One of 'code', 'file_path', 'file_paths', or 'directory' parameter is required",
+        };
+    }
+    // Handle direct code validation
+    if (args.code) {
+        const result = validateCode(args.code);
+        return {
+            valid: result.valid,
+            errors: result.errors,
+            message: result.message,
+        };
+    }
+    // Handle single file validation
+    if (args.file_path) {
+        const { content, error } = readFile(args.file_path);
+        if (error) {
+            return {
+                valid: false,
+                errors: [],
+                message: error,
+            };
+        }
+        const result = validateCode(content, args.file_path);
+        return {
+            valid: result.valid,
+            errors: result.errors,
+            message: result.message,
+        };
+    }
+    // Handle batch validation (file_paths or directory)
+    let filesToValidate = [];
+    if (args.file_paths) {
+        filesToValidate = args.file_paths;
+    }
+    else if (args.directory) {
+        filesToValidate = findXsFiles(args.directory, args.pattern || "**/*.xs");
+        if (filesToValidate.length === 0) {
+            return {
+                valid: true,
+                total_files: 0,
+                valid_files: 0,
+                invalid_files: 0,
+                results: [],
+                message: `No .xs files found in directory: ${args.directory}${args.pattern ? ` matching pattern: ${args.pattern}` : ""}`,
+            };
+        }
+    }
+    // Validate all files
+    const results = [];
+    let validCount = 0;
+    let invalidCount = 0;
+    for (const filePath of filesToValidate) {
+        const { content, error } = readFile(filePath);
+        if (error) {
+            results.push({
+                valid: false,
+                errors: [],
+                message: error,
+                file_path: filePath,
+            });
+            invalidCount++;
+            continue;
+        }
+        const result = validateCode(content, filePath);
+        results.push(result);
+        if (result.valid) {
+            validCount++;
+        }
+        else {
+            invalidCount++;
+        }
+    }
+    // Build summary message
+    const allValid = invalidCount === 0;
+    const summaryLines = [
+        `Validated ${filesToValidate.length} file(s): ${validCount} valid, ${invalidCount} invalid`,
+        "",
+    ];
+    // Show errors first, then valid files
+    const invalidResults = results.filter((r) => !r.valid);
+    const validResults = results.filter((r) => r.valid);
+    if (invalidResults.length > 0) {
+        summaryLines.push("❌ Files with errors:");
+        for (const result of invalidResults) {
+            summaryLines.push(`\n${result.message}`);
+        }
+        summaryLines.push("");
+    }
+    if (validResults.length > 0) {
+        summaryLines.push("✅ Valid files:");
+        for (const result of validResults) {
+            summaryLines.push(`  ${result.file_path}`);
+        }
+    }
+    return {
+        valid: allValid,
+        total_files: filesToValidate.length,
+        valid_files: validCount,
+        invalid_files: invalidCount,
+        results,
+        message: summaryLines.join("\n"),
+    };
+}
 /**
  * Validate XanoScript and return a simplified result.
  * Returns ToolResult format for consistent error handling.
@@ -100,15 +387,42 @@ export function validateXanoscriptTool(args) {
 // =============================================================================
 export const validateXanoscriptToolDefinition = {
     name: "validate_xanoscript",
-    description: "Validate XanoScript code for syntax errors. Returns a list of errors with line/column positions, or confirms the code is valid. The language server auto-detects the object type from the code syntax.",
+    description: "Validate XanoScript code for syntax errors. Supports multiple input methods:\n" +
+        "- code: Raw XanoScript code as a string\n" +
+        "- file_path: Path to a single .xs file (easier than escaping code!)\n" +
+        "- file_paths: Array of file paths for batch validation\n" +
+        "- directory: Validate all .xs files in a directory\n\n" +
+        "Returns errors with line/column positions and helpful suggestions for common mistakes. " +
+        "The language server auto-detects the object type from the code syntax.",
     inputSchema: {
         type: "object",
         properties: {
             code: {
                 type: "string",
-                description: "The XanoScript code to validate",
+                description: "The XanoScript code to validate as a string. Use file_path instead if the code contains special characters that are hard to escape.",
+            },
+            file_path: {
+                type: "string",
+                description: "Path to a single XanoScript file to validate. Easier than passing code directly - avoids escaping issues.",
+            },
+            file_paths: {
+                type: "array",
+                items: { type: "string" },
+                description: "Array of file paths for batch validation. Returns a summary with per-file results.",
+            },
+            directory: {
+                type: "string",
+                description: "Directory path to validate. Validates all .xs files recursively. Use with 'pattern' to filter.",
+            },
+            pattern: {
+                type: "string",
+                description: 'Glob pattern to filter files when using directory (default: "**/*.xs"). Example: "apis/**/*.xs"',
             },
         },
-        required: ["code"],
+        required: [],
     },
 };
+// =============================================================================
+// Utility Exports
+// =============================================================================
+export { TYPE_ALIASES, RESERVED_VARIABLES };

package/dist/xanoscript.js

@@ -21,6 +21,11 @@ export const XANOSCRIPT_DOCS_V2 = {
         applyTo: ["**/*.xs"],
         description: "Expressions, operators, and filters for all XanoScript code",
     },
+    quickstart: {
+        file: "quickstart.md",
+        applyTo: ["**/*.xs"],
+        description: "Common patterns, quick reference, and common mistakes to avoid",
+    },
     types: {
         file: "types.md",
         applyTo: ["functions/**/*.xs", "apis/**/*.xs", "tools/**/*.xs", "agents/**/*.xs"],

package/dist/xanoscript.test.js

@@ -11,6 +11,7 @@ describe("xanoscript module", () => {
             const expectedTopics = [
                 "readme",
                 "syntax",
+                "quickstart",
                 "types",
                 "tables",
                 "functions",
@@ -135,9 +136,10 @@ describe("xanoscript module", () => {
             const result = getDocsForFilePath("apis/test.xs");
             expect(result).not.toContain("readme");
         });
-        it("should put syntax first if not already matched", () => {
+        it("should include syntax and quickstart for .xs files", () => {
             const result = getDocsForFilePath("some/random/file.xs");
-            expect(result[0]).toBe("syntax");
+            expect(result).toContain("syntax");
+            expect(result).toContain("quickstart");
         });
     });
     describe("extractQuickReference", () => {