0xray 3.1.0 → 3.2.0

package/dist/mcps/knowledge-skills/tech-writer.server.js

@@ -4,193 +4,27 @@
  * Knowledge skill for automated documentation creation, API docs generation,
  * code documentation maintenance, and technical writing assistance
  */
-import { Server } from "@modelcontextprotocol/sdk/server/index.js";
-import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
-import { CallToolRequestSchema, ListToolsRequestSchema, } from "@modelcontextprotocol/sdk/types.js";
 import * as fs from "fs";
 import * as path from "path";
-import { createGracefulShutdown } from "../../utils/shutdown-handler.js";
-class XrayDocumentationGenerationServer {
-    server;
+import { XrayKnowledgeSkillBase } from "../shared/knowledge-skill-base.js";
+class XrayDocumentationGenerationServer extends XrayKnowledgeSkillBase {
     constructor() {
-        this.server = new Server({
-            name: "documentation-generation", version: "1.22.67",
-        }, {
-            capabilities: {
-                tools: {},
-            },
-        });
+        super("documentation-generation", "3.1.0");
+        this.tools = [
+            { name: "analyze_documentation", description: "Analyze existing documentation for completeness, quality, and gaps", inputSchema: { type: "object", properties: { docsPath: { type: "string", description: "Path to documentation directory or files" }, codePath: { type: "string", description: "Path to corresponding code for comparison" }, docTypes: { type: "array", items: { type: "string", enum: ["readme", "api", "code", "architecture", "deployment", "user-guide"] }, description: "Types of documentation to analyze" } }, required: ["docsPath"] } },
+            { name: "generate_api_docs", description: "Generate comprehensive API documentation from code analysis", inputSchema: { type: "object", properties: { codePath: { type: "string", description: "Path to API code files" }, framework: { type: "string", enum: ["express", "fastify", "koa", "nestjs", "spring", "django", "flask", "fastapi"], description: "API framework being used" }, format: { type: "string", enum: ["openapi", "markdown", "html", "postman"], description: "Output documentation format", default: "openapi" }, includeExamples: { type: "boolean", description: "Include request/response examples", default: true } }, required: ["codePath", "framework"] } },
+            { name: "generate_code_documentation", description: "Generate inline code documentation and improve existing docs", inputSchema: { type: "object", properties: { codePath: { type: "string", description: "Path to code files to document" }, language: { type: "string", enum: ["typescript", "javascript", "python", "java", "csharp", "go", "rust"], description: "Programming language" }, style: { type: "string", enum: ["jsdoc", "docstring", "xml", "markdown"], description: "Documentation comment style", default: "jsdoc" }, includePrivate: { type: "boolean", description: "Include documentation for private members", default: false } }, required: ["codePath", "language"] } },
+            { name: "generate_readme", description: "Generate or improve project README documentation", inputSchema: { type: "object", properties: { projectPath: { type: "string", description: "Path to project root directory" }, projectType: { type: "string", enum: ["library", "application", "api", "cli", "framework"], description: "Type of project" }, includeSections: { type: "array", items: { type: "string" }, description: "Specific sections to include", default: ["installation", "usage", "api", "contributing", "license"] }, existingReadme: { type: "string", description: "Path to existing README to improve" } }, required: ["projectPath", "projectType"] } },
+        ];
+        this.handlers = {
+            analyze_documentation: async (args) => this.analyzeDocumentation(args),
+            generate_api_docs: async (args) => this.generateAPIDocs(args),
+            generate_code_documentation: async (args) => this.generateCodeDocumentation(args),
+            generate_readme: async (args) => this.generateReadme(args),
+        };
         this.setupToolHandlers();
-        // Server initialization - removed unnecessary startup logging
-    }
-    setupToolHandlers() {
-        this.server.setRequestHandler(ListToolsRequestSchema, async () => {
-            return {
-                tools: [
-                    {
-                        name: "analyze_documentation",
-                        description: "Analyze existing documentation for completeness, quality, and gaps",
-                        inputSchema: {
-                            type: "object",
-                            properties: {
-                                docsPath: {
-                                    type: "string",
-                                    description: "Path to documentation directory or files",
-                                },
-                                codePath: {
-                                    type: "string",
-                                    description: "Path to corresponding code for comparison",
-                                },
-                                docTypes: {
-                                    type: "array",
-                                    items: {
-                                        type: "string",
-                                        enum: [
-                                            "readme",
-                                            "api",
-                                            "code",
-                                            "architecture",
-                                            "deployment",
-                                            "user-guide",
-                                        ],
-                                    },
-                                    description: "Types of documentation to analyze",
-                                },
-                            },
-                            required: ["docsPath"],
-                        },
-                    },
-                    {
-                        name: "generate_api_docs",
-                        description: "Generate comprehensive API documentation from code analysis",
-                        inputSchema: {
-                            type: "object",
-                            properties: {
-                                codePath: {
-                                    type: "string",
-                                    description: "Path to API code files",
-                                },
-                                framework: {
-                                    type: "string",
-                                    enum: [
-                                        "express",
-                                        "fastify",
-                                        "koa",
-                                        "nestjs",
-                                        "spring",
-                                        "django",
-                                        "flask",
-                                        "fastapi",
-                                    ],
-                                    description: "API framework being used",
-                                },
-                                format: {
-                                    type: "string",
-                                    enum: ["openapi", "markdown", "html", "postman"],
-                                    description: "Output documentation format",
-                                    default: "openapi",
-                                },
-                                includeExamples: {
-                                    type: "boolean",
-                                    description: "Include request/response examples",
-                                    default: true,
-                                },
-                            },
-                            required: ["codePath", "framework"],
-                        },
-                    },
-                    {
-                        name: "generate_code_documentation",
-                        description: "Generate inline code documentation and improve existing docs",
-                        inputSchema: {
-                            type: "object",
-                            properties: {
-                                codePath: {
-                                    type: "string",
-                                    description: "Path to code files to document",
-                                },
-                                language: {
-                                    type: "string",
-                                    enum: [
-                                        "typescript",
-                                        "javascript",
-                                        "python",
-                                        "java",
-                                        "csharp",
-                                        "go",
-                                        "rust",
-                                    ],
-                                    description: "Programming language",
-                                },
-                                style: {
-                                    type: "string",
-                                    enum: ["jsdoc", "docstring", "xml", "markdown"],
-                                    description: "Documentation comment style",
-                                    default: "jsdoc",
-                                },
-                                includePrivate: {
-                                    type: "boolean",
-                                    description: "Include documentation for private members",
-                                    default: false,
-                                },
-                            },
-                            required: ["codePath", "language"],
-                        },
-                    },
-                    {
-                        name: "generate_readme",
-                        description: "Generate or improve project README documentation",
-                        inputSchema: {
-                            type: "object",
-                            properties: {
-                                projectPath: {
-                                    type: "string",
-                                    description: "Path to project root directory",
-                                },
-                                projectType: {
-                                    type: "string",
-                                    enum: ["library", "application", "api", "cli", "framework"],
-                                    description: "Type of project",
-                                },
-                                includeSections: {
-                                    type: "array",
-                                    items: { type: "string" },
-                                    description: "Specific sections to include",
-                                    default: [
-                                        "installation",
-                                        "usage",
-                                        "api",
-                                        "contributing",
-                                        "license",
-                                    ],
-                                },
-                                existingReadme: {
-                                    type: "string",
-                                    description: "Path to existing README to improve",
-                                },
-                            },
-                            required: ["projectPath", "projectType"],
-                        },
-                    },
-                ],
-            };
-        });
-        this.server.setRequestHandler(CallToolRequestSchema, async (request) => {
-            const { name, arguments: args } = request.params;
-            switch (name) {
-                case "analyze_documentation":
-                    return await this.analyzeDocumentation(args);
-                case "generate_api_docs":
-                    return await this.generateAPIDocs(args);
-                case "generate_code_documentation":
-                    return await this.generateCodeDocumentation(args);
-                case "generate_readme":
-                    return await this.generateReadme(args);
-                default:
-                    throw new Error(`Unknown tool: ${name}`);
-            }
-        });
     }
+    // setupToolHandlers removed — handled by XrayKnowledgeSkillBase via this.tools + this.handlers
     async analyzeDocumentation(args) {
         const { docsPath, codePath, docTypes = ["readme", "api", "code"] } = args;
         try {
@@ -727,7 +561,7 @@ class XrayDocumentationGenerationServer {
             openapi: "3.0.0",
             info: {
                 title: "API Documentation",
-                version: "1.22.67",
+                version: "3.1.0",
                 description: "Generated API documentation",
             },
             servers: [
@@ -1173,18 +1007,9 @@ class XrayDocumentationGenerationServer {
         };
         return icons[severity] || "❓";
     }
-    async run() {
-        const transport = new StdioServerTransport();
-        await this.server.connect(transport);
-        // Use centralized shutdown handler
-        createGracefulShutdown({
-            serverName: "tech-writer.server",
-            server: this.server,
-        });
-    }
 }
 // Run the server if this file is executed directly
-if (import.meta.url === `file://${process.argv[1]}`) {
+if (import.meta.url === `file://${fs.realpathSync(process.argv[1])}`) {
     const server = new XrayDocumentationGenerationServer();
     server.run().catch(() => { });
 }

package/dist/mcps/knowledge-skills/testing-best-practices.server.js

@@ -4,191 +4,28 @@
  * Knowledge skill for comprehensive testing strategies, TDD/BDD implementation,
  * test coverage optimization, and automated testing workflows
  */
-import { Server } from "@modelcontextprotocol/sdk/server/index.js";
-import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
-import { createGracefulShutdown } from "../../utils/shutdown-handler.js";
-import { CallToolRequestSchema, ListToolsRequestSchema, } from "@modelcontextprotocol/sdk/types.js";
-class XrayTestingBestPracticesServer {
-    server;
+import * as fs from "fs";
+import { XrayKnowledgeSkillBase } from "../shared/knowledge-skill-base.js";
+class XrayTestingBestPracticesServer extends XrayKnowledgeSkillBase {
     constructor() {
-        this.server = new Server({
-            name: "testing-best-practices", version: "1.22.67",
-        }, {
-            capabilities: {
-                tools: {},
-            },
-        });
+        super("testing-best-practices", "3.1.0");
+        this.tools = [
+            { name: "analyze_test_coverage", description: "Analyze current test coverage and identify gaps", inputSchema: { type: "object", properties: { codePath: { type: "string", description: "Path to codebase to analyze" }, testFramework: { type: "string", description: "Testing framework used (jest, vitest, mocha, etc.)", default: "auto-detect" }, coverageThreshold: { type: "number", description: "Minimum coverage threshold (0-100)", default: 80 } }, required: ["codePath"] } },
+            { name: "design_test_strategy", description: "Design comprehensive testing strategy for a project", inputSchema: { type: "object", properties: { projectType: { type: "string", enum: ["web-app", "api", "library", "mobile", "desktop"], description: "Type of project" }, techStack: { type: "array", items: { type: "string" }, description: "Technologies used (react, node, typescript, etc.)" }, teamSize: { type: "string", enum: ["solo", "small", "medium", "large"], description: "Development team size" }, timeline: { type: "string", enum: ["rapid", "balanced", "thorough"], description: "Development timeline priority" } }, required: ["projectType"] } },
+            { name: "implement_tdd_workflow", description: "Implement Test-Driven Development workflow and practices", inputSchema: { type: "object", properties: { language: { type: "string", description: "Programming language", default: "typescript" }, framework: { type: "string", description: "Preferred testing framework", default: "jest" }, existingTests: { type: "boolean", description: "Whether tests already exist", default: false } }, required: [] } },
+            { name: "optimize_test_performance", description: "Analyze and optimize test execution performance", inputSchema: { type: "object", properties: { testResults: { type: "string", description: "Path to test results or current execution time" }, targetRuntime: { type: "number", description: "Target test execution time in seconds", default: 300 }, parallelExecution: { type: "boolean", description: "Whether parallel execution is supported", default: true } }, required: ["testResults"] } },
+            { name: "setup_ci_cd_testing", description: "Set up comprehensive CI/CD testing pipeline", inputSchema: { type: "object", properties: { ciPlatform: { type: "string", enum: ["github-actions", "gitlab-ci", "jenkins", "circle-ci", "travis-ci"], description: "CI/CD platform" }, testTypes: { type: "array", items: { type: "string", enum: ["unit", "integration", "e2e", "performance", "security"] }, description: "Types of tests to include" }, coverageReporting: { type: "boolean", description: "Enable coverage reporting", default: true } }, required: ["ciPlatform", "testTypes"] } },
+        ];
+        this.handlers = {
+            analyze_test_coverage: async (args) => this.analyzeTestCoverage(args),
+            design_test_strategy: async (args) => this.designTestStrategy(args),
+            implement_tdd_workflow: async (args) => this.implementTDDWorkflow(args),
+            optimize_test_performance: async (args) => this.optimizeTestPerformance(args),
+            setup_ci_cd_testing: async (args) => this.setupCICDTesting(args),
+        };
         this.setupToolHandlers();
-        // Server initialization - removed unnecessary startup logging
-    }
-    setupToolHandlers() {
-        this.server.setRequestHandler(ListToolsRequestSchema, async () => {
-            return {
-                tools: [
-                    {
-                        name: "analyze_test_coverage",
-                        description: "Analyze current test coverage and identify gaps",
-                        inputSchema: {
-                            type: "object",
-                            properties: {
-                                codePath: {
-                                    type: "string",
-                                    description: "Path to codebase to analyze",
-                                },
-                                testFramework: {
-                                    type: "string",
-                                    description: "Testing framework used (jest, vitest, mocha, etc.)",
-                                    default: "auto-detect",
-                                },
-                                coverageThreshold: {
-                                    type: "number",
-                                    description: "Minimum coverage threshold (0-100)",
-                                    default: 80,
-                                },
-                            },
-                            required: ["codePath"],
-                        },
-                    },
-                    {
-                        name: "design_test_strategy",
-                        description: "Design comprehensive testing strategy for a project",
-                        inputSchema: {
-                            type: "object",
-                            properties: {
-                                projectType: {
-                                    type: "string",
-                                    enum: ["web-app", "api", "library", "mobile", "desktop"],
-                                    description: "Type of project",
-                                },
-                                techStack: {
-                                    type: "array",
-                                    items: { type: "string" },
-                                    description: "Technologies used (react, node, typescript, etc.)",
-                                },
-                                teamSize: {
-                                    type: "string",
-                                    enum: ["solo", "small", "medium", "large"],
-                                    description: "Development team size",
-                                },
-                                timeline: {
-                                    type: "string",
-                                    enum: ["rapid", "balanced", "thorough"],
-                                    description: "Development timeline priority",
-                                },
-                            },
-                            required: ["projectType"],
-                        },
-                    },
-                    {
-                        name: "implement_tdd_workflow",
-                        description: "Implement Test-Driven Development workflow and practices",
-                        inputSchema: {
-                            type: "object",
-                            properties: {
-                                language: {
-                                    type: "string",
-                                    description: "Programming language",
-                                    default: "typescript",
-                                },
-                                framework: {
-                                    type: "string",
-                                    description: "Preferred testing framework",
-                                    default: "jest",
-                                },
-                                existingTests: {
-                                    type: "boolean",
-                                    description: "Whether tests already exist",
-                                    default: false,
-                                },
-                            },
-                            required: [],
-                        },
-                    },
-                    {
-                        name: "optimize_test_performance",
-                        description: "Analyze and optimize test execution performance",
-                        inputSchema: {
-                            type: "object",
-                            properties: {
-                                testResults: {
-                                    type: "string",
-                                    description: "Path to test results or current execution time",
-                                },
-                                targetRuntime: {
-                                    type: "number",
-                                    description: "Target test execution time in seconds",
-                                    default: 300,
-                                },
-                                parallelExecution: {
-                                    type: "boolean",
-                                    description: "Whether parallel execution is supported",
-                                    default: true,
-                                },
-                            },
-                            required: ["testResults"],
-                        },
-                    },
-                    {
-                        name: "setup_ci_cd_testing",
-                        description: "Set up comprehensive CI/CD testing pipeline",
-                        inputSchema: {
-                            type: "object",
-                            properties: {
-                                ciPlatform: {
-                                    type: "string",
-                                    enum: [
-                                        "github-actions",
-                                        "gitlab-ci",
-                                        "jenkins",
-                                        "circle-ci",
-                                        "travis-ci",
-                                    ],
-                                    description: "CI/CD platform",
-                                },
-                                testTypes: {
-                                    type: "array",
-                                    items: {
-                                        type: "string",
-                                        enum: [
-                                            "unit",
-                                            "integration",
-                                            "e2e",
-                                            "performance",
-                                            "security",
-                                        ],
-                                    },
-                                    description: "Types of tests to include",
-                                },
-                                coverageReporting: {
-                                    type: "boolean",
-                                    description: "Enable coverage reporting",
-                                    default: true,
-                                },
-                            },
-                            required: ["ciPlatform", "testTypes"],
-                        },
-                    },
-                ],
-            };
-        });
-        this.server.setRequestHandler(CallToolRequestSchema, async (request) => {
-            const { name, arguments: args } = request.params;
-            switch (name) {
-                case "analyze_test_coverage":
-                    return await this.analyzeTestCoverage(args);
-                case "design_test_strategy":
-                    return await this.designTestStrategy(args);
-                case "implement_tdd_workflow":
-                    return await this.implementTDDWorkflow(args);
-                case "optimize_test_performance":
-                    return await this.optimizeTestPerformance(args);
-                case "setup_ci_cd_testing":
-                    return await this.setupCICDTesting(args);
-                default:
-                    throw new Error(`Unknown tool: ${name}`);
-            }
-        });
     }
+    // setupToolHandlers removed — handled by XrayKnowledgeSkillBase via this.tools + this.handlers
     async analyzeTestCoverage(args) {
         const { codePath, testFramework = "auto-detect", coverageThreshold = 80, } = args;
         try {
@@ -848,18 +685,9 @@ class XrayTestingBestPracticesServer {
         };
         return icons[type] || "🧪";
     }
-    async run() {
-        const transport = new StdioServerTransport();
-        await this.server.connect(transport);
-        // Use centralized shutdown handler
-        createGracefulShutdown({
-            serverName: "testing-best-practices.server",
-            server: this.server,
-        });
-    }
 }
 // Run the server if this file is executed directly
-if (import.meta.url === `file://${process.argv[1]}`) {
+if (import.meta.url === `file://${fs.realpathSync(process.argv[1])}`) {
     const server = new XrayTestingBestPracticesServer();
     server.run().catch(() => { });
 }