Relentless MCP Server

# Quick Start - Publishing @relentless/mcp ## 🚀 First Time Setup ```bash # 1. Create GitHub repo (do this on GitHub.com first) # Name: relentless-mcp # Visibility: Public # 2. Connect local repo to GitHub git remote add origin https://github.com/pranayaryal/relentless-mcp.git git branch -M main git commit -m "Initial commit: Relentless MCP Server v2.0.0" git push -u origin main # 3. Login to npm npm login ``` ## 📦 Publishing Updates ```bash # Quick publish workflow (patch version) npm version patch && pnpm publish:npm && git push origin main --tags # Or step by step: npm version patch # Updates version, creates tag pnpm build # Build the package pnpm publish:dry-run # Test what will be published pnpm publish:npm # Publish to npm git push origin main --tags # Push to GitHub ``` ## 📋 Commands Cheatsheet ```bash # Version updates npm version patch # 2.0.0 -> 2.0.1 (bug fixes) npm version minor # 2.0.0 -> 2.1.0 (new features) npm version major # 2.0.0 -> 3.0.0 (breaking changes) # Building pnpm build # Build TypeScript to JavaScript pnpm clean # Remove build directory pnpm rebuild # Clean + build # Publishing pnpm publish:dry-run # Test publish (doesn't actually publish) pnpm publish:npm # Publish to npm npm unpublish @relentless/mcp@2.0.0 # Unpublish (use carefully!) # Development pnpm dev # Run in development mode ``` ## 📁 What Gets Published? ✅ **Included:** - `build/` - Compiled JavaScript and types - `README.md` - Documentation - `claude_desktop_config.example.json` - Example config - `package.json` - Package metadata ❌ **Excluded:** - `src/` - TypeScript source (users don't need this) - `node_modules/` - Dependencies - `.git/` - Git files - Test files, logs, etc. ## 🔗 After Publishing 1. **Create GitHub Release** (optional but recommended): - Go to: https://github.com/pranayaryal/relentless-mcp/releases - Click "Draft a new release" - Select the version tag - Add release notes from CHANGELOG.md - Publish release 2. **Test Installation**: ```bash npx @relentless/mcp --version ``` 3. **Update Documentation**: - Update README.md if needed - Update CHANGELOG.md for next version ## ⚠️ Important Notes - **Cannot republish same version** - Must increment version - **Published packages are permanent** - Be careful what you publish - **Package is public** - Anyone can see and use it - **Keep API key out of code** - Never commit secrets ## 🆘 Quick Fixes **Wrong version published?** ```bash npm unpublish @relentless/mcp@2.0.x # Within 72 hours only npm version patch # Create new version pnpm publish:npm # Republish ``` **Forgot to push tags?** ```bash git push origin main --tags ``` **Need to update README without version bump?** ```bash # Make changes to README.md npm version patch # Still need new version for npm pnpm publish:npm ``` ## 📞 Help - Full guide: See [PUBLISHING.md](./PUBLISHING.md) - Issues: https://github.com/pranayaryal/relentless-mcp/issues - npm docs: https://docs.npmjs.com/