@cyanheads/git-mcp-server 2.0.4 → 2.0.7

package/README.md

@@ -2,7 +2,7 @@
 
 [![TypeScript](https://img.shields.io/badge/TypeScript-^5.8.3-blue.svg)](https://www.typescriptlang.org/)
 [![Model Context Protocol](https://img.shields.io/badge/MCP%20SDK-^1.11.0-green.svg)](https://modelcontextprotocol.io/)
-[![Version](https://img.shields.io/badge/Version-2.0.4-blue.svg)](./CHANGELOG.md)
+[![Version](https://img.shields.io/badge/Version-2.0.7-blue.svg)](./CHANGELOG.md)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Status](https://img.shields.io/badge/Status-Stable-green.svg)](https://github.com/cyanheads/git-mcp-server/issues)
 [![GitHub](https://img.shields.io/github/stars/cyanheads/git-mcp-server?style=social)](https://github.com/cyanheads/git-mcp-server)
@@ -16,7 +16,9 @@ Built on the [`cyanheads/mcp-ts-template`](https://github.com/cyanheads/mcp-ts-t
 ## Table of Contents
 
 | [Overview](#overview) | [Features](#features) | [Installation](#installation) |
+
 | [Configuration](#configuration) | [Project Structure](#project-structure) |
+
 | [Tools](#tools) | [Resources](#resources) | [Development](#development) | [License](#license) |
 
 ## Overview
@@ -68,7 +70,7 @@ Leverages the robust utilities provided by the `mcp-ts-template`:
 
 1.  Install the package globally:
     ```bash
-    npm install git-mcp-server
+    npm install @cyanheads/git-mcp-server
     ```
 
 ### Install from Source
@@ -97,11 +99,12 @@ Configure the server using environment variables. Create a `.env` file in the pr
 | Variable              | Description                                                                                                                           | Default     |
 | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
 | `MCP_TRANSPORT_TYPE`  | Transport mechanism: `stdio` or `http`.                                                                                               | `stdio`     |
-| `MCP_HTTP_PORT`       | Port for the HTTP server (if `MCP_TRANSPORT_TYPE=http`). Retries next ports if busy.                                                  | `3000`      |
+| `MCP_HTTP_PORT`       | Port for the HTTP server (if `MCP_TRANSPORT_TYPE=http`). Retries next ports if busy.                                                  | `3010`      |
 | `MCP_HTTP_HOST`       | Host address for the HTTP server (if `MCP_TRANSPORT_TYPE=http`).                                                                      | `127.0.0.1` |
 | `MCP_ALLOWED_ORIGINS` | Comma-separated list of allowed origins for CORS (if `MCP_TRANSPORT_TYPE=http`).                                                      | (none)      |
 | `MCP_LOG_LEVEL`       | Logging level (`debug`, `info`, `notice`, `warning`, `error`, `crit`, `alert`, `emerg`). Inherited from template.                     | `info`      |
 | `GIT_SIGN_COMMITS`    | Set to `"true"` to enable signing attempts for commits made by the `git_commit` tool. Requires server-side Git/key setup (see below). | `false`     |
+| `MCP_AUTH_SECRET_KEY` | Secret key for signing/verifying authentication tokens (required if auth is enabled in the future).                                   | `''`        |
 
 ### MCP Client Settings
 
@@ -176,7 +179,7 @@ The Git MCP Server provides a suite of tools for interacting with Git repositori
 | `git_status`            | Gets repository status (branch, staged, modified, untracked files).                                      | `path?`                                                                                                         |
 | `git_tag`               | Manages tags (list, create annotated/lightweight, delete).                                               | `path?`, `mode`, `tagName?`, `message?`, `commitRef?`, `annotate?`                                              |
 
-_Note: The `path` parameter for most tools defaults to the session's working directory if set via `git_set_working_dir`, otherwise it defaults to the server's CWD._
+_Note: The `path` parameter for most tools defaults to the session's working directory if set via `git_set_working_dir`._
 
 ## Resources
 

package/dist/mcp-server/server.js

@@ -17,30 +17,30 @@ import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { config, environment } from '../config/index.js';
 // Import core utilities: ErrorHandler, logger, requestContextService.
 import { ErrorHandler, logger, requestContextService } from '../utils/index.js'; // Added RequestContext
-// Import registration AND state initialization functions for ALL Git tools (assuming pattern)
+// Import registration AND state initialization functions for ALL Git tools (alphabetized)
 import { registerGitAddTool, initializeGitAddStateAccessors } from './tools/gitAdd/index.js';
 import { registerGitBranchTool, initializeGitBranchStateAccessors } from './tools/gitBranch/index.js';
-import { registerGitCheckoutTool, initializeGitCheckoutStateAccessors } from './tools/gitCheckout/index.js'; // Assumed initializer
-import { registerGitCherryPickTool, initializeGitCherryPickStateAccessors } from './tools/gitCherryPick/index.js'; // Assumed initializer
-import { registerGitCleanTool, initializeGitCleanStateAccessors } from './tools/gitClean/index.js'; // Assumed initializer
-import { registerGitClearWorkingDirTool, initializeGitClearWorkingDirStateAccessors } from './tools/gitClearWorkingDir/index.js'; // Assumed initializer
-import { registerGitCloneTool } from './tools/gitClone/index.js'; // Removed initializer import
-import { registerGitCommitTool, initializeGitCommitStateAccessors } from './tools/gitCommit/index.js'; // Assumed initializer
-import { registerGitDiffTool, initializeGitDiffStateAccessors } from './tools/gitDiff/index.js'; // Assumed initializer
+import { registerGitCheckoutTool, initializeGitCheckoutStateAccessors } from './tools/gitCheckout/index.js';
+import { registerGitCherryPickTool, initializeGitCherryPickStateAccessors } from './tools/gitCherryPick/index.js';
+import { registerGitCleanTool, initializeGitCleanStateAccessors } from './tools/gitClean/index.js';
+import { registerGitClearWorkingDirTool, initializeGitClearWorkingDirStateAccessors } from './tools/gitClearWorkingDir/index.js';
+import { registerGitCloneTool } from './tools/gitClone/index.js'; // No initializer needed/available
+import { registerGitCommitTool, initializeGitCommitStateAccessors } from './tools/gitCommit/index.js';
+import { registerGitDiffTool, initializeGitDiffStateAccessors } from './tools/gitDiff/index.js';
 import { registerGitFetchTool, initializeGitFetchStateAccessors } from './tools/gitFetch/index.js';
-import { registerGitInitTool, initializeGitInitStateAccessors } from './tools/gitInit/index.js'; // Added initializer import
-import { registerGitLogTool, initializeGitLogStateAccessors } from './tools/gitLog/index.js'; // Assumed initializer
-import { registerGitMergeTool, initializeGitMergeStateAccessors } from './tools/gitMerge/index.js'; // Assumed initializer
+import { registerGitInitTool, initializeGitInitStateAccessors } from './tools/gitInit/index.js';
+import { registerGitLogTool, initializeGitLogStateAccessors } from './tools/gitLog/index.js';
+import { registerGitMergeTool, initializeGitMergeStateAccessors } from './tools/gitMerge/index.js';
 import { registerGitPullTool, initializeGitPullStateAccessors } from './tools/gitPull/index.js';
 import { registerGitPushTool, initializeGitPushStateAccessors } from './tools/gitPush/index.js';
-import { registerGitRebaseTool, initializeGitRebaseStateAccessors } from './tools/gitRebase/index.js'; // Assumed initializer
-import { registerGitRemoteTool, initializeGitRemoteStateAccessors } from './tools/gitRemote/index.js'; // Assumed initializer
-import { registerGitResetTool, initializeGitResetStateAccessors } from './tools/gitReset/index.js'; // Assumed initializer
+import { registerGitRebaseTool, initializeGitRebaseStateAccessors } from './tools/gitRebase/index.js';
+import { registerGitRemoteTool, initializeGitRemoteStateAccessors } from './tools/gitRemote/index.js';
+import { registerGitResetTool, initializeGitResetStateAccessors } from './tools/gitReset/index.js';
 import { registerGitSetWorkingDirTool, initializeGitSetWorkingDirStateAccessors } from './tools/gitSetWorkingDir/index.js';
-import { registerGitShowTool, initializeGitShowStateAccessors } from './tools/gitShow/index.js'; // Assumed initializer
-import { registerGitStashTool, initializeGitStashStateAccessors } from './tools/gitStash/index.js'; // Assumed initializer
-import { registerGitStatusTool, initializeGitStatusStateAccessors } from './tools/gitStatus/index.js'; // Assumed initializer
-import { registerGitTagTool, initializeGitTagStateAccessors } from './tools/gitTag/index.js'; // Assumed initializer
+import { registerGitShowTool, initializeGitShowStateAccessors } from './tools/gitShow/index.js';
+import { registerGitStashTool, initializeGitStashStateAccessors } from './tools/gitStash/index.js';
+import { registerGitStatusTool, initializeGitStatusStateAccessors } from './tools/gitStatus/index.js';
+import { registerGitTagTool, initializeGitTagStateAccessors } from './tools/gitTag/index.js';
 // Import transport setup functions AND state accessors
 import { startHttpTransport, getHttpSessionWorkingDirectory, setHttpSessionWorkingDirectory } from './transports/httpTransport.js';
 import { connectStdioTransport, getStdioWorkingDirectory, setStdioWorkingDirectory } from './transports/stdioTransport.js';
@@ -132,7 +132,7 @@ async function createMcpServerInstance() {
     // Pass the defined unified accessor functions to the initializers.
     logger.debug('Initializing state accessors for tools...', context);
     try {
-        // Call initializers for all tools that likely need state access.
+        // Call initializers for all tools that likely need state access (alphabetized).
         // If an initializer doesn't exist, the import would have failed earlier (or build will fail).
         initializeGitAddStateAccessors(getWorkingDirectory, getSessionIdFromContext);
         initializeGitBranchStateAccessors(getWorkingDirectory, getSessionIdFromContext);
@@ -140,11 +140,11 @@ async function createMcpServerInstance() {
         initializeGitCherryPickStateAccessors(getWorkingDirectory, getSessionIdFromContext);
         initializeGitCleanStateAccessors(getWorkingDirectory, getSessionIdFromContext);
         initializeGitClearWorkingDirStateAccessors(getWorkingDirectory, getSessionIdFromContext);
-        // initializeGitCloneStateAccessors(getWorkingDirectory, getSessionIdFromContext); // Removed call
+        // initializeGitCloneStateAccessors - No initializer needed/available
         initializeGitCommitStateAccessors(getWorkingDirectory, getSessionIdFromContext);
         initializeGitDiffStateAccessors(getWorkingDirectory, getSessionIdFromContext);
         initializeGitFetchStateAccessors(getWorkingDirectory, getSessionIdFromContext);
-        initializeGitInitStateAccessors(getWorkingDirectory, getSessionIdFromContext); // Added call
+        initializeGitInitStateAccessors(getWorkingDirectory, getSessionIdFromContext);
         initializeGitLogStateAccessors(getWorkingDirectory, getSessionIdFromContext);
         initializeGitMergeStateAccessors(getWorkingDirectory, getSessionIdFromContext);
         initializeGitPullStateAccessors(getWorkingDirectory, getSessionIdFromContext);
@@ -169,7 +169,7 @@ async function createMcpServerInstance() {
         throw initError; // Re-throw to prevent server starting incorrectly
     }
     try {
-        // Register all defined Git tools. These calls populate the server's
+        // Register all defined Git tools (alphabetized). These calls populate the server's
         // internal registry, making them available via MCP methods like 'tools/list'.
         logger.debug('Registering Git tools...', context);
         await registerGitAddTool(server);

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

@@ -20,6 +20,7 @@ export const GitCommitInputSchema = z.object({
     allowEmpty: z.boolean().default(false).describe('Allow creating empty commits'),
     amend: z.boolean().default(false).describe('Amend the previous commit instead of creating a new one'),
     forceUnsignedOnFailure: z.boolean().default(false).describe('If true and signing is enabled but fails, attempt the commit without signing instead of failing.'),
+    filesToStage: z.array(z.string().min(1)).optional().describe('Optional array of specific file paths (relative to the repository root) to stage automatically before committing. If provided, only these files will be staged.'),
 });
 /**
  * Executes the 'git commit' command and returns structured JSON output.
@@ -61,6 +62,24 @@ export async function commitGitChanges(input, context // Add getter to context
         throw new McpError(BaseErrorCode.VALIDATION_ERROR, `Invalid path: ${error instanceof Error ? error.message : String(error)}`, { context, operation, originalError: error });
     }
     try {
+        // --- Stage specific files if requested ---
+        if (input.filesToStage && input.filesToStage.length > 0) {
+            logger.debug(`Attempting to stage specific files: ${input.filesToStage.join(', ')}`, { ...context, operation });
+            try {
+                // Correctly pass targetPath as rootDir in options object
+                const sanitizedFiles = input.filesToStage.map(file => sanitization.sanitizePath(file, { rootDir: targetPath })); // Sanitize relative to repo root
+                const filesToAddString = sanitizedFiles.map(file => `"${file}"`).join(' '); // Quote paths for safety
+                const addCommand = `git -C "${targetPath}" add -- ${filesToAddString}`;
+                logger.debug(`Executing git add command: ${addCommand}`, { ...context, operation });
+                await execAsync(addCommand);
+                logger.info(`Successfully staged specified files: ${sanitizedFiles.join(', ')}`, { ...context, operation });
+            }
+            catch (addError) {
+                logger.error('Failed to stage specified files', { ...context, operation, files: input.filesToStage, error: addError.message, stderr: addError.stderr });
+                throw new McpError(BaseErrorCode.INTERNAL_ERROR, `Failed to stage files before commit: ${addError.stderr || addError.message}`, { context, operation, originalError: addError });
+            }
+        }
+        // --- End staging files ---
         // Escape message for shell safety
         const escapeShellArg = (arg) => {
             // Escape backslashes first, then other special chars
@@ -177,11 +196,28 @@ export async function commitGitChanges(input, context // Add getter to context
         const finalStatusMsg = commitResult?.statusMessage || (commitHash
             ? `Commit successful: ${commitHash}`
             : `Commit successful (stdout: ${stdout.trim()})`);
-        logger.info(`${operation} executed successfully`, { ...context, operation, path: targetPath, commitHash, signed: !commitResult }); // Log if it was signed (not fallback)
+        let committedFiles = [];
+        if (commitHash) {
+            try {
+                // Get the list of files included in this specific commit
+                const showCommand = `git -C "${targetPath}" show --pretty="" --name-only ${commitHash}`;
+                logger.debug(`Executing git show command: ${showCommand}`, { ...context, operation });
+                const { stdout: showStdout } = await execAsync(showCommand);
+                committedFiles = showStdout.trim().split('\n').filter(Boolean); // Split by newline, remove empty lines
+                logger.debug(`Retrieved committed files list for ${commitHash}`, { ...context, operation, count: committedFiles.length });
+            }
+            catch (showError) {
+                // Log a warning but don't fail the overall operation if we can't get the file list
+                logger.warning('Failed to retrieve committed files list', { ...context, operation, commitHash, error: showError.message, stderr: showError.stderr });
+            }
+        }
+        logger.info(`${operation} executed successfully`, { ...context, operation, path: targetPath, commitHash, signed: !commitResult, committedFilesCount: committedFiles.length }); // Log if it was signed (not fallback)
         return {
             success: true,
             statusMessage: finalStatusMsg, // Use potentially modified message
-            commitHash: commitHash
+            commitHash: commitHash,
+            commitMessage: input.message, // Include the original commit message
+            committedFiles: committedFiles // Include the list of files
         };
     }
     catch (error) { // This catch block now primarily handles non-signing errors or errors from the fallback attempt

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

@@ -41,12 +41,9 @@ feat(auth): implement password reset endpoint
 Closes #123 (if applicable).
 \`\`\`
 
-**Best Practice:** Commit related changes together in logical units. If you've modified multiple files for a single feature or fix, stage and commit them together with a message that describes the overall change.
-
-**Path Handling:** If the 'path' parameter is omitted or set to '.', the tool uses the working directory set by 'git_set_working_dir'. Providing a full, absolute path overrides this default and ensures explicitness.
-
-**Commit Signing:** If the server is configured with the \`GIT_SIGN_COMMITS=true\` environment variable, this tool adds the \`-S\` flag to the \`git commit\` command, requesting a signature. Signing requires proper GPG or SSH key setup and Git configuration on the server machine.
-- **Fallback:** If signing is enabled but fails (e.g., key not found, agent issue), the commit will **fail by default**. However, if the optional \`forceUnsignedOnFailure: true\` parameter is provided in the tool call, the tool will attempt the commit again *without* the \`-S\` flag, resulting in an unsigned commit.`;
+**Tool Options & Behavior:**
+- Commit related changes logically. Use the optional \`filesToStage\` parameter to auto-stage specific files before committing.
+- The \`path\` defaults to the session's working directory unless overridden. If \`GIT_SIGN_COMMITS=true\` is set, commits are signed (\`-S\`), with an optional \`forceUnsignedOnFailure\` fallback.`;
 /**
 * Registers the git_commit tool with the MCP server.
 * Uses the high-level server.tool() method for registration, schema validation, and routing.

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

@@ -120,11 +120,12 @@ export async function logGitHistory(input, context) {
                 logger.warning(`Git log stderr: ${stderr.trim()}`, { ...context, operation });
             }
         }
-        // If raw output was requested, return it directly
+        // 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 { success: true, commits: [], message: message };
+            // Return without the 'commits' field
+            return { success: true, message: message };
         }
         // Otherwise, parse the structured output
         const commits = [];

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

@@ -20,7 +20,7 @@ export function initializeGitLogStateAccessors(getWdFn, getSidFn) {
     logger.info('State accessors initialized for git_log tool registration.');
 }
 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 list of commit objects by default. Can optionally show signature verification status (`showSignature: true`), which returns raw text output instead of JSON.";
+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.";
 /**
  * Registers the git_log tool with the MCP server.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cyanheads/git-mcp-server",
-  "version": "2.0.4",
+  "version": "2.0.7",
   "description": "An MCP (Model Context Protocol) server providing tools to interact with Git repositories. Enables LLMs and AI agents to perform Git operations like clone, commit, push, pull, branch, diff, log, status, and more via the MCP standard.",
   "type": "module",
   "license": "Apache-2.0",
@@ -38,8 +38,8 @@
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.11.0",
     "@types/jsonwebtoken": "^9.0.9",
-    "@types/node": "^22.15.4",
-    "@types/sanitize-html": "^2.15.0",
+    "@types/node": "^22.15.9",
+    "@types/sanitize-html": "^2.16.0",
     "@types/validator": "^13.15.0",
     "chrono-node": "^2.8.0",
     "dotenv": "^16.5.0",