@i18n-agent/mcp-client 1.0.1 → 1.0.3

package/CONTRIBUTING.md

@@ -0,0 +1,218 @@
+# Contributing to i18n-agent MCP Client
+
+Thank you for your interest in contributing to the i18n-agent MCP client! We welcome contributions from the community.
+
+## 🚀 Quick Start
+
+1. **Fork the repository** on GitHub
+2. **Clone your fork** locally:
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/mcp-client.git
+   cd mcp-client
+   ```
+3. **Create a feature branch**:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+## 🛠 Development Setup
+
+### Prerequisites
+- Node.js 16+ 
+- npm or yarn
+- Git
+
+### Local Development
+```bash
+# Install dependencies (if any are added)
+npm install
+
+# Run tests
+npm test
+
+# Test the installer locally
+node install.js
+
+# Test MCP client syntax
+node -c mcp-client.js
+```
+
+## 📝 Types of Contributions
+
+### 🐛 Bug Reports
+- Use the [GitHub Issues](https://github.com/i18n-agent/mcp-client/issues) page
+- Include steps to reproduce
+- Mention your OS, IDE, and Node.js version
+- Include error messages and logs
+
+### 💡 Feature Requests  
+- Check existing issues first
+- Describe the use case and expected behavior
+- Consider backward compatibility
+
+### 🔧 Code Contributions
+
+#### Areas for Contribution:
+- **IDE Support**: Add support for new AI IDEs
+- **Installation**: Improve cross-platform compatibility
+- **Error Handling**: Better error messages and recovery
+- **Documentation**: Improve README, add examples
+- **Testing**: Add more test cases
+- **Localization**: Translate installation messages
+
+## 🧪 Testing
+
+Before submitting a PR, ensure:
+
+```bash
+# Run the test suite
+npm test
+
+# Test installation process
+node install.js
+
+# Check for syntax errors
+node -c mcp-client.js
+node -c install.js
+```
+
+### Test Coverage Areas:
+- ✅ Configuration generation
+- ✅ IDE detection
+- ✅ File validation
+- ✅ Package.json validation  
+- ✅ MCP client syntax
+- 🔧 Cross-platform testing needed
+- 🔧 Error condition testing needed
+
+## 📋 Coding Standards
+
+### JavaScript Style
+- Use ES6+ modules (`import`/`export`)
+- Use modern JavaScript features
+- Add JSDoc comments for functions
+- Use descriptive variable names
+
+### Security
+- **Never commit API keys** or secrets
+- Use environment variables for configuration
+- Validate user input
+- Handle errors gracefully
+
+### Example Code Style:
+```javascript
+/**
+ * Detect available AI IDEs on the system
+ * @returns {Promise<Array>} List of available IDEs with config paths
+ */
+async function detectAvailableIDEs() {
+  const available = [];
+  
+  for (const [key, config] of Object.entries(IDE_CONFIGS)) {
+    const configDir = path.dirname(config.configPath);
+    if (fs.existsSync(configDir)) {
+      available.push({ key, ...config });
+    }
+  }
+  
+  return available;
+}
+```
+
+## 🚦 Pull Request Process
+
+1. **Create a feature branch** from `main`
+2. **Make your changes** with clear, focused commits
+3. **Add tests** if applicable
+4. **Update documentation** if needed
+5. **Run tests** and ensure they pass
+6. **Create a Pull Request** with:
+   - Clear title and description
+   - Reference any related issues
+   - Include testing steps
+
+### PR Title Format:
+- `feat: add support for WebStorm IDE`
+- `fix: handle Windows path separators correctly` 
+- `docs: improve installation instructions`
+- `test: add cross-platform installation tests`
+
+## 🌟 Adding IDE Support
+
+To add support for a new AI IDE:
+
+1. **Add IDE config** to `IDE_CONFIGS` in `install.js`:
+   ```javascript
+   newIDE: {
+     name: 'New IDE Name',
+     configPath: path.join(os.homedir(), '.newIDE/mcp_config.json'),
+     displayPath: '~/.newIDE/mcp_config.json'
+   }
+   ```
+
+2. **Add configuration logic** if the IDE uses a different config format
+
+3. **Test on the target platform**
+
+4. **Update README** with IDE support information
+
+## 🐛 Debugging
+
+### Common Issues:
+- **Permission errors**: Check file permissions for config directories
+- **Path issues**: Ensure paths work on Windows/macOS/Linux  
+- **JSON parsing**: Validate config file structure
+- **Node.js version**: Ensure compatibility with Node 16+
+
+### Debug Environment Variables:
+```bash
+# Enable verbose logging (if implemented)
+DEBUG=i18n-agent:* node install.js
+
+# Test with different home directories
+HOME=/tmp/test-home node install.js
+```
+
+## 📚 Documentation
+
+### README Updates
+- Keep installation instructions current
+- Add new IDE support to the table
+- Update feature lists
+- Include troubleshooting for new scenarios
+
+### Code Comments
+- Document complex logic
+- Explain IDE-specific quirks
+- Add TODO comments for future improvements
+
+## 🌍 Internationalization
+
+We welcome contributions to translate the installer messages:
+
+1. **Add language files** in `locales/` directory
+2. **Use i18n library** for message formatting
+3. **Test with different system locales**
+
+## ⚖️ License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.
+
+## 🆘 Getting Help
+
+- **GitHub Issues**: https://github.com/i18n-agent/mcp-client/issues
+- **Discord**: [Join our community](https://discord.gg/i18nagent)
+- **Email**: support@i18nagent.ai
+
+## 🎉 Recognition
+
+Contributors will be:
+- Listed in the README
+- Mentioned in release notes
+- Invited to our contributors Discord channel
+
+Thank you for helping make i18n-agent better for everyone! 🌟
+
+---
+
+Made with ❤️ by the i18n-agent community

package/README.md

@@ -30,7 +30,7 @@ i18n-agent-install
 
 ## 🔑 Setup API Key
 
-1. **Get your API key** from [i18nagent.ai/dashboard](https://i18nagent.ai/dashboard)
+1. **Get your API key** from [app.i18nagent.ai](https://app.i18nagent.ai)
 
 2. **Set environment variable**:
    ```bash
@@ -77,36 +77,45 @@ List supported languages with quality ratings
 
 ## 🌐 Language Support
 
-### Tier 1 - Production Ready (80-90% Quality)
+### Tier 1 - Excellent Quality
 - **en**: English
-- **es**: Spanish  
 - **fr**: French
 - **de**: German
+- **es**: Spanish
 - **it**: Italian
 - **pt**: Portuguese
-- **nl**: Dutch
-
-### Tier 2 - Production Viable (50-75% Quality)
 - **ru**: Russian
-- **zh-CN**: Chinese (Simplified)
 - **ja**: Japanese
 - **ko**: Korean
+- **zh-CN**: Chinese (Simplified)
+
+### Tier 2 - High Quality
+- **nl**: Dutch
+- **pl**: Polish
+- **cs**: Czech
 - **ar**: Arabic
 - **he**: Hebrew
 - **hi**: Hindi
-- **pl**: Polish
-- **cs**: Czech
-
-### Tier 3 - Basic Support (20-50% Quality)
 - **zh-TW**: Chinese (Traditional)
-- **th**: Thai
-- **vi**: Vietnamese
 - **sv**: Swedish
 - **da**: Danish
 - **no**: Norwegian
 - **fi**: Finnish
+
+### Tier 3 - Good Quality
 - **tr**: Turkish
 - **hu**: Hungarian
+- **th**: Thai
+- **vi**: Vietnamese
+- **uk**: Ukrainian
+- **bg**: Bulgarian
+- **ro**: Romanian
+- **hr**: Croatian
+- **sk**: Slovak
+- **sl**: Slovenian
+- **et**: Estonian
+- **lv**: Latvian
+- **lt**: Lithuanian
 
 ## 📁 Supported File Formats
 
@@ -243,12 +252,12 @@ npm test
 
 MIT License - see [LICENSE](LICENSE) file for details.
 
-Copyright (c) 2024 FatCouple OÜ
+Copyright (c) 2025 FatCouple OÜ
 
 ## 🔗 Links
 
 - **Website**: [i18nagent.ai](https://i18nagent.ai)
-- **Dashboard**: [i18nagent.ai/dashboard](https://i18nagent.ai/dashboard)
+- **Dashboard**: [app.i18nagent.ai](https://app.i18nagent.ai)
 - **Documentation**: [docs.i18nagent.ai](https://docs.i18nagent.ai)
 - **GitHub**: [github.com/i18n-agent/mcp-client](https://github.com/i18n-agent/mcp-client)
 - **Issues**: [github.com/i18n-agent/mcp-client/issues](https://github.com/i18n-agent/mcp-client/issues)
@@ -261,4 +270,4 @@ Copyright (c) 2024 FatCouple OÜ
 
 ---
 
-Made with ❤️ by [FatCouple OÜ](https://fatcouple.com)
+Made with ❤️ by [FatCouple OÜ](https://fireinbelly.com)

package/install.js

@@ -179,7 +179,7 @@ For manual setup instructions, visit: https://docs.i18nagent.ai/setup
 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 You need to set your API key to use the translation service:
 
-1. Get your API key from: https://i18nagent.ai/dashboard
+1. Get your API key from: https://app.i18nagent.ai
 2. Set it as an environment variable:
 
    export API_KEY=your-api-key-here

package/mcp-client.js

@@ -36,7 +36,7 @@ const API_KEY = process.env.API_KEY;
 // Validate required environment variables
 if (!API_KEY) {
   console.error('❌ Error: API_KEY environment variable is required');
-  console.error('💡 Get your API key from: https://i18nagent.ai/dashboard');
+  console.error('💡 Get your API key from: https://app.i18nagent.ai');
   console.error('💡 Set it with: export API_KEY=your-api-key-here');
   process.exit(1);
 }
@@ -273,38 +273,47 @@ async function handleTranslateText(args) {
 async function handleListLanguages(args) {
   const { includeQuality = true } = args;
   
-  // Language support matrix based on GPT-OSS analysis
+  // Language support matrix based on translation quality
   const languages = {
-    'Tier 1 - Production Ready (Excellent Quality 80-90%)': {
+    'Tier 1 - Excellent Quality': {
       'en': 'English',
-      'es': 'Spanish', 
       'fr': 'French',
       'de': 'German',
+      'es': 'Spanish',
       'it': 'Italian',
       'pt': 'Portuguese',
-      'nl': 'Dutch',
-    },
-    'Tier 2 - Production Viable (Good Quality 50-75%)': {
       'ru': 'Russian',
-      'zh-CN': 'Chinese (Simplified)',
       'ja': 'Japanese',
       'ko': 'Korean',
+      'zh-CN': 'Chinese (Simplified)',
+    },
+    'Tier 2 - High Quality': {
+      'nl': 'Dutch',
+      'pl': 'Polish',
+      'cs': 'Czech',
       'ar': 'Arabic',
       'he': 'Hebrew',
       'hi': 'Hindi',
-      'pl': 'Polish',
-      'cs': 'Czech',
-    },
-    'Tier 3 - Basic Support (Use with Caution 20-50%)': {
       'zh-TW': 'Chinese (Traditional)',
-      'th': 'Thai',
-      'vi': 'Vietnamese',
       'sv': 'Swedish',
       'da': 'Danish',
       'no': 'Norwegian',
       'fi': 'Finnish',
+    },
+    'Tier 3 - Good Quality': {
       'tr': 'Turkish',
       'hu': 'Hungarian',
+      'th': 'Thai',
+      'vi': 'Vietnamese',
+      'uk': 'Ukrainian',
+      'bg': 'Bulgarian',
+      'ro': 'Romanian',
+      'hr': 'Croatian',
+      'sk': 'Slovak',
+      'sl': 'Slovenian',
+      'et': 'Estonian',
+      'lv': 'Latvian',
+      'lt': 'Lithuanian',
     },
   };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@i18n-agent/mcp-client",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "MCP client for i18n-agent translation service - supports Claude, Cursor, VS Code, and other AI IDEs",
   "main": "mcp-client.js",
   "bin": {
@@ -44,7 +44,8 @@
     "mcp-client.js",
     "install.js",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "CONTRIBUTING.md"
   ],
   "publishConfig": {
     "access": "public"