Merge branch 'main' into docs/add-mkdocs-and-align-philosophy

Author: jonmatum

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [4.4.1](https://github.com/jonmatum/git-metrics-mcp-server/compare/v4.4.0...v4.4.1) (2025-11-26)
+
+
+### Bug Fixes
+
+* lower coverage thresholds for CI environment compatibility ([25484ea](https://github.com/jonmatum/git-metrics-mcp-server/commit/25484eac652c1f29090a7d7a9374386b681d1f99))
+
+## [4.4.0](https://github.com/jonmatum/git-metrics-mcp-server/compare/v4.3.1...v4.4.0) (2025-11-26)
+
+
+### Features
+
+* add production-ready features and 80%+ test coverage ([21d64e2](https://github.com/jonmatum/git-metrics-mcp-server/commit/21d64e2a136641899088f768a801809e782cbd3e))
+
 ## [4.3.1](https://github.com/jonmatum/git-metrics-mcp-server/compare/v4.3.0...v4.3.1) (2025-11-26)
 
 

CONTRIBUTING.md

@@ -0,0 +1,88 @@
+# Contributing to Git Metrics MCP Server
+
+## Development Setup
+
+1. **Clone and install**
+   ```bash
+   git clone https://github.com/jonmatum/git-metrics-mcp-server.git
+   cd git-metrics-mcp-server
+   npm install
+   ```
+
+2. **Build the project**
+   ```bash
+   npm run build
+   ```
+
+3. **Run in development mode**
+   ```bash
+   npm run dev
+   ```
+
+## Running Tests
+
+```bash
+# Run all tests
+npm test
+
+# Run tests in watch mode
+npm run test:watch
+
+# Run tests with coverage
+npm run test:coverage
+```
+
+Coverage thresholds are enforced at 80% for lines/functions/statements and 75% for branches.
+
+## Making Changes
+
+1. **Create a feature branch**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **Make your changes**
+   - Write tests for new functionality
+   - Ensure all tests pass: `npm test`
+   - Follow existing code style (TypeScript strict mode)
+   - Add structured logging for important operations
+
+3. **Commit your changes**
+   - Use conventional commits format:
+     - `feat:` for new features
+     - `fix:` for bug fixes
+     - `docs:` for documentation
+     - `test:` for test changes
+     - `refactor:` for code refactoring
+   
+   Example: `feat: add new metric for code complexity`
+
+4. **Push and create PR**
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+   - Open a Pull Request on GitHub
+   - Describe your changes clearly
+   - Link any related issues
+
+## Code Guidelines
+
+- Use TypeScript with strict mode
+- Validate all user inputs
+- Sanitize inputs to prevent command injection
+- Add error handling with descriptive messages
+- Use structured JSON logging: `log('INFO', 'message', { metadata })`
+- Write tests for new features and bug fixes
+
+## Project Structure
+
+```
+src/
+├── git-metrics.ts    # Main server and core functions
+├── handlers.ts       # Tool implementation handlers
+└── *.test.ts        # Test files
+```
+
+## Questions?
+
+Open an issue on GitHub or reach out to the maintainers.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@jonmatum/git-metrics-mcp-server",
-  "version": "4.3.1",
+  "version": "4.4.1",
   "description": "MCP server for analyzing git repository metrics and understanding team health",
   "main": "./build/git-metrics.js",
   "type": "module",

package.json

@@ -0,0 +1,92 @@
+import { describe, it, expect, beforeAll, afterAll } from 'vitest';
+import { runGitCommand, sanitizeInput, validateDate, validateRepoPath } from './git-metrics.js';
+import { execSync } from 'child_process';
+import { mkdirSync, writeFileSync, rmSync } from 'fs';
+import { resolve } from 'path';
+
+const TEST_REPO = resolve(process.cwd(), 'test-repo-core');
+
+beforeAll(() => {
+  rmSync(TEST_REPO, { recursive: true, force: true });
+  mkdirSync(TEST_REPO, { recursive: true });
+  execSync('git init', { cwd: TEST_REPO });
+  execSync('git config user.email "test@example.com"', { cwd: TEST_REPO });
+  execSync('git config user.name "Test User"', { cwd: TEST_REPO });
+  writeFileSync(resolve(TEST_REPO, 'test.txt'), 'test');
+  execSync('git add .', { cwd: TEST_REPO });
+  execSync('git commit -m "test"', { cwd: TEST_REPO });
+});
+
+afterAll(() => {
+  rmSync(TEST_REPO, { recursive: true, force: true });
+});
+
+describe('Core Functions', () => {
+  describe('runGitCommand', () => {
+    it('should execute git commands', () => {
+      const result = runGitCommand(TEST_REPO, 'git log --oneline');
+      expect(result).toContain('test');
+    });
+
+    it('should throw on non-existent repo', () => {
+      expect(() => runGitCommand('/nonexistent', 'git log')).toThrow('does not exist');
+    });
+  });
+
+  describe('sanitizeInput', () => {
+    it('should remove dangerous characters', () => {
+      expect(sanitizeInput('test;rm -rf')).toBe('testrm -rf');
+      expect(sanitizeInput('test&whoami')).toBe('testwhoami');
+      expect(sanitizeInput('test|cat')).toBe('testcat');
+      expect(sanitizeInput('test`ls`')).toBe('testls');
+      expect(sanitizeInput('test$HOME')).toBe('testHOME');
+      expect(sanitizeInput('test()')).toBe('test');
+    });
+
+    it('should keep safe characters', () => {
+      expect(sanitizeInput('test-file_123.txt')).toBe('test-file_123.txt');
+    });
+  });
+
+  describe('validateDate', () => {
+    it('should accept valid dates', () => {
+      expect(() => validateDate('2025-11-26', 'test')).not.toThrow();
+      expect(() => validateDate('2020-01-01', 'test')).not.toThrow();
+    });
+
+    it('should reject invalid formats', () => {
+      expect(() => validateDate('2025/11/26', 'test')).toThrow('Invalid test format');
+      expect(() => validateDate('11-26-2025', 'test')).toThrow('Invalid test format');
+      expect(() => validateDate('invalid', 'test')).toThrow('Invalid test format');
+    });
+  });
+
+  describe('validateRepoPath', () => {
+    it('should accept valid repo paths', () => {
+      expect(() => validateRepoPath(TEST_REPO)).not.toThrow();
+    });
+
+    it('should reject empty paths', () => {
+      expect(() => validateRepoPath('')).toThrow('repo_path is required');
+    });
+
+    it('should reject non-string paths', () => {
+      expect(() => validateRepoPath(null as any)).toThrow('repo_path is required');
+    });
+
+    it('should reject paths with dangerous characters', () => {
+      expect(() => validateRepoPath('test;rm')).toThrow('Invalid characters');
+    });
+
+    it('should reject non-existent paths', () => {
+      expect(() => validateRepoPath('/nonexistent')).toThrow('does not exist');
+    });
+
+    it('should reject non-git directories', () => {
+      const nonGitDir = resolve(process.cwd(), 'test-non-git');
+      mkdirSync(nonGitDir, { recursive: true });
+      expect(() => validateRepoPath(nonGitDir)).toThrow('Not a git repository');
+      rmSync(nonGitDir, { recursive: true, force: true });
+    });
+  });
+});

src/core-functions.test.ts

@@ -84,6 +84,14 @@ export function validateRepoPath(repoPath: string): void {
 
 server.setRequestHandler(ListToolsRequestSchema, async () => ({
   tools: [
+    {
+      name: "health_check",
+      description: "Verify server is operational",
+      inputSchema: {
+        type: "object",
+        properties: {},
+      },
+    },
     {
       name: "get_commit_stats",
       description: "Get commit statistics for a repository",
@@ -242,7 +250,9 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
     const args = request.params.arguments as any;
     let result: any;
 
-    if (request.params.name === "get_commit_stats") {
+    if (request.params.name === "health_check") {
+      result = { status: "ok", version: VERSION, timestamp: new Date().toISOString() };
+    } else if (request.params.name === "get_commit_stats") {
       result = handlers.handleGetCommitStats(args);
     } else if (request.params.name === "get_author_metrics") {
       result = handlers.handleGetAuthorMetrics(args);
@@ -297,6 +307,19 @@ async function main() {
     timeout: GIT_TIMEOUT,
     maxBuffer: MAX_BUFFER
   });
+
+  // Graceful shutdown
+  process.on('SIGTERM', async () => {
+    log('INFO', 'Shutting down gracefully');
+    await server.close();
+    process.exit(0);
+  });
+
+  process.on('SIGINT', async () => {
+    log('INFO', 'Shutting down gracefully');
+    await server.close();
+    process.exit(0);
+  });
 }
 
 main().catch((error) => {