@andrebuzeli/git-mcp 5.5.0 → 5.5.2

package/README.md

@@ -44,6 +44,13 @@ export GITEA_TOKEN="your_gitea_token"
 export GITEA_USERNAME="your_username"
 ```
 
+PowerShell (Windows) example - session only:
+```powershell
+$env:GITEA_URL = 'https://your-gitea-instance.com'
+$env:GITEA_TOKEN = 'your_gitea_token'
+$env:GITEA_USERNAME = 'your_username'
+```
+
 #### Multi-Provider Support
 Configure both GitHub and Gitea to use `provider="both"` in tool calls.
 
@@ -277,6 +284,24 @@ The server automatically validates credentials on startup:
    npx @andrebuzeli/git-mcp@latest
    ```
 
+Optional: use a local `mcp.json` (NOT committed) to keep credentials for local testing.
+
+1. Create `mcp.json` next to package.json with this shape (use the `.example` as a starting point):
+
+```json
+{
+  "env": {
+    "GITEA_URL": "http://nas-ubuntu:3000",
+    "GITEA_TOKEN": "<GITEA_TOKEN>",
+    "GITEA_USERNAME": "<GITEA_USERNAME>",
+    "GITHUB_TOKEN": "<GITHUB_TOKEN>",
+    "GITHUB_USERNAME": "<GITHUB_USERNAME>"
+  }
+}
+```
+
+Security note: do NOT commit `mcp.json` with real tokens. The repository's `.gitignore` includes `mcp.json` to help avoid leaks.
+
 ## Troubleshooting
 
 ### Common Issues

package/dist/config.d.ts

@@ -1,131 +1,5 @@
-/**
- * Configuration Management
- *
- * Handles environment variable configuration for GitHub and Gitea providers.
- * Provides validation and auto-detection utilities.
- */
-export type GitMCPMode = 'normal' | 'universal';
-export interface GitMCPConfig {
-    mode: GitMCPMode;
-    github?: {
-        token: string;
-        username: string;
-    };
-    gitea?: {
-        url: string;
-        token: string;
-        username: string;
-    };
-}
-export interface ProjectContext {
-    projectPath: string;
-    repositoryName: string;
-    isGitRepository: boolean;
-    remoteOrigin?: string;
-    currentBranch?: string;
-    detectedProvider?: string;
-}
-export interface ConfigValidationResult {
-    isValid: boolean;
-    errors: string[];
-    warnings: string[];
-    missingEnvVars: string[];
-    configurationGuide?: {
-        requiredEnvVars: string[];
-        exampleConfig: Record<string, string>;
-    };
-}
-export interface DetailedValidationResult {
-    isValid: boolean;
-    providerResults: {
-        github?: ProviderValidationResult;
-        gitea?: ProviderValidationResult;
-    };
-    summary: {
-        totalProviders: number;
-        validProviders: number;
-        errors: string[];
-        warnings: string[];
-    };
-}
-export interface ProviderValidationResult {
-    provider: 'github' | 'gitea';
-    isValid: boolean;
-    isConfigured: boolean;
-    credentialStatus: 'valid' | 'invalid' | 'missing' | 'network_error';
-    errorDetails?: string;
-    userInfo?: {
-        username: string;
-        displayName?: string;
-        email?: string;
-    };
-    permissions?: string[];
-    rateLimit?: {
-        limit: number;
-        remaining: number;
-        reset: Date;
-    };
-}
-export declare class ConfigManager {
-    private config;
-    constructor();
-    private loadConfiguration;
-    getConfig(): GitMCPConfig;
-    isGitHubConfigured(): boolean;
-    isGiteaConfigured(): boolean;
-    getConfigurationStatus(): Record<string, string>;
-    /**
-     * Gets the current operation mode
-     */
-    getMode(): GitMCPMode;
-    /**
-     * Checks if universal mode is enabled
-     */
-    isUniversalMode(): boolean;
-    /**
-     * Validates GitHub and Gitea credentials
-     */
-    validateCredentials(): ConfigValidationResult;
-    /**
-     * Auto-detects project context from projectPath
-     */
-    detectProjectContext(projectPath: string): ProjectContext;
-    /**
-     * Auto-detects username/owner from environment variables
-     */
-    autoDetectUsername(provider: 'github' | 'gitea'): string | undefined;
-    /**
-     * Gets provider configuration for a specific provider
-     */
-    getProviderConfig(provider: 'github' | 'gitea'): {
-        token: string;
-        username: string;
-    } | undefined;
-    /**
-     * Checks if a provider is supported for operations
-     */
-    isProviderSupported(provider: 'github' | 'gitea' | 'both'): boolean;
-    /**
-     * Validates credentials with detailed testing of API connectivity
-     */
-    validateCredentialsDetailed(): Promise<DetailedValidationResult>;
-    /**
-     * Validates GitHub credentials with API test
-     */
-    private validateGitHubCredentials;
-    /**
-     * Validates Gitea credentials with API test
-     */
-    private validateGiteaCredentials;
-    /**
-     * Gets configuration guidance for missing setup
-     */
-    getConfigurationGuidance(): {
-        requiredEnvVars: string[];
-        exampleConfig: Record<string, string>;
-        setupInstructions: string[];
-    };
-}
-export declare const configManager: ConfigManager;
-export declare function getProviderConfig(): GitMCPConfig;
-//# sourceMappingURL=config.d.ts.map
+export type MCPConfig = {
+    env?: Record<string, string>;
+    [k: string]: any;
+};
+export declare function loadMCPConfig(configPath?: string): MCPConfig | null;

package/dist/config.js

@@ -1,441 +1,39 @@
 "use strict";
-/**
- * Configuration Management
- *
- * Handles environment variable configuration for GitHub and Gitea providers.
- * Provides validation and auto-detection utilities.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.configManager = exports.ConfigManager = void 0;
-exports.getProviderConfig = getProviderConfig;
-const path = __importStar(require("path"));
-const fs = __importStar(require("fs"));
-const rest_1 = require("@octokit/rest");
-const axios_1 = __importDefault(require("axios"));
-class ConfigManager {
-    config;
-    constructor() {
-        this.config = this.loadConfiguration();
-    }
-    loadConfiguration() {
-        const config = {
-            mode: process.env.GIT_MCP_MODE || 'normal'
-        };
-        // GitHub configuration
-        if (process.env.GITHUB_TOKEN && process.env.GITHUB_USERNAME) {
-            config.github = {
-                token: process.env.GITHUB_TOKEN,
-                username: process.env.GITHUB_USERNAME,
-            };
-        }
-        // Gitea configuration
-        if (process.env.GITEA_URL && process.env.GITEA_TOKEN && process.env.GITEA_USERNAME) {
-            config.gitea = {
-                url: process.env.GITEA_URL,
-                token: process.env.GITEA_TOKEN,
-                username: process.env.GITEA_USERNAME,
-            };
-        }
-        return config;
-    }
-    getConfig() {
-        return this.config;
-    }
-    isGitHubConfigured() {
-        return !!this.config.github;
-    }
-    isGiteaConfigured() {
-        return !!this.config.gitea;
-    }
-    getConfigurationStatus() {
-        return {
-            github: this.isGitHubConfigured() ? 'configured' : 'not configured',
-            gitea: this.isGiteaConfigured() ? 'configured' : 'not configured',
-        };
-    }
-    /**
-     * Gets the current operation mode
-     */
-    getMode() {
-        return this.config.mode;
-    }
-    /**
-     * Checks if universal mode is enabled
-     */
-    isUniversalMode() {
-        return this.config.mode === 'universal';
-    }
-    /**
-     * Validates GitHub and Gitea credentials
-     */
-    validateCredentials() {
-        const result = {
-            isValid: true,
-            errors: [],
-            warnings: [],
-            missingEnvVars: [],
-        };
-        // Check GitHub configuration
-        if (process.env.GITHUB_TOKEN && !process.env.GITHUB_USERNAME) {
-            result.errors.push('GITHUB_TOKEN is set but GITHUB_USERNAME is missing');
-            result.missingEnvVars.push('GITHUB_USERNAME');
-            result.isValid = false;
-        }
-        if (process.env.GITHUB_USERNAME && !process.env.GITHUB_TOKEN) {
-            result.errors.push('GITHUB_USERNAME is set but GITHUB_TOKEN is missing');
-            result.missingEnvVars.push('GITHUB_TOKEN');
-            result.isValid = false;
-        }
-        // Check Gitea configuration
-        const giteaVars = ['GITEA_URL', 'GITEA_TOKEN', 'GITEA_USERNAME'];
-        const setGiteaVars = giteaVars.filter(varName => !!process.env[varName]);
-        if (setGiteaVars.length > 0 && setGiteaVars.length < 3) {
-            const missingGiteaVars = giteaVars.filter(varName => !process.env[varName]);
-            result.errors.push(`Partial Gitea configuration detected. Missing: ${missingGiteaVars.join(', ')}`);
-            result.missingEnvVars.push(...missingGiteaVars);
-            result.isValid = false;
-        }
-        // Validate Gitea URL format
-        if (process.env.GITEA_URL) {
-            try {
-                new URL(process.env.GITEA_URL);
-            }
-            catch (error) {
-                result.errors.push('GITEA_URL is not a valid URL format');
-                result.isValid = false;
-            }
-        }
-        // Check if at least one provider is configured
-        if (!this.isGitHubConfigured() && !this.isGiteaConfigured()) {
-            result.warnings.push('No providers are configured. At least one provider (GitHub or Gitea) should be configured for remote operations.');
-            result.configurationGuide = {
-                requiredEnvVars: ['GITHUB_TOKEN', 'GITHUB_USERNAME', 'GITEA_URL', 'GITEA_TOKEN', 'GITEA_USERNAME'],
-                exampleConfig: {
-                    'GITHUB_TOKEN': 'ghp_xxxxxxxxxxxxxxxxxxxx',
-                    'GITHUB_USERNAME': 'your-github-username',
-                    'GITEA_URL': 'https://gitea.example.com',
-                    'GITEA_TOKEN': 'your-gitea-token',
-                    'GITEA_USERNAME': 'your-gitea-username'
-                }
-            };
-        }
-        // Validate universal mode requirements
-        if (this.config.mode === 'universal') {
-            if (!this.isGitHubConfigured() || !this.isGiteaConfigured()) {
-                result.errors.push('Universal mode requires both GitHub and Gitea to be configured');
-                result.isValid = false;
-                result.missingEnvVars.push(...(!this.isGitHubConfigured() ? ['GITHUB_TOKEN', 'GITHUB_USERNAME'] : []));
-                result.missingEnvVars.push(...(!this.isGiteaConfigured() ? ['GITEA_URL', 'GITEA_TOKEN', 'GITEA_USERNAME'] : []));
-            }
-        }
-        return result;
-    }
-    /**
-     * Auto-detects project context from projectPath
-     */
-    detectProjectContext(projectPath) {
-        const context = {
-            projectPath,
-            repositoryName: path.basename(projectPath),
-            isGitRepository: false,
-        };
-        try {
-            // Check if it's a Git repository
-            const gitDir = path.join(projectPath, '.git');
-            context.isGitRepository = fs.existsSync(gitDir);
-            if (context.isGitRepository) {
-                // Try to detect remote origin
-                const gitConfigPath = path.join(gitDir, 'config');
-                if (fs.existsSync(gitConfigPath)) {
-                    const gitConfig = fs.readFileSync(gitConfigPath, 'utf8');
-                    const remoteMatch = gitConfig.match(/\[remote "origin"\][\s\S]*?url = (.+)/);
-                    if (remoteMatch) {
-                        context.remoteOrigin = remoteMatch[1].trim();
-                        // Detect provider from remote URL
-                        if (context.remoteOrigin.includes('github.com')) {
-                            context.detectedProvider = 'github';
-                        }
-                        else if (context.remoteOrigin.includes('gitea') ||
-                            (this.config.gitea && context.remoteOrigin.includes(new URL(this.config.gitea.url).hostname))) {
-                            context.detectedProvider = 'gitea';
-                        }
-                    }
-                }
-                // Try to detect current branch
-                const headPath = path.join(gitDir, 'HEAD');
-                if (fs.existsSync(headPath)) {
-                    const headContent = fs.readFileSync(headPath, 'utf8').trim();
-                    const branchMatch = headContent.match(/ref: refs\/heads\/(.+)/);
-                    if (branchMatch) {
-                        context.currentBranch = branchMatch[1];
-                    }
+exports.loadMCPConfig = loadMCPConfig;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+function maskSecret(value) {
+    if (!value)
+        return 'undefined';
+    if (value.length <= 8)
+        return '****';
+    return `${value.slice(0, 4)}...${value.slice(-4)}`;
+}
+function loadMCPConfig(configPath) {
+    const cfgPath = path_1.default.resolve(process.cwd(), configPath ?? 'mcp.json');
+    if (!fs_1.default.existsSync(cfgPath))
+        return null;
+    try {
+        const raw = fs_1.default.readFileSync(cfgPath, 'utf8');
+        const cfg = JSON.parse(raw);
+        if (cfg.env) {
+            for (const [k, v] of Object.entries(cfg.env)) {
+                // Only set if not already present in process.env
+                if (process.env[k] == null) {
+                    process.env[k] = v;
                 }
+                // Log presence (masked) but never print raw tokens
+                console.log(`MCP config: env.${k}=${maskSecret(process.env[k])}`);
             }
         }
-        catch (error) {
-            // Silently handle errors in detection
-        }
-        return context;
-    }
-    /**
-     * Auto-detects username/owner from environment variables
-     */
-    autoDetectUsername(provider) {
-        if (provider === 'github' && this.config.github) {
-            return this.config.github.username;
-        }
-        if (provider === 'gitea' && this.config.gitea) {
-            return this.config.gitea.username;
-        }
-        return undefined;
-    }
-    /**
-     * Gets provider configuration for a specific provider
-     */
-    getProviderConfig(provider) {
-        return provider === 'github' ? this.config.github : this.config.gitea;
-    }
-    /**
-     * Checks if a provider is supported for operations
-     */
-    isProviderSupported(provider) {
-        if (provider === 'both') {
-            return this.isGitHubConfigured() && this.isGiteaConfigured();
-        }
-        return provider === 'github' ? this.isGitHubConfigured() : this.isGiteaConfigured();
-    }
-    /**
-     * Validates credentials with detailed testing of API connectivity
-     */
-    async validateCredentialsDetailed() {
-        const result = {
-            isValid: false,
-            providerResults: {},
-            summary: {
-                totalProviders: 0,
-                validProviders: 0,
-                errors: [],
-                warnings: []
-            }
-        };
-        // Validate GitHub credentials
-        if (this.isGitHubConfigured()) {
-            result.summary.totalProviders++;
-            result.providerResults.github = await this.validateGitHubCredentials();
-            if (result.providerResults.github.isValid) {
-                result.summary.validProviders++;
-            }
-            else {
-                result.summary.errors.push(`GitHub: ${result.providerResults.github.errorDetails || 'Validation failed'}`);
-            }
-        }
-        // Validate Gitea credentials
-        if (this.isGiteaConfigured()) {
-            result.summary.totalProviders++;
-            result.providerResults.gitea = await this.validateGiteaCredentials();
-            if (result.providerResults.gitea.isValid) {
-                result.summary.validProviders++;
-            }
-            else {
-                result.summary.errors.push(`Gitea: ${result.providerResults.gitea.errorDetails || 'Validation failed'}`);
-            }
-        }
-        result.isValid = result.summary.validProviders > 0;
-        // Add warnings for partial configuration
-        if (result.summary.totalProviders > 0 && result.summary.validProviders < result.summary.totalProviders) {
-            result.summary.warnings.push('Some providers failed validation. Check credentials and network connectivity.');
-        }
-        if (result.summary.totalProviders === 0) {
-            result.summary.errors.push('No providers are configured. Set up GitHub or Gitea credentials.');
-        }
-        // Add warning for universal mode with partial configuration
-        if (this.config.mode === 'universal' && result.summary.totalProviders === 1) {
-            result.summary.warnings.push('Universal mode is enabled but only one provider is configured. Both GitHub and Gitea are required for universal mode.');
-        }
-        return result;
+        return cfg;
     }
-    /**
-     * Validates GitHub credentials with API test
-     */
-    async validateGitHubCredentials() {
-        const result = {
-            provider: 'github',
-            isValid: false,
-            isConfigured: true,
-            credentialStatus: 'invalid'
-        };
-        if (!this.config.github?.token) {
-            result.credentialStatus = 'missing';
-            result.errorDetails = 'GitHub token is not configured';
-            return result;
-        }
-        try {
-            const octokit = new rest_1.Octokit({
-                auth: this.config.github.token
-            });
-            // Test authentication by getting user info
-            const userResponse = await octokit.rest.users.getAuthenticated();
-            result.isValid = true;
-            result.credentialStatus = 'valid';
-            result.userInfo = {
-                username: userResponse.data.login,
-                displayName: userResponse.data.name || undefined,
-                email: userResponse.data.email || undefined
-            };
-            // Get rate limit info
-            try {
-                const rateLimitResponse = await octokit.rest.rateLimit.get();
-                result.rateLimit = {
-                    limit: rateLimitResponse.data.rate.limit,
-                    remaining: rateLimitResponse.data.rate.remaining,
-                    reset: new Date(rateLimitResponse.data.rate.reset * 1000)
-                };
-            }
-            catch (rateLimitError) {
-                // Rate limit check failed, but auth is still valid
-            }
-        }
-        catch (error) {
-            if (error.status === 401) {
-                result.credentialStatus = 'invalid';
-                result.errorDetails = 'Invalid GitHub token or insufficient permissions';
-            }
-            else if (error.status === 403) {
-                result.credentialStatus = 'invalid';
-                result.errorDetails = 'GitHub token is valid but lacks required permissions';
-            }
-            else if (error.code === 'ENOTFOUND' || error.code === 'ECONNREFUSED') {
-                result.credentialStatus = 'network_error';
-                result.errorDetails = 'Network error: Cannot reach GitHub API';
-            }
-            else {
-                result.credentialStatus = 'invalid';
-                result.errorDetails = `GitHub API error: ${error.message}`;
-            }
-        }
-        return result;
+    catch (err) {
+        console.error('Failed to parse mcp.json:', err.message ?? String(err));
+        return null;
     }
-    /**
-     * Validates Gitea credentials with API test
-     */
-    async validateGiteaCredentials() {
-        const result = {
-            provider: 'gitea',
-            isValid: false,
-            isConfigured: true,
-            credentialStatus: 'invalid'
-        };
-        if (!this.config.gitea?.url || !this.config.gitea?.token) {
-            result.credentialStatus = 'missing';
-            result.errorDetails = 'Gitea URL or token is not configured';
-            return result;
-        }
-        try {
-            // Test authentication by getting user info
-            const response = await axios_1.default.get(`${this.config.gitea.url}/api/v1/user`, {
-                headers: {
-                    'Authorization': `token ${this.config.gitea.token}`,
-                    'Accept': 'application/json'
-                },
-                timeout: 10000
-            });
-            result.isValid = true;
-            result.credentialStatus = 'valid';
-            result.userInfo = {
-                username: response.data.login,
-                displayName: response.data.full_name || undefined,
-                email: response.data.email || undefined
-            };
-        }
-        catch (error) {
-            if (error.response?.status === 401) {
-                result.credentialStatus = 'invalid';
-                result.errorDetails = 'Invalid Gitea token';
-            }
-            else if (error.response?.status === 403) {
-                result.credentialStatus = 'invalid';
-                result.errorDetails = 'Gitea token is valid but lacks required permissions';
-            }
-            else if (error.code === 'ENOTFOUND' || error.code === 'ECONNREFUSED') {
-                result.credentialStatus = 'network_error';
-                result.errorDetails = `Network error: Cannot reach Gitea at ${this.config.gitea.url}`;
-            }
-            else if (error.response?.status >= 500) {
-                result.credentialStatus = 'network_error';
-                result.errorDetails = `Gitea server error: ${error.response.status}`;
-            }
-            else {
-                result.credentialStatus = 'invalid';
-                result.errorDetails = `Gitea API error: ${error.message}`;
-            }
-        }
-        return result;
-    }
-    /**
-     * Gets configuration guidance for missing setup
-     */
-    getConfigurationGuidance() {
-        return {
-            requiredEnvVars: [
-                'GITHUB_TOKEN', 'GITHUB_USERNAME',
-                'GITEA_URL', 'GITEA_TOKEN', 'GITEA_USERNAME'
-            ],
-            exampleConfig: {
-                'GITHUB_TOKEN': 'ghp_xxxxxxxxxxxxxxxxxxxx',
-                'GITHUB_USERNAME': 'your-github-username',
-                'GITEA_URL': 'https://gitea.example.com',
-                'GITEA_TOKEN': 'your-gitea-token',
-                'GITEA_USERNAME': 'your-gitea-username'
-            },
-            setupInstructions: [
-                '1. For GitHub: Create a personal access token at https://github.com/settings/tokens',
-                '2. For Gitea: Create an access token in your Gitea instance settings',
-                '3. Set the environment variables before running the MCP server',
-                '4. At least one provider (GitHub or Gitea) must be configured for remote operations'
-            ]
-        };
-    }
-}
-exports.ConfigManager = ConfigManager;
-// Export singleton instance and convenience functions
-exports.configManager = new ConfigManager();
-function getProviderConfig() {
-    return exports.configManager.getConfig();
 }
-//# sourceMappingURL=config.js.map

package/dist/index.d.ts

@@ -1,22 +1,2 @@
 #!/usr/bin/env node
-/**
- * GIT MCP Server - Entry Point
- *
- * Professional MCP server for Git operations with multi-provider support.
- * Supports GitHub and Gitea providers with unified interface.
- *
- * Usage:
- *   - Local development: node dist/index.js
- *   - NPM package: npx @andrebuzeli/git-mcp@latest
- *   - Direct execution: git-mcp (after npm install -g)
- *
- * Environment Variables:
- *   - GITHUB_TOKEN: GitHub personal access token
- *   - GITHUB_USERNAME: GitHub username
- *   - GITEA_URL: Gitea instance URL
- *   - GITEA_TOKEN: Gitea access token
- *   - GITEA_USERNAME: Gitea username
- */
-export { GitMCPServer } from './server.js';
-export { getProviderConfig } from './config.js';
-//# sourceMappingURL=index.d.ts.map
+export {};