mcp-prompt-optimizer 3.1.1 โ†’ 3.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [3.1.3] - 2026-04-13
9
+
10
+ ### Changed
11
+ - ๐Ÿ“ฆ **Version Bump**: Incremented version to 3.1.3 to ensure clean publishing and link alignment.
12
+ - ๐Ÿ”— **Link Alignment**: Unified API key signup links to https://promptoptimizer.xyz/local-license.
13
+
14
+ ## [3.1.2] - 2026-04-12
15
+
16
+ ### Added
17
+ - ๐Ÿ›ก๏ธ **Security Policy**: Added `SECURITY.md` for coordinated vulnerability disclosure.
18
+ - ๐Ÿค **Community Guidelines**: Added `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` to foster open-source participation.
19
+ - ๐Ÿค– **CI/CD Automation**: Integrated GitHub Actions (`ci.yml`) for automated build and test validation.
20
+ - ๐Ÿท๏ธ **Snyk Health Badges**: Added professional health and status badges to `README.md`.
21
+
22
+ ### Changed
23
+ - ๐Ÿ“ **Metadata Optimization**: Standardized `package.json` keywords and license strings for better registry visibility.
24
+ - ๐Ÿ“‚ **Package Distribution**: Updated included files list to include new community and security documentation.
25
+ - ๐Ÿ“„ **Documentation Refresh**: Centralized resource links in README for better developer experience.
26
+
8
27
  ## [3.1.1] - 2026-04-10
9
28
 
10
29
  ### Changed
@@ -49,7 +68,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
49
68
  - โœ… **Production-only**: Package now enforces backend connectivity
50
69
 
51
70
  ### Migration from v2.x
52
- - All users must have valid API keys from https://promptoptimizer-blog.vercel.app/pricing
71
+ - All users must have valid API keys from https://promptoptimizer.xyz/pricing
53
72
  - `OPTIMIZER_DEV_MODE=true` no longer works (intentionally disabled)
54
73
  - Offline usage no longer supported (requires active backend connection)
55
74
  - Short-lived caching (1-2 hours) replaces long-term caching
@@ -0,0 +1,46 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ ## Our Standards
8
+
9
+ Examples of behavior that contributes to creating a positive environment include:
10
+
11
+ * Using welcoming and inclusive language
12
+ * Being respectful of differing viewpoints and experiences
13
+ * Gracefully accepting constructive criticism
14
+ * Focusing on what is best for the community
15
+ * Showing empathy towards other community members
16
+
17
+ Examples of unacceptable behavior by participants include:
18
+
19
+ * The use of sexualized language or imagery and unwelcome sexual attention or advances
20
+ * Trolling, insulting/derogatory comments, and personal or political attacks
21
+ * Public or private harassment
22
+ * Publishing others' private information, such as a physical or electronic address, without explicit permission
23
+ * Other conduct which could reasonably be considered inappropriate in a professional setting
24
+
25
+ ## Our Responsibilities
26
+
27
+ Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28
+
29
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30
+
31
+ ## Scope
32
+
33
+ This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34
+
35
+ ## Enforcement
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@promptoptimizer.xyz. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38
+
39
+ Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40
+
41
+ ## Attribution
42
+
43
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44
+
45
+ [homepage]: http://contributor-covenant.org
46
+ [version]: http://contributor-covenant.org/version/1/4
@@ -0,0 +1,61 @@
1
+ # Contributing to MCP Prompt Optimizer
2
+
3
+ Thank you for your interest in contributing to the MCP Prompt Optimizer! We welcome contributions from the community to help make this tool better for everyone.
4
+
5
+ ## Code of Conduct
6
+
7
+ By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
8
+
9
+ ## How Can I Contribute?
10
+
11
+ ### Reporting Bugs
12
+
13
+ If you find a bug, please search our [GitHub Issues](https://github.com/prompt-optimizer/mcp-prompt-optimizer/issues) to see if it has already been reported. If not, please open a new issue and include:
14
+
15
+ - A clear and descriptive title.
16
+ - Steps to reproduce the issue.
17
+ - Expected vs. actual behavior.
18
+ - Your environment (Node.js version, OS, MCP client).
19
+
20
+ ### Suggesting Enhancements
21
+
22
+ We love hearing new ideas! Please open an issue with the "enhancement" label and describe:
23
+
24
+ - The goal of the enhancement.
25
+ - How it should work.
26
+ - Why it would be useful.
27
+
28
+ ### Pull Requests
29
+
30
+ 1. **Fork the repository** and create your branch from `main`.
31
+ 2. **Install dependencies**: `npm install`
32
+ 3. **Make your changes**: Ensure your code follows the existing style.
33
+ 4. **Test your changes**: Run `npm test` to ensure everything is working correctly.
34
+ 5. **Update documentation**: If you've added new features, update the `README.md` or relevant docs.
35
+ 6. **Submit a Pull Request**: Provide a clear description of the changes and link to any related issues.
36
+
37
+ ## Development Setup
38
+
39
+ The project uses Node.js (>=16).
40
+
41
+ ```bash
42
+ git clone https://github.com/prompt-optimizer/mcp-prompt-optimizer.git
43
+ cd mcp-prompt-optimizer
44
+ npm install
45
+ ```
46
+
47
+ ### Running Tests
48
+
49
+ We have several test suites:
50
+
51
+ - `npm run test:quick`: Fast verification of core logic.
52
+ - `npm run test:integration`: Verification with the backend.
53
+ - `npm run test:comprehensive`: Full system check.
54
+
55
+ ## Security
56
+
57
+ If you discover a security vulnerability, please do NOT open a public issue. Instead, email us at support@promptoptimizer.xyz.
58
+
59
+ ## License
60
+
61
+ By contributing, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE).
package/README.md CHANGED
@@ -1,6 +1,12 @@
1
- # MCP Prompt Optimizer v3.1.1
1
+ # MCP Prompt Optimizer v3.1.3
2
+
3
+ [![NPM Version](https://img.shields.io/npm/v/mcp-prompt-optimizer)](https://www.npmjs.com/package/mcp-prompt-optimizer)
4
+ [![License](https://img.shields.io/badge/license-Commercial-blue.svg)](LICENSE)
5
+ [![CI](https://github.com/prompt-optimizer/mcp-prompt-optimizer/actions/workflows/ci.yml/badge.svg)](https://github.com/prompt-optimizer/mcp-prompt-optimizer/actions)
6
+ [![Snyk Health](https://snyk.io/advisor/npm-package/mcp-prompt-optimizer/badge.svg)](https://snyk.io/advisor/npm-package/mcp-prompt-optimizer)
7
+
8
+ รฐลธลกโ‚ฌ **Professional cloud-based MCP server** for AI-powered prompt optimization with intelligent context detection, template management, team collaboration, and enterprise-grade reliability. Starting at $0/month.
2
9
 
3
- ๐Ÿš€ **Professional cloud-based MCP server** for AI-powered prompt optimization with intelligent context detection, template management, team collaboration, and enterprise-grade reliability. Starting at $0/month.
4
10
 
5
11
 
6
12
  ## โœจ Key Features
@@ -20,7 +26,7 @@
20
26
 
21
27
  **1. Get your API key (required):**
22
28
 
23
- - **๐Ÿ†“ Free Tier** (`sk-local-*`): 5 daily optimizations โ€” [promptoptimizer-blog.vercel.app/pricing](https://promptoptimizer-blog.vercel.app/pricing)
29
+ - **๐Ÿ†“ Free Tier** (`sk-local-*`): 5 daily optimizations โ€” [promptoptimizer.xyz/pricing](https://promptoptimizer.xyz/pricing)
24
30
  - **โญ Paid Tiers** (`sk-opt-*`, `sk-team-*`): Higher quotas, team features, advanced capabilities
25
31
 
26
32
  **2. Install:**
@@ -421,15 +427,21 @@ Windsurf, Cline, VS Code, Zed, Replit, JetBrains IDEs, and Neovim are all suppor
421
427
 
422
428
  ---
423
429
 
424
- ## ๐Ÿ“ž Support & Resources
430
+ ## ๐Ÿ› ๏ธ Support & Resources
431
+
432
+ - ๐Ÿ“– **Documentation:** [promptoptimizer-blog.vercel.app/docs](https://promptoptimizer-blog.vercel.app/docs)
433
+ - ๐Ÿ“Š **Dashboard & model config:** [promptoptimizer-blog.vercel.app/dashboard](https://promptoptimizer-blog.vercel.app/dashboard)
434
+ - ๐Ÿš€ **Pricing & API Keys**: [promptoptimizer.xyz/local-license](https://promptoptimizer.xyz/local-license)
435
+ - ๐Ÿ› **Issues:** [GitHub Issues](https://github.com/prompt-optimizer/mcp-prompt-optimizer/issues)
436
+ - ๐Ÿ“„ **License:** [Commercial License](LICENSE)
437
+ - ๐Ÿ”’ **Security:** [Security Policy](SECURITY.md)
438
+ - ๐Ÿค **Contributing:** [Contributing Guide](CONTRIBUTING.md)
439
+ - ๐Ÿ“œ **Code of Conduct:** [Contributor Covenant](CODE_OF_CONDUCT.md)
440
+ - ๐Ÿ“ **Changelog:** [Release History](CHANGELOG.md)
441
+ - ๐Ÿ“ง **Email support:** support@promptoptimizer.xyz
425
442
 
426
- - **Documentation:** https://promptoptimizer-blog.vercel.app/docs
427
- - **Dashboard & model config:** https://promptoptimizer-blog.vercel.app/dashboard
428
- - **Troubleshooting:** https://promptoptimizer-blog.vercel.app/docs/troubleshooting
429
- - **Community support:** GitHub Discussions
430
- - **Email support:** support@promptoptimizer.help (Creator/Innovator plans)
431
- - **Enterprise:** enterprise@promptoptimizer.help
432
443
 
433
444
  ---
434
445
 
435
- *Get started with 5 free optimizations at [promptoptimizer-blog.vercel.app/pricing](https://promptoptimizer-blog.vercel.app/pricing)*
446
+ *Get started with 5 free optimizations at [promptoptimizer.xyz/pricing](https://promptoptimizer.xyz/pricing)*
447
+ at [promptoptimizer.xyz/pricing](https://promptoptimizer.xyz/pricing)*
package/SECURITY.md ADDED
@@ -0,0 +1,22 @@
1
+ # Security Policy
2
+
3
+ ## Supported Versions
4
+
5
+ We actively provide security updates for the following versions of `mcp-prompt-optimizer`:
6
+
7
+ | Version | Supported |
8
+ | ------- | ------------------ |
9
+ | 3.1.x | :white_check_mark: |
10
+ | 3.0.x | :x: |
11
+ | < 3.0 | :x: |
12
+
13
+ ## Reporting a Vulnerability
14
+
15
+ We take the security of our users seriously. If you discover a security vulnerability within this project, please do NOT open a public issue. Instead, follow these steps:
16
+
17
+ 1. **Email us**: Send a detailed report to support@promptoptimizer.xyz.
18
+ 2. **Include details**: Provide a description of the vulnerability, steps to reproduce, and potential impact.
19
+ 3. **Response time**: We aim to acknowledge receipt of your report within 48 hours.
20
+ 4. **Disclosure**: We will work with you to resolve the issue and coordinate a public disclosure once a fix is available.
21
+
22
+ Thank you for helping keep our community safe!
package/index.js CHANGED
@@ -1259,10 +1259,10 @@ class MCPPromptOptimizer {
1259
1259
  const remaining = limit - used;
1260
1260
  if (remaining <= 0) {
1261
1261
  output += `\nโŒ **Quota Exhausted** โ€” You have no optimizations remaining this month.\n`;
1262
- output += `Upgrade at https://promptoptimizer-blog.vercel.app/pricing\n`;
1262
+ output += `Upgrade at https://promptoptimizer.xyz/local-license\n`;
1263
1263
  output += `*(Quota resets at the start of your next billing cycle)*\n`;
1264
1264
  } else if (percentage >= 90) {
1265
- output += `\nโš ๏ธ **Critical** โ€” ${remaining} optimization${remaining === 1 ? '' : 's'} remaining. Upgrade at https://promptoptimizer-blog.vercel.app/pricing\n`;
1265
+ output += `\nโš ๏ธ **Critical** โ€” ${remaining} optimization${remaining === 1 ? '' : 's'} remaining. Upgrade at https://promptoptimizer.xyz/local-license\n`;
1266
1266
  } else if (percentage >= 75) {
1267
1267
  output += `\nโš ๏ธ **Warning** โ€” Approaching your monthly limit.\n`;
1268
1268
  }
@@ -1289,7 +1289,7 @@ class MCPPromptOptimizer {
1289
1289
  output += `\n## ๐Ÿ”— **Account Management**\n`;
1290
1290
  output += `- Dashboard: https://promptoptimizer-blog.vercel.app/dashboard\n`;
1291
1291
  output += `- Analytics: https://promptoptimizer-blog.vercel.app/analytics\n`;
1292
- output += `- Upgrade: https://promptoptimizer-blog.vercel.app/pricing\n`;
1292
+ output += `- Upgrade: https://promptoptimizer.xyz/local-license\n`;
1293
1293
 
1294
1294
  return output;
1295
1295
  }
@@ -1447,7 +1447,7 @@ async function startValidatedMCPServer() {
1447
1447
  try {
1448
1448
  const apiKey = process.env.OPTIMIZER_API_KEY;
1449
1449
  if (!apiKey) {
1450
- console.error('โŒ API key required. Get one at https://promptoptimizer-blog.vercel.app/pricing');
1450
+ console.error('โŒ API key required. Get one at https://promptoptimizer.xyz/local-license');
1451
1451
  process.exit(1);
1452
1452
  }
1453
1453
 
@@ -578,7 +578,7 @@ class CloudApiKeyManager {
578
578
 
579
579
  throw new Error(
580
580
  'API key required. Set the OPTIMIZER_API_KEY environment variable.\n' +
581
- 'Get your API key at: https://promptoptimizer-blog.vercel.app/pricing'
581
+ 'Get your API key at: https://promptoptimizer.xyz/local-license'
582
582
  );
583
583
  }
584
584
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mcp-prompt-optimizer",
3
- "version": "3.1.1",
3
+ "version": "3.1.3",
4
4
  "description": "Professional cloud-based MCP server for AI-powered prompt optimization with intelligent context detection, Bayesian optimization, AG-UI real-time optimization, template auto-save, optimization insights, personal model configuration via WebUI, team collaboration, enterprise-grade features, production resilience, and startup validation. Universal compatibility with Claude Desktop, Cursor, Windsurf, and 17+ MCP clients.",
5
5
  "main": "index.js",
6
6
  "bin": {
@@ -55,52 +55,17 @@
55
55
  "ai",
56
56
  "claude",
57
57
  "anthropic",
58
- "openrouter",
59
- "model-configuration",
60
- "personal-models",
58
+ "prompt-engineering",
59
+ "llm",
61
60
  "cursor",
62
61
  "windsurf",
63
62
  "cline",
63
+ "context-aware",
64
64
  "professional",
65
- "subscription",
66
- "cloud-based",
67
- "context-detection",
68
- "templates",
69
- "template-auto-save",
70
- "optimization-insights",
71
- "analytics",
72
- "team-collaboration",
73
- "enterprise-grade",
74
- "intelligent-routing",
75
- "ai-context",
76
- "api-key-management",
77
- "startup-validation",
78
- "caching",
79
- "robust-error-handling",
80
- "cli-commands",
81
- "professional-tooling",
82
- "network-resilience",
83
- "production-ready",
84
- "development-mode",
85
- "fallback-support",
86
- "cross-platform",
87
- "windows",
88
- "macos",
89
- "linux",
90
- "arm64",
91
- "bayesian-optimization",
92
- "ag-ui-real-time",
93
- "streaming-optimization",
94
- "websocket-support",
95
- "performance-optimization",
96
- "advanced-analytics",
97
- "intelligent-context",
98
- "ai-aware-rules",
99
- "parameter-tuning",
100
- "optimization-strategies"
65
+ "automation"
101
66
  ],
102
67
  "author": "Prompt Optimizer Team <support@promptoptimizer.xyz>",
103
- "license": "SEE LICENSE IN LICENSE",
68
+ "license": "Proprietary",
104
69
  "repository": {
105
70
  "type": "git",
106
71
  "url": "git+https://github.com/prompt-optimizer/mcp-prompt-optimizer.git"
@@ -114,7 +79,9 @@
114
79
  "lib/",
115
80
  "README.md",
116
81
  "CHANGELOG.md",
117
- "CROSS-PLATFORM.md",
82
+ "CONTRIBUTING.md",
83
+ "CODE_OF_CONDUCT.md",
84
+ "SECURITY.md",
118
85
  "LICENSE"
119
86
  ],
120
87
  "config": {
@@ -157,7 +124,7 @@
157
124
  {
158
125
  "name": "OPTIMIZER_API_KEY",
159
126
  "format": "sk-opt-*, sk-team-*, sk-dev-*, or sk-local-*",
160
- "description": "Cloud API key from promptoptimizer.xyz/pricing or development key for testing",
127
+ "description": "Cloud API key from promptoptimizer.xyz/local-license or development key for testing",
161
128
  "required": true
162
129
  }
163
130
  ],
package/CROSS-PLATFORM.md DELETED
@@ -1,272 +0,0 @@
1
- # Cross-Platform Compatibility Guide
2
-
3
- ## MCP Prompt Optimizer - Universal Platform Support
4
-
5
- This package has been designed and tested to work seamlessly across all major operating systems and architectures.
6
-
7
- ## โœ… Supported Platforms
8
-
9
- ### Operating Systems
10
- - **Windows 10/11** (x64)
11
- - **macOS** (Intel x64 & Apple Silicon ARM64)
12
- - **Linux** (Ubuntu, Debian, CentOS, RHEL, etc.) (x64, ARM64)
13
-
14
- ### Node.js Versions
15
- - **Minimum:** Node.js 16.0.0
16
- - **Recommended:** Node.js 18.0.0 or higher
17
- - **Tested:** Node.js 16, 18, 20, 21
18
-
19
- ## ๐Ÿš€ Installation
20
-
21
- The package installs identically on all platforms:
22
-
23
- ```bash
24
- # Global installation (recommended)
25
- npm install -g mcp-prompt-optimizer
26
-
27
- # Local installation
28
- npm install mcp-prompt-optimizer
29
- ```
30
-
31
- ## ๐Ÿ”ง Platform-Specific Setup
32
-
33
- ### Windows
34
-
35
- ```powershell
36
- # PowerShell
37
- $env:OPTIMIZER_API_KEY = "sk-opt-your-key-here"
38
- mcp-prompt-optimizer
39
-
40
- # Command Prompt
41
- set OPTIMIZER_API_KEY=sk-local-your-key-here
42
- mcp-prompt-optimizer
43
-
44
- # Or use the Windows-specific development script
45
- npm run dev:windows
46
- ```
47
-
48
- ### macOS & Linux
49
-
50
- ```bash
51
- # Bash/Zsh
52
- export OPTIMIZER_API_KEY="sk-local-your-key-here"
53
- mcp-prompt-optimizer
54
-
55
- # Or use the Unix-specific development script
56
- npm run dev:unix
57
- ```
58
-
59
- ### Cross-Platform (Recommended)
60
-
61
- ```bash
62
- # Works on all platforms with cross-env
63
- npm run dev
64
- npm run dev:mock
65
- ```
66
-
67
- ## ๐Ÿ“ File System Behavior
68
-
69
- ### Cache & Config Files
70
-
71
- The package automatically creates platform-appropriate cache files:
72
-
73
- - **Windows:** `%USERPROFILE%\.mcp-cloud-api-cache.json`
74
- - **macOS:** `~/.mcp-cloud-api-cache.json`
75
- - **Linux:** `~/.mcp-cloud-api-cache.json`
76
-
77
- ### Path Handling
78
-
79
- All file paths are handled using Node.js built-in `path` module for cross-platform compatibility:
80
- - Uses `path.join()` for path construction
81
- - Uses `os.homedir()` for user directory location
82
- - Automatically handles Windows backslashes vs Unix forward slashes
83
-
84
- ## ๐Ÿ›  Development & Testing
85
-
86
- ### Cross-Platform Development Scripts
87
-
88
- ```bash
89
- # Universal development mode (works everywhere)
90
- npm run dev
91
-
92
- # Mock mode for testing (works everywhere)
93
- npm run dev:mock
94
-
95
- # Platform-specific alternatives
96
- npm run dev:windows # Windows only
97
- npm run dev:unix # macOS/Linux only
98
- ```
99
-
100
- ### Testing Your Installation
101
-
102
- ```bash
103
- # Health check (works on all platforms)
104
- npm run health-check
105
-
106
- # Diagnostic tool
107
- npm run diagnose
108
-
109
- # API key validation
110
- npm run validate-key
111
- ```
112
-
113
- ## ๐Ÿ” Environment Variables
114
-
115
- All environment variables work consistently across platforms:
116
-
117
- ```bash
118
- # Core configuration
119
- OPTIMIZER_API_KEY=sk-local-your-key-here
120
- OPTIMIZER_BACKEND_URL=https://custom-backend.com
121
- OPTIMIZER_DEV_MODE=true
122
- NODE_ENV=development
123
-
124
- # Advanced options
125
- OPTIMIZER_REQUEST_TIMEOUT=30000
126
- OPTIMIZER_MAX_RETRIES=5
127
- ```
128
-
129
- ## ๐Ÿงช Platform-Specific Testing
130
-
131
- ### Windows Testing
132
-
133
- ```powershell
134
- # PowerShell
135
- $env:OPTIMIZER_API_KEY = "sk-dev-test-key"
136
- $env:OPTIMIZER_DEV_MODE = "true"
137
- node index.js
138
-
139
- # Command Prompt
140
- set OPTIMIZER_API_KEY=sk-dev-test-key
141
- set OPTIMIZER_DEV_MODE=true
142
- node index.js
143
- ```
144
-
145
- ### Unix Testing (macOS/Linux)
146
-
147
- ```bash
148
- # Direct environment variables
149
- OPTIMIZER_API_KEY=sk-dev-test-key OPTIMIZER_DEV_MODE=true node index.js
150
-
151
- # Or export first
152
- export OPTIMIZER_API_KEY=sk-dev-test-key
153
- export OPTIMIZER_DEV_MODE=true
154
- node index.js
155
- ```
156
-
157
- ## ๐ŸŒ MCP Client Compatibility
158
-
159
- The package works with MCP-compatible applications across all platforms:
160
-
161
- ### Claude Desktop
162
- - **Windows:** Configure in `%APPDATA%\Claude\claude_desktop_config.json`
163
- - **macOS:** Configure in `~/Library/Application Support/Claude/claude_desktop_config.json`
164
- - **Linux:** Configure in `~/.config/Claude/claude_desktop_config.json`
165
-
166
- ### Cursor IDE
167
- - **All Platforms:** Configure in `~/.cursor/mcp.json`
168
-
169
- ### Windsurf
170
- - **All Platforms:** Add via settings or configuration file
171
-
172
- ## ๐Ÿšจ Troubleshooting
173
-
174
- ### Common Platform Issues
175
-
176
- #### Windows
177
- - **Issue:** Scripts fail with "cannot be loaded because running scripts is disabled"
178
- - **Solution:** Run `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser` in PowerShell
179
-
180
- #### macOS
181
- - **Issue:** Permission denied when installing globally
182
- - **Solution:** Use `sudo npm install -g mcp-prompt-optimizer` or configure npm to use a different directory
183
-
184
- #### Linux
185
- - **Issue:** Node.js not found or wrong version
186
- - **Solution:** Use Node Version Manager: `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash`
187
-
188
- ### Universal Troubleshooting
189
-
190
- ```bash
191
- # Check Node.js version (should be 16+)
192
- node --version
193
-
194
- # Check npm version
195
- npm --version
196
-
197
- # Clear npm cache
198
- npm cache clean --force
199
-
200
- # Reinstall package
201
- npm uninstall -g mcp-prompt-optimizer
202
- npm install -g mcp-prompt-optimizer
203
-
204
- # Reset package cache
205
- npm run reset-cache
206
- ```
207
-
208
- ## ๐Ÿ“Š Performance Notes
209
-
210
- ### Platform Performance Characteristics
211
-
212
- - **Windows:** Slightly slower file I/O due to Windows Defender scanning
213
- - **macOS:** Excellent performance, especially on Apple Silicon
214
- - **Linux:** Generally fastest performance, especially for server deployments
215
-
216
- ### Memory Usage
217
-
218
- - **Typical:** 15-25 MB RAM usage
219
- - **Peak:** Up to 50 MB during optimization
220
- - **Consistent across all platforms**
221
-
222
- ## ๐Ÿ”’ Security Considerations
223
-
224
- ### Platform-Specific Security
225
-
226
- - **Windows:** API keys stored in user profile (protected by Windows user permissions)
227
- - **macOS:** API keys stored in user home (protected by macOS file permissions)
228
- - **Linux:** API keys stored with 600 permissions (user-only access)
229
-
230
- ### Network Security
231
- - All platforms use identical HTTPS connections
232
- - Certificate validation works uniformly across platforms
233
- - Network timeouts and retry logic identical
234
-
235
- ## ๐Ÿ“‹ Platform Support Matrix
236
-
237
- | Feature | Windows | macOS | Linux | ARM64 | Notes |
238
- |---------|---------|--------|-------|-------|-------|
239
- | Installation | โœ… | โœ… | โœ… | โœ… | npm/yarn |
240
- | MCP Server | โœ… | โœ… | โœ… | โœ… | Full compatibility |
241
- | Claude Desktop | โœ… | โœ… | โœ… | โœ… | All versions |
242
- | Cursor IDE | โœ… | โœ… | โœ… | โœ… | Latest versions |
243
- | Development Mode | โœ… | โœ… | โœ… | โœ… | Mock responses |
244
- | Cache System | โœ… | โœ… | โœ… | โœ… | Platform-appropriate paths |
245
- | Error Handling | โœ… | โœ… | โœ… | โœ… | Identical behavior |
246
- | Network Resilience | โœ… | โœ… | โœ… | โœ… | Same retry logic |
247
-
248
- ## ๐ŸŽฏ Best Practices
249
-
250
- ### Universal Setup
251
-
252
- 1. **Use cross-env for development:** Always prefer `npm run dev` over platform-specific commands
253
- 2. **Environment variables:** Use `.env` files for consistent configuration
254
- 3. **Path handling:** Never hardcode paths - the package handles this automatically
255
- 4. **Testing:** Test on your target platform before deployment
256
-
257
- ### Production Deployment
258
-
259
- - **Docker:** Package works excellently in containers (all Linux distros)
260
- - **Cloud:** Tested on AWS, Google Cloud, Azure, Railway, Vercel, Render
261
- - **Edge:** Works on edge computing platforms supporting Node.js 16+
262
-
263
- ## ๐Ÿ“ž Support
264
-
265
- If you encounter platform-specific issues:
266
-
267
- 1. **Check this guide first**
268
- 2. **Run diagnostics:** `npm run diagnose`
269
- 3. **Contact support:** support@promptoptimizer.help
270
- 4. **Include:** OS version, Node.js version, error messages
271
-
272
- The MCP Prompt Optimizer is committed to providing identical functionality and performance across all supported platforms.