@cyanheads/git-mcp-server 2.1.8 → 2.2.0

package/dist/mcp-server/tools/gitLog/logic.js

@@ -1,284 +1,102 @@
+/**
+ * @fileoverview Defines the core logic, schemas, and types for the git_log tool.
+ * @module src/mcp-server/tools/gitLog/logic
+ */
 import { execFile } from "child_process";
 import { promisify } from "util";
 import { z } from "zod";
-// Import utils from barrel (logger from ../utils/internal/logger.js)
-import { logger } from "../../../utils/index.js";
-// Import utils from barrel (RequestContext from ../utils/internal/requestContext.js)
-import { BaseErrorCode, McpError } from "../../../types-global/errors.js"; // Keep direct import for types-global
-// Import utils from barrel (sanitization from ../utils/security/sanitization.js)
-import { sanitization } from "../../../utils/index.js";
+import { logger, sanitization } from "../../../utils/index.js";
+import { McpError, BaseErrorCode } from "../../../types-global/errors.js";
 const execFileAsync = promisify(execFile);
-// Define the structure for a single commit entry
-export const CommitEntrySchema = z.object({
+// 1. DEFINE the Zod input schema.
+export const GitLogInputSchema = z.object({
+    path: z.string().default(".").describe("Path to the Git repository."),
+    maxCount: z.number().int().positive().optional().describe("Limit the number of commits to output."),
+    author: z.string().optional().describe("Limit commits to those by a specific author."),
+    since: z.string().optional().describe("Show commits more recent than a specific date (e.g., '2 weeks ago')."),
+    until: z.string().optional().describe("Show commits older than a specific date."),
+    branchOrFile: z.string().optional().describe("Show logs for a specific branch, tag, or file path."),
+    showSignature: z.boolean().default(false).describe("Show signature verification status for commits."),
+});
+// 2. DEFINE the Zod response schema.
+const CommitEntrySchema = z.object({
     hash: z.string().describe("Full commit hash"),
     authorName: z.string().describe("Author's name"),
     authorEmail: z.string().email().describe("Author's email"),
-    timestamp: z
-        .number()
-        .int()
-        .positive()
-        .describe("Commit timestamp (Unix epoch seconds)"),
+    timestamp: z.number().int().positive().describe("Commit timestamp (Unix epoch seconds)"),
     subject: z.string().describe("Commit subject line"),
-    body: z.string().optional().describe("Commit body (optional)"),
+    body: z.string().optional().describe("Commit body"),
 });
-// Define the input schema for the git_log tool using Zod
-export const GitLogInputSchema = z.object({
-    path: z
-        .string()
-        .min(1)
-        .optional()
-        .default(".")
-        .describe("Path to the Git repository. Defaults to the directory set via `git_set_working_dir` for the session; set 'git_set_working_dir' if not set."),
-    maxCount: z
-        .number()
-        .int()
-        .positive()
-        .optional()
-        .describe("Limit the number of commits to output."),
-    author: z
-        .string()
-        .optional()
-        .describe("Limit commits to those matching the specified author pattern."),
-    since: z
-        .string()
-        .optional()
-        .describe("Show commits more recent than a specific date (e.g., '2 weeks ago', '2023-01-01')."),
-    until: z
-        .string()
-        .optional()
-        .describe("Show commits older than a specific date."),
-    branchOrFile: z
-        .string()
-        .optional()
-        .describe("Show logs for a specific branch (e.g., 'main'), tag, or file path (e.g., 'src/utils/logger.ts')."),
-    showSignature: z
-        .boolean()
-        .optional()
-        .default(false)
-        .describe("Show signature verification status for commits. Returns raw output instead of parsed JSON."),
-    // Note: We use a fixed pretty format for reliable parsing unless showSignature is true.
+export const GitLogOutputSchema = z.object({
+    success: z.boolean().describe("Indicates if the command was successful."),
+    message: z.string().describe("A summary message of the result."),
+    commits: z.array(CommitEntrySchema).optional().describe("A list of commits."),
+    rawOutput: z.string().optional().describe("Raw output from the git log command, used when showSignature is true."),
 });
-// Delimiters for parsing the custom format
-const FIELD_SEP = "\x1f"; // Unit Separator
-const RECORD_SEP = "\x1e"; // Record Separator
-const GIT_LOG_FORMAT = `--pretty=format:%H${FIELD_SEP}%an${FIELD_SEP}%ae${FIELD_SEP}%at${FIELD_SEP}%s${FIELD_SEP}%b${RECORD_SEP}`; // %H=hash, %an=author name, %ae=author email, %at=timestamp, %s=subject, %b=body
+const FIELD_SEP = "\x1f";
+const RECORD_SEP = "\x1e";
+const GIT_LOG_FORMAT = `--pretty=format:%H${FIELD_SEP}%an${FIELD_SEP}%ae${FIELD_SEP}%at${FIELD_SEP}%s${FIELD_SEP}%b${RECORD_SEP}`;
 /**
- * Executes the 'git log' command with a specific format and returns structured JSON output.
- *
- * @param {GitLogInput} input - The validated input object.
- * @param {RequestContext} context - The request context for logging and error handling.
- * @returns {Promise<GitLogResult>} A promise that resolves with the structured log result (either flat or grouped).
- * @throws {McpError} Throws an McpError if path resolution, validation, or the git command fails unexpectedly.
+ * 4. IMPLEMENT the core logic function.
+ * @throws {McpError} If the logic encounters an unrecoverable issue.
  */
-export async function logGitHistory(input, context) {
-    // Return type updated to the union
+export async function logGitHistory(params, context) {
     const operation = "logGitHistory";
-    logger.debug(`Executing ${operation}`, { ...context, input });
-    let targetPath;
-    try {
-        // Resolve and sanitize the target path
-        if (input.path && input.path !== ".") {
-            targetPath = input.path;
-        }
-        else {
-            const workingDir = context.getWorkingDirectory();
-            if (!workingDir) {
-                throw new McpError(BaseErrorCode.VALIDATION_ERROR, "No path provided and no working directory set for the session.", { context, operation });
-            }
-            targetPath = workingDir;
-        }
-        targetPath = sanitization.sanitizePath(targetPath, {
-            allowAbsolute: true,
-        }).sanitizedPath;
-        logger.debug("Sanitized path", {
-            ...context,
-            operation,
-            sanitizedPath: targetPath,
-        });
+    logger.debug(`Executing ${operation}`, { ...context, params });
+    const workingDir = context.getWorkingDirectory();
+    if (params.path === "." && !workingDir) {
+        throw new McpError(BaseErrorCode.VALIDATION_ERROR, "No session working directory set. Please specify a 'path' or use 'git_set_working_dir' first.");
     }
-    catch (error) {
-        logger.error("Path resolution or sanitization failed", {
-            ...context,
-            operation,
-            error,
-        });
-        if (error instanceof McpError)
-            throw error;
-        throw new McpError(BaseErrorCode.VALIDATION_ERROR, `Invalid path: ${error instanceof Error ? error.message : String(error)}`, { context, operation, originalError: error });
+    const targetPath = sanitization.sanitizePath(params.path === "." ? workingDir : params.path, { allowAbsolute: true }).sanitizedPath;
+    const args = ["-C", targetPath, "log"];
+    if (params.showSignature) {
+        args.push("--show-signature");
+    }
+    else {
+        args.push(GIT_LOG_FORMAT);
     }
+    if (params.maxCount)
+        args.push(`-n${params.maxCount}`);
+    if (params.author)
+        args.push(`--author=${params.author}`);
+    if (params.since)
+        args.push(`--since=${params.since}`);
+    if (params.until)
+        args.push(`--until=${params.until}`);
+    if (params.branchOrFile)
+        args.push(params.branchOrFile);
     try {
-        const args = ["-C", targetPath, "log"];
-        let isRawOutput = false; // Flag to indicate if we should parse or return raw
-        if (input.showSignature) {
-            isRawOutput = true;
-            args.push("--show-signature");
-            logger.info("Show signature requested, returning raw output.", {
-                ...context,
-                operation,
-            });
-        }
-        else {
-            args.push(GIT_LOG_FORMAT);
-        }
-        if (input.maxCount) {
-            args.push(`-n${input.maxCount}`);
-        }
-        if (input.author) {
-            args.push(`--author=${input.author}`);
-        }
-        if (input.since) {
-            args.push(`--since=${input.since}`);
-        }
-        if (input.until) {
-            args.push(`--until=${input.until}`);
-        }
-        if (input.branchOrFile) {
-            args.push(input.branchOrFile);
-        }
-        logger.debug(`Executing command: git ${args.join(" ")}`, {
-            ...context,
-            operation,
-        });
-        // Increase maxBuffer if logs can be large
-        const { stdout, stderr } = await execFileAsync("git", args, {
-            maxBuffer: 1024 * 1024 * 10,
-        }); // 10MB buffer
-        if (stderr) {
-            // Log stderr as warning, as git log might sometimes use it for non-fatal info
-            // Exception: If showing signature, stderr about allowedSignersFile is expected, treat as info
-            if (isRawOutput &&
-                stderr.includes("allowedSignersFile needs to be configured")) {
-                logger.info(`Git log stderr (signature verification note): ${stderr.trim()}`, { ...context, operation });
-            }
-            else {
-                logger.warning(`Git log stderr: ${stderr.trim()}`, {
-                    ...context,
-                    operation,
-                });
-            }
-        }
-        // If raw output was requested, return it directly in the message field, omitting commits
-        if (isRawOutput) {
-            const message = `Raw log output (showSignature=true):\n${stdout}`;
-            logger.info(`${operation} completed successfully (raw output).`, {
-                ...context,
-                operation,
-                path: targetPath,
-            });
-            // Return without the 'commits' or 'groupedCommits' field
-            return { success: true, message: message };
-        }
-        // --- Parse the structured output into a flat list first ---
-        const flatCommits = [];
-        const commitRecords = stdout
-            .split(RECORD_SEP)
-            .filter((record) => record.trim() !== ""); // Split records and remove empty ones
-        for (const record of commitRecords) {
-            const trimmedRecord = record.trim(); // Trim leading/trailing whitespace (like newlines)
-            if (!trimmedRecord)
-                continue; // Skip empty records after trimming
-            const fields = trimmedRecord.split(FIELD_SEP); // Split the trimmed record
-            if (fields.length >= 5) {
-                // Need at least hash, name, email, timestamp, subject
-                try {
-                    const commitEntry = {
-                        hash: fields[0],
-                        authorName: fields[1],
-                        authorEmail: fields[2],
-                        timestamp: parseInt(fields[3], 10), // Unix timestamp
-                        subject: fields[4],
-                        body: fields[5] || undefined, // Body might be empty
-                    };
-                    // Validate parsed entry
-                    CommitEntrySchema.parse(commitEntry);
-                    flatCommits.push(commitEntry);
-                }
-                catch (parseError) {
-                    logger.warning(`Failed to parse commit record field`, {
-                        ...context,
-                        operation,
-                        fieldIndex: fields.findIndex((_, i) => i > 5),
-                        recordFragment: record.substring(0, 100),
-                        parseError,
-                    });
-                    // Decide whether to skip the commit or throw an error
-                }
-            }
-            else {
-                logger.warning(`Skipping commit record due to unexpected number of fields (${fields.length})`, { ...context, operation, recordFragment: record.substring(0, 100) });
-            }
-        }
-        // --- Group the flat list by author ---
-        const groupedCommitsMap = new Map();
-        for (const commit of flatCommits) {
-            const authorKey = `${commit.authorName} <${commit.authorEmail}>`;
-            const groupedInfo = {
-                hash: commit.hash,
-                timestamp: commit.timestamp,
-                subject: commit.subject,
-                body: commit.body,
+        logger.debug(`Executing command: git ${args.join(" ")}`, { ...context, operation });
+        const { stdout } = await execFileAsync("git", args, { maxBuffer: 1024 * 1024 * 10 });
+        if (params.showSignature) {
+            return { success: true, message: "Raw log output with signature status.", rawOutput: stdout };
+        }
+        const commitRecords = stdout.split(RECORD_SEP).filter(r => r.trim());
+        const commits = commitRecords.map(record => {
+            const fields = record.trim().split(FIELD_SEP);
+            return {
+                hash: fields[0],
+                authorName: fields[1],
+                authorEmail: fields[2],
+                timestamp: parseInt(fields[3], 10),
+                subject: fields[4],
+                body: fields[5] || undefined,
             };
-            if (groupedCommitsMap.has(authorKey)) {
-                groupedCommitsMap.get(authorKey).commits.push(groupedInfo);
-            }
-            else {
-                groupedCommitsMap.set(authorKey, {
-                    authorName: commit.authorName,
-                    authorEmail: commit.authorEmail,
-                    commits: [groupedInfo],
-                });
-            }
-        }
-        const groupedCommits = Array.from(groupedCommitsMap.values());
-        // --- Prepare final result ---
-        const commitCount = flatCommits.length;
-        const message = commitCount > 0
-            ? `${commitCount} commit(s) found.`
-            : "No commits found matching criteria.";
-        logger.info(message, {
-            ...context,
-            operation,
-            path: targetPath,
-            commitCount: commitCount,
-            authorGroupCount: groupedCommits.length,
         });
-        return { success: true, groupedCommits, message }; // Return the grouped structure
+        return { success: true, message: `Found ${commits.length} commit(s).`, commits };
     }
     catch (error) {
-        logger.error(`Failed to execute git log command`, {
-            ...context,
-            operation,
-            path: targetPath,
-            error: error.message,
-            stderr: error.stderr,
-            stdout: error.stdout,
-        });
-        const errorMessage = error.stderr || error.stdout || error.message || "";
-        // Handle specific error cases
+        const errorMessage = error.stderr || error.message || "";
+        logger.error(`Failed to execute git log command`, { ...context, operation, errorMessage });
         if (errorMessage.toLowerCase().includes("not a git repository")) {
-            throw new McpError(BaseErrorCode.NOT_FOUND, `Path is not a Git repository: ${targetPath}`, { context, operation, originalError: error });
+            throw new McpError(BaseErrorCode.NOT_FOUND, `Path is not a Git repository: ${targetPath}`);
         }
-        if (errorMessage.includes("fatal: bad revision")) {
-            throw new McpError(BaseErrorCode.NOT_FOUND, `Invalid branch, tag, or revision specified: '${input.branchOrFile}'. Error: ${errorMessage}`, { context, operation, originalError: error });
+        if (errorMessage.includes("bad revision")) {
+            throw new McpError(BaseErrorCode.NOT_FOUND, `Invalid branch, tag, or revision specified: '${params.branchOrFile}'.`);
         }
-        if (errorMessage.includes("fatal: ambiguous argument")) {
-            throw new McpError(BaseErrorCode.VALIDATION_ERROR, `Ambiguous argument provided (e.g., branch/tag/file conflict): '${input.branchOrFile}'. Error: ${errorMessage}`, { context, operation, originalError: error });
-        }
-        // Check if it's just that no commits were found
         if (errorMessage.includes("does not have any commits yet")) {
-            logger.info("Repository has no commits yet.", {
-                ...context,
-                operation,
-                path: targetPath,
-            });
-            // Return the grouped structure even for no commits
-            return {
-                success: true,
-                groupedCommits: [],
-                message: "Repository has no commits yet.",
-            };
+            return { success: true, message: "Repository has no commits yet.", commits: [] };
         }
-        // Generic internal error for other failures
-        throw new McpError(BaseErrorCode.INTERNAL_ERROR, `Failed to get git log for path: ${targetPath}. Error: ${errorMessage}`, { context, operation, originalError: error });
+        throw new McpError(BaseErrorCode.INTERNAL_ERROR, `Git log failed: ${errorMessage}`);
     }
 }

package/dist/mcp-server/tools/gitLog/registration.js

@@ -1,76 +1,64 @@
-// Import utils from barrel (ErrorHandler from ../utils/internal/errorHandler.js)
-import { ErrorHandler } from "../../../utils/index.js";
-// Import utils from barrel (logger from ../utils/internal/logger.js)
-import { logger } from "../../../utils/index.js";
-// Import utils from barrel (requestContextService, RequestContext from ../utils/internal/requestContext.js)
-import { BaseErrorCode } from "../../../types-global/errors.js"; // Keep direct import for types-global
-import { requestContextService } from "../../../utils/index.js";
-import { GitLogInputSchema, logGitHistory, } from "./logic.js";
-let _getWorkingDirectory;
-let _getSessionId;
 /**
- * Initializes the state accessors needed by the tool registration.
- * This should be called once during server setup.
- * @param getWdFn - Function to get the working directory for a session.
- * @param getSidFn - Function to get the session ID from context.
+ * @fileoverview Handles registration and error handling for the git_log tool.
+ * @module src/mcp-server/tools/gitLog/registration
  */
-export function initializeGitLogStateAccessors(getWdFn, getSidFn) {
-    _getWorkingDirectory = getWdFn;
-    _getSessionId = getSidFn;
-    logger.info("State accessors initialized for git_log tool registration.");
-}
+import { ErrorHandler, logger, requestContextService } from "../../../utils/index.js";
+import { McpError, BaseErrorCode } from "../../../types-global/errors.js";
+import { logGitHistory, GitLogInputSchema, GitLogOutputSchema, } from "./logic.js";
 const TOOL_NAME = "git_log";
-const TOOL_DESCRIPTION = "Shows commit logs for the repository. Supports limiting count, filtering by author, date range, and specific branch/file. Returns a JSON object containing a list of commit objects (`commits` array) by default. If `showSignature: true` is used, it returns a JSON object where the `commits` array is empty and the raw signature verification output is included in the `message` field.";
+const TOOL_DESCRIPTION = "Shows commit logs for the repository. Supports limiting count, filtering by author, date range, and specific branch/file. Returns a JSON object containing a list of commit objects (`commits` array) by default. If `showSignature: true` is used, it returns a JSON object where the `commits` array is empty and the raw signature verification output is included in the `rawOutput` field.";
 /**
- * Registers the git_log tool with the MCP server.
- *
- * @param {McpServer} server - The MCP server instance.
- * @throws {Error} If state accessors are not initialized.
+ * Registers the git_log tool with the MCP server instance.
+ * @param server The MCP server instance.
+ * @param getWorkingDirectory Function to get the session's working directory.
+ * @param getSessionId Function to get the session ID from context.
  */
-export async function registerGitLogTool(server) {
-    if (!_getWorkingDirectory || !_getSessionId) {
-        throw new Error("State accessors for git_log must be initialized before registration.");
-    }
+export const registerGitLogTool = async (server, getWorkingDirectory, getSessionId) => {
     const operation = "registerGitLogTool";
     const context = requestContextService.createRequestContext({ operation });
-    await ErrorHandler.tryCatch(async () => {
-        server.tool(TOOL_NAME, TOOL_DESCRIPTION, GitLogInputSchema.shape, // Provide the Zod schema shape
-        async (validatedArgs, callContext) => {
-            const toolOperation = "tool:git_log";
-            const requestContext = requestContextService.createRequestContext({
-                operation: toolOperation,
-                parentContext: callContext,
+    server.registerTool(TOOL_NAME, {
+        title: "Git Log",
+        description: TOOL_DESCRIPTION,
+        inputSchema: GitLogInputSchema.shape,
+        outputSchema: GitLogOutputSchema.shape,
+        annotations: {
+            readOnlyHint: true,
+            destructiveHint: false,
+            idempotentHint: true,
+            openWorldHint: false,
+        },
+    }, async (params, callContext) => {
+        const handlerContext = requestContextService.createRequestContext({
+            toolName: TOOL_NAME,
+            parentContext: callContext,
+        });
+        try {
+            const sessionId = getSessionId(handlerContext);
+            const result = await logGitHistory(params, {
+                ...handlerContext,
+                getWorkingDirectory: () => getWorkingDirectory(sessionId),
             });
-            const sessionId = _getSessionId(requestContext);
-            const getWorkingDirectoryForSession = () => {
-                return _getWorkingDirectory(sessionId);
-            };
-            const logicContext = {
-                ...requestContext,
-                sessionId: sessionId,
-                getWorkingDirectory: getWorkingDirectoryForSession,
+            return {
+                structuredContent: result,
+                content: [{ type: "text", text: `Success: ${JSON.stringify(result, null, 2)}` }],
             };
-            logger.info(`Executing tool: ${TOOL_NAME}`, logicContext);
-            return await ErrorHandler.tryCatch(async () => {
-                // Call the core logic function
-                const logResult = await logGitHistory(validatedArgs, logicContext);
-                // Format the result (array of commits) as a JSON string within TextContent
-                const resultContent = {
-                    type: "text",
-                    // Stringify the entire GitLogResult object which includes the commits array and success flag
-                    text: JSON.stringify(logResult, null, 2), // Pretty-print JSON
-                    contentType: "application/json",
-                };
-                logger.info(`Tool ${TOOL_NAME} executed successfully, returning JSON`, logicContext);
-                // Success is determined by the logic function and included in the result object
-                return { content: [resultContent] };
-            }, {
-                operation: toolOperation,
-                context: logicContext,
-                input: validatedArgs,
-                errorCode: BaseErrorCode.INTERNAL_ERROR, // Default if unexpected error in logic
+        }
+        catch (error) {
+            logger.error(`Error in ${TOOL_NAME} handler`, { error, ...handlerContext });
+            const handledError = ErrorHandler.handleError(error, {
+                operation: `tool:${TOOL_NAME}`,
+                context: handlerContext,
+                input: params,
             });
-        });
-        logger.info(`Tool registered: ${TOOL_NAME}`, context);
-    }, { operation, context, critical: true });
-}
+            const mcpError = handledError instanceof McpError
+                ? handledError
+                : new McpError(BaseErrorCode.INTERNAL_ERROR, "An unexpected error occurred.", { originalError: handledError });
+            return {
+                isError: true,
+                content: [{ type: "text", text: mcpError.message }],
+                structuredContent: mcpError.details,
+            };
+        }
+    });
+    logger.info(`Tool '${TOOL_NAME}' registered successfully.`, context);
+};

package/dist/mcp-server/tools/gitMerge/index.js

@@ -1,7 +1,5 @@
 /**
- * @fileoverview Barrel file for the git_merge tool.
- * Exports the registration function and state accessor initialization function.
+ * @fileoverview Barrel file for the gitMerge tool.
+ * @module src/mcp-server/tools/gitMerge/index
  */
-export { registerGitMergeTool, initializeGitMergeStateAccessors, } from "./registration.js";
-// Export types if needed elsewhere, e.g.:
-// export type { GitMergeInput, GitMergeResult } from './logic.js';
+export { registerGitMergeTool } from "./registration.js";