|
| 1 | +# 🔧 GitHub Repository Setup Guide |
| 2 | + |
| 3 | +This guide contains the exact settings needed to make the LeadMagic MCP Server repository look perfect on GitHub. |
| 4 | + |
| 5 | +## 📝 Repository Settings |
| 6 | + |
| 7 | +### 1. Repository Description |
| 8 | +Go to **Settings > General > Repository Details** and set: |
| 9 | + |
| 10 | +``` |
| 11 | +🚀 Production-ready Model Context Protocol server for LeadMagic API - Complete B2B data enrichment suite with 19 powerful tools. Zero-config setup for Claude, Cursor, Windsurf, Continue.dev, and all MCP clients. |
| 12 | +``` |
| 13 | + |
| 14 | +### 2. Website URL |
| 15 | +Set the website to: |
| 16 | +``` |
| 17 | +https://github.com/LeadMagic/leadmagic-mcp#readme |
| 18 | +``` |
| 19 | + |
| 20 | +### 3. Repository Topics |
| 21 | +Add these topics for better discoverability: |
| 22 | + |
| 23 | +``` |
| 24 | +mcp |
| 25 | +model-context-protocol |
| 26 | +leadmagic |
| 27 | +b2b |
| 28 | +data-enrichment |
| 29 | +email-finder |
| 30 | +lead-generation |
| 31 | +claude |
| 32 | +cursor |
| 33 | +windsurf |
| 34 | +continue |
| 35 | +typescript |
| 36 | +production-ready |
| 37 | +api-client |
| 38 | +ai-tools |
| 39 | +zero-config |
| 40 | +enterprise |
| 41 | +nodejs |
| 42 | +sdk |
| 43 | +automation |
| 44 | +``` |
| 45 | + |
| 46 | +### 4. Social Preview |
| 47 | +- Go to **Settings > General > Social Preview** |
| 48 | +- Upload a custom image (1280x640px) or use the auto-generated one |
| 49 | +- Ensure it shows the LeadMagic MCP Server branding |
| 50 | + |
| 51 | +### 5. Features |
| 52 | +Enable these repository features: |
| 53 | +- ✅ **Wikis** (for additional documentation) |
| 54 | +- ✅ **Issues** (for bug reports and feature requests) |
| 55 | +- ✅ **Sponsorships** (GitHub funding) |
| 56 | +- ✅ **Projects** (for roadmap management) |
| 57 | +- ✅ **Discussions** (for community engagement) |
| 58 | + |
| 59 | +### 6. Pages |
| 60 | +- Enable **GitHub Pages** |
| 61 | +- Set source to **Deploy from a branch** |
| 62 | +- Select **main** branch and **/ (root)** folder |
| 63 | +- Use README.md as the homepage |
| 64 | + |
| 65 | +### 7. Security |
| 66 | +- Enable **Dependency graph** |
| 67 | +- Enable **Dependabot alerts** |
| 68 | +- Enable **Dependabot security updates** |
| 69 | +- Enable **Code scanning alerts** |
| 70 | + |
| 71 | +### 8. Badges |
| 72 | +The repository should display these badges: |
| 73 | +- npm version |
| 74 | +- Downloads |
| 75 | +- License |
| 76 | +- Node.js version |
| 77 | +- TypeScript |
| 78 | +- MCP Compatible |
| 79 | +- Production Ready |
| 80 | +- Security Verified |
| 81 | +- GitHub Stars/Issues/Forks |
| 82 | + |
| 83 | +## 🎯 Expected Result |
| 84 | + |
| 85 | +After applying these settings, the repository will show: |
| 86 | +- ✅ Professional description in the About section |
| 87 | +- ✅ Relevant topics for discoverability |
| 88 | +- ✅ Website link to documentation |
| 89 | +- ✅ Funding/sponsorship options |
| 90 | +- ✅ Complete project features enabled |
| 91 | +- ✅ Security best practices enabled |
| 92 | +- ✅ Professional badges and branding |
| 93 | + |
| 94 | +## 📊 Repository Analytics |
| 95 | + |
| 96 | +The repository should attract developers looking for: |
| 97 | +- MCP server implementations |
| 98 | +- B2B data enrichment tools |
| 99 | +- Claude/Cursor/Windsurf integrations |
| 100 | +- TypeScript/Node.js projects |
| 101 | +- AI tool integrations |
| 102 | +- Production-ready solutions |
| 103 | + |
| 104 | +## 🚀 Post-Setup Actions |
| 105 | + |
| 106 | +1. **Pin the repository** if it's important |
| 107 | +2. **Create a release** from the latest tag |
| 108 | +3. **Share on social media** with relevant hashtags |
| 109 | +4. **Submit to awesome lists** and directories |
| 110 | +5. **Engage with the community** through Issues and Discussions |
0 commit comments