PUBLISHING_GUIDE.mdā¢9.85 kB
# Publishing Guide for MCP Cut-Copy-Paste Clipboard Server v1.0.0
## Pre-Publishing Checklist
### 1. Update package.json with your information
Edit `package.json` and update the `author` field:
```json
"author": "Your Name <your.email@example.com>",
```
Optionally add repository information:
```json
"repository": {
"type": "git",
"url": "https://github.com/yourusername/cut-copy-paste-mcp.git"
},
"bugs": {
"url": "https://github.com/yourusername/cut-copy-paste-mcp/issues"
},
"homepage": "https://github.com/yourusername/cut-copy-paste-mcp#readme"
```
### 2. Create npm account (if you don't have one)
```bash
# Create account at https://www.npmjs.com/signup
# OR use CLI
npm adduser
```
### 3. Login to npm
```bash
npm login
```
You'll be prompted for:
- Username
- Password
- Email
- One-time password (if 2FA is enabled - highly recommended!)
### 4. Verify everything is ready
```bash
# Run all checks
npm run lint && npm test && npm run build
# Test the package locally with npx
npx .
# Check what will be published
npm pack --dry-run
```
### 5. Publish to npm
```bash
# This will automatically run 'npm run build' via prepublishOnly
npm publish
```
**Note**: Package name `cut-copy-paste-mcp` must be available on npm. If taken, you'll need to:
- Choose a different name (e.g., `@yourname/cut-copy-paste-mcp` for scoped package)
- Update `package.json` name field
- For scoped packages, use: `npm publish --access public`
---
## GitHub Release Steps
### 1. Commit and push all changes
```bash
# Ensure everything is committed
git add .
git commit -m "chore: prepare v1.0.0 release"
git push origin main
```
### 2. Create and push git tag
```bash
# Create annotated tag
git tag -a v1.0.0 -m "Release version 1.0.0"
# Push tag to GitHub
git push origin v1.0.0
```
### 3. Create GitHub Release
**Via GitHub Web Interface**:
1. Go to: `https://github.com/yourusername/cut-copy-paste-mcp/releases/new`
2. Select tag: `v1.0.0`
3. Release title: `v1.0.0 - Initial Release`
4. Description (use content below):
```markdown
# MCP Cut-Copy-Paste Clipboard Server v1.0.0 š
First stable release of the MCP Cut-Copy-Paste Clipboard Server - a Model Context Protocol server that provides cut, copy, paste, and undo operations for AI-assisted coding agents.
## ⨠Features
- **Copy/Cut/Paste Operations**: Line-based code manipulation with 1-indexed line numbers
- **Multi-Target Paste**: Paste clipboard content to multiple files in one operation
- **Undo Support**: Revert the last paste operation with automatic file restoration
- **Session Management**: Isolated clipboards per session with 24-hour timeout
- **Operation History**: Complete audit trail of all operations
- **SQLite Backend**: Persistent storage for sessions, clipboard, and operation logs
- **NPX Ready**: Run directly with `npx cut-copy-paste-mcp`
## š¦ Installation
```bash
# Run directly with npx (no installation required)
npx cut-copy-paste-mcp
# Or install globally
npm install -g cut-copy-paste-mcp
```
## š Quick Start
Add to your MCP client configuration (e.g., Claude Desktop):
```json
{
"mcpServers": {
"clipboard": {
"command": "npx",
"args": ["cut-copy-paste-mcp"]
}
}
}
```
## š§ Available Tools
- `copy_lines` - Copy lines from a file without modification
- `cut_lines` - Cut lines from a file (removes from source)
- `paste_lines` - Paste clipboard content to one or multiple targets
- `show_clipboard` - View current clipboard contents
- `undo_last_paste` - Revert the most recent paste operation
- `get_operation_history` - Retrieve operation audit trail
## š Documentation
- [README](https://github.com/yourusername/cut-copy-paste-mcp/blob/main/README.md) - Getting started guide
- [ARCHITECTURE](https://github.com/yourusername/cut-copy-paste-mcp/blob/main/docs/ARCHITECTURE.md) - System design and implementation details
- [API_REFERENCE](https://github.com/yourusername/cut-copy-paste-mcp/blob/main/docs/API_REFERENCE.md) - Complete tool documentation
## ā
Quality Metrics
- 156 passing tests
- 97%+ code coverage
- Zero linting errors/warnings
- Full TypeScript support
- Comprehensive documentation
## š Known Limitations
- Undo supports only the last paste operation (single-level)
- Text files only (binary files rejected)
- 10MB clipboard content limit
- Session timeout: 24 hours
## š License
MIT License - see [LICENSE](https://github.com/yourusername/cut-copy-paste-mcp/blob/main/LICENSE) file for details.
## š Acknowledgments
Built with the [Model Context Protocol SDK](https://modelcontextprotocol.io) by Anthropic.
---
**Full Changelog**: https://github.com/yourusername/cut-copy-paste-mcp/commits/v1.0.0
```
5. Click "Publish release"
**Via GitHub CLI** (alternative):
```bash
gh release create v1.0.0 \
--title "v1.0.0 - Initial Release" \
--notes-file RELEASE_NOTES.md
```
---
## Announcement Plan
### 1. Social Media / Community Announcements
**Twitter/X Template**:
```
š Launching MCP Cut-Copy-Paste Clipboard Server v1.0.0!
A Model Context Protocol server that brings cut/copy/paste operations to AI coding agents.
⨠Features:
⢠Multi-file operations
⢠Undo support
⢠Session management
⢠Full audit trail
Try it: npx cut-copy-paste-mcp
š https://github.com/yourusername/cut-copy-paste-mcp
#MCP #AI #CodingAgent #OpenSource
```
**Reddit (r/LocalLLaMA, r/ClaudeAI)** Template:
```
Title: [Release] MCP Cut-Copy-Paste Clipboard Server v1.0.0 - Cut/Copy/Paste for AI Coding Agents
I'm excited to share the first release of MCP Cut-Copy-Paste Clipboard Server, a Model Context Protocol server that provides clipboard operations for AI-assisted coding.
Key Features:
- Copy/cut/paste operations with line-based precision
- Multi-target paste (paste to multiple files at once)
- Undo support for the last paste operation
- Session-based clipboard management
- Complete operation history and audit trail
- Works with any MCP client (Claude Desktop, etc.)
Installation:
npx cut-copy-paste-mcp
The project includes 156 tests, comprehensive documentation, and follows strict TDD practices.
GitHub: https://github.com/yourusername/cut-copy-paste-mcp
npm: https://www.npmjs.com/package/cut-copy-paste-mcp
Would love to hear feedback and contributions!
```
**Hacker News** Template:
```
Title: MCP Cut-Copy-Paste Clipboard Server ā Cut/Copy/Paste Operations for AI Coding Agents
Body: Built this MCP server to enable clipboard-like operations for AI coding assistants. It provides copy/cut/paste with undo support, multi-file operations, and session management.
The implementation uses SQLite for persistence, supports 1-indexed line numbers (matching editor conventions), and includes full operation history for audit trails.
Written in TypeScript with 156 tests and 97%+ coverage. Open source (MIT).
```
### 2. MCP Community
Post in official MCP community channels:
- MCP Discord server
- Anthropic Developer Discord
- MCP GitHub discussions
### 3. npm Package Page
Your package page will automatically be available at:
`https://www.npmjs.com/package/cut-copy-paste-mcp`
Ensure your README.md is well-formatted as it will be displayed there.
---
## Monitoring & Maintenance
### Track npm downloads
```bash
# Check download statistics
npm info cut-copy-paste-mcp
```
Or use: https://npm-stat.com/charts.html?package=cut-copy-paste-mcp
### Monitor GitHub
- Watch for GitHub issues
- Review pull requests
- Check GitHub Insights for traffic and engagement
### Set up notifications
Enable GitHub notifications for:
- Issues
- Pull requests
- Stars
- Forks
### Respond to feedback
- Acknowledge issues within 24-48 hours
- Label issues appropriately (bug, enhancement, question)
- Create milestones for future releases (v1.1.0, v2.0.0)
---
## Post-Release Checklist
- [ ] Package published to npm successfully
- [ ] GitHub release created with tag v1.0.0
- [ ] Announcements posted (Twitter, Reddit, HN, etc.)
- [ ] npm package page verified (README displays correctly)
- [ ] Test installation with `npx cut-copy-paste-mcp`
- [ ] Add GitHub topics: `mcp`, `model-context-protocol`, `clipboard`, `ai-assistant`
- [ ] Star your own repository (for visibility)
- [ ] Watch repository for issues
- [ ] Update personal portfolio/resume with project link
---
## Troubleshooting
### npm publish fails with "package already exists"
The package name is taken. Options:
1. Use a scoped package: `@yourname/cut-copy-paste-mcp`
2. Choose a different name: `mcp-clipboard-tools`
3. Contact npm support if you believe you own the name
### npm publish fails with 402 Payment Required
You're trying to publish a scoped private package. Use:
```bash
npm publish --access public
```
### "You must be logged in to publish"
Run `npm login` first.
### Build fails during prepublishOnly
Fix any TypeScript compilation errors before publishing:
```bash
npm run build
```
### Git tag already exists
Delete and recreate:
```bash
git tag -d v1.0.0
git push --delete origin v1.0.0
git tag -a v1.0.0 -m "Release version 1.0.0"
git push origin v1.0.0
```
---
## Success Criteria
ā
Package appears on npm: https://www.npmjs.com/package/cut-copy-paste-mcp
ā
GitHub release visible with tag v1.0.0
ā
Can install globally: `npm install -g cut-copy-paste-mcp`
ā
Can run with npx: `npx cut-copy-paste-mcp`
ā
README displays correctly on npm package page
ā
Announcements posted to at least 2 communities
ā
GitHub repository has clear description and topics
---
## Next Steps After v1.0.0
Consider for future releases:
- Add more examples to documentation
- Create video tutorial
- Write blog post with detailed use cases
- Implement feature requests from users
- Plan v1.1.0 with community-requested features
- Add CI/CD with GitHub Actions
- Set up automated testing on multiple Node versions