Cursor Admin MCP Server

# 🚀 GitHub MCP Server Publishing Guide ## The Power-Up Approach to MCP Servers Think of MCP servers as power-ups for AI assistants. Just like how Mega Man gains new abilities by defeating bosses, developers can instantly equip their AI with new capabilities by installing MCP servers. Your Cursor Admin MCP server is the "Team Analytics Power-Up" - one command, and boom, full team insights. ## 📋 Pre-Flight Checklist ### Repository Structure (Do's ✅) ``` cursor-admin-mcp/ ├── src/ # TypeScript source files ├── dist/ # Built JavaScript (gitignored) ├── tests/ # Comprehensive test suite ├── examples/ # Working examples ├── docs/ # Additional documentation ├── .github/ # GitHub-specific files │ ├── workflows/ # CI/CD pipelines │ └── ISSUE_TEMPLATE/ # Issue templates ├── package.json # NPM configuration ├── tsconfig.json # TypeScript config ├── README.md # Main documentation ├── LICENSE # MIT License ├── CHANGELOG.md # Version history ├── CONTRIBUTING.md # Contribution guidelines ├── SECURITY.md # Security policy └── .gitignore # Ignore patterns ``` ### Essential Files (Must-Haves 🎯) #### 1. **README.md** - Your Server's Hero Landing Page ```markdown # Cursor Admin MCP Server <div align="center"> <img src="docs/images/logo.png" alt="Cursor Admin MCP" width="200"> [](https://www.npmjs.com/package/cursor-admin-mcp) [](https://opensource.org/licenses/MIT) [](https://modelcontextprotocol.io) [](./coverage) </div> ## 🎮 One-Line Install ```bash npx -y cursor-admin-mcp ``` ## 🚀 What This Power-Up Gives You Turn your AI assistant into a Cursor team analytics powerhouse: - 📊 **Team Insights** - Who's coding, who's not - 💰 **Spending Tracker** - Know where your credits go - 📈 **Usage Analytics** - Lines of code, AI acceptance rates - 🏆 **Leaderboards** - Most productive team members ## 🔌 Quick Start (30 seconds) 1. **Get your API key** from Cursor settings 2. **Add to Claude/Cursor**: ```json { "mcpServers": { "cursor-admin": { "command": "npx", "args": ["-y", "cursor-admin-mcp"], "env": { "CURSOR_API_KEY": "key_xxx" } } } } ``` 3. **Ask your AI**: "Show me team usage for last week" ## 📸 See It In Action  ## 🛠️ Available Tools | Tool | What It Does | Example Query | |------|--------------|---------------| | `get_team_members` | List all team members | "Who's on my team?" | | `get_daily_usage_data` | Usage metrics by day | "Show this week's coding stats" | | `get_spending_data` | Credit usage & costs | "What's our AI spend?" | [Full documentation →](docs/README.md) ``` #### 2. **CONTRIBUTING.md** - Community Guidelines ```markdown # Contributing to Cursor Admin MCP We love your input! We want to make contributing as easy and transparent as possible. ## 🚀 Quick Contribution Guide 1. Fork the repo 2. Create your feature branch (`git checkout -b feature/AmazingFeature`) 3. Commit your changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request ## 📝 Code Style - TypeScript with strict mode - ESLint + Prettier (run `npm run lint`) - Tests for new features (maintain >90% coverage) ## 🐛 Report Bugs Use GitHub Issues with: - Clear title and description - Steps to reproduce - Expected vs actual behavior - Environment details ## 💡 Feature Requests We love new ideas! Open an issue with: - Use case description - Why it would benefit users - Possible implementation approach ``` #### 3. **SECURITY.md** - Security Policy ```markdown # Security Policy ## Supported Versions | Version | Supported | | ------- | ------------------ | | 1.x.x | :white_check_mark: | | < 1.0 | :x: | ## Reporting a Vulnerability **DO NOT** create public issues for security vulnerabilities. Email: security@yourdomain.com You'll receive a response within 48 hours. ``` ### Package.json Best Practices 📦 ```json { "name": "cursor-admin-mcp", "version": "1.0.0", "description": "Model Context Protocol server for Cursor Admin API - instant team analytics for AI assistants", "keywords": [ "mcp", "model-context-protocol", "cursor", "cursor-api", "team-analytics", "ai-tools", "llm-tools" ], "homepage": "https://github.com/h3ro-dev/cursor-admin-mcp#readme", "bugs": { "url": "https://github.com/h3ro-dev/cursor-admin-mcp/issues" }, "repository": { "type": "git", "url": "git+https://github.com/h3ro-dev/cursor-admin-mcp.git" }, "license": "MIT", "author": { "name": "Your Name", "email": "your.email@example.com", "url": "https://yourwebsite.com" }, "type": "module", "main": "dist/index.js", "types": "dist/index.d.ts", "bin": { "cursor-admin-mcp": "./dist/index.js" }, "files": [ "dist", "README.md", "LICENSE" ], "scripts": { "build": "tsc", "test": "jest", "lint": "eslint src/**/*.ts", "prepublishOnly": "npm run build && npm run test" }, "engines": { "node": ">=16.0.0" } } ``` ## 🚫 Don'ts (Avoid These) 1. **Don't include sensitive data**: - No API keys in code - No .env files in repo - No user data in examples 2. **Don't forget platform compatibility**: - Test on Windows, Mac, Linux - Use cross-platform paths - Handle different shells 3. **Don't skip documentation**: - Every tool needs examples - Error messages must be helpful - Include troubleshooting section 4. **Don't ignore community standards**: - No CODE_OF_CONDUCT.md - Missing issue templates - Unclear contribution process ## ✅ Do's (Best Practices) ### 1. **GitHub Actions CI/CD** Create `.github/workflows/ci.yml`: ```yaml name: CI on: push: branches: [ main ] pull_request: branches: [ main ] jobs: test: runs-on: ${{ matrix.os }} strategy: matrix: os: [ubuntu-latest, windows-latest, macos-latest] node: [16, 18, 20] steps: - uses: actions/checkout@v3 - uses: actions/setup-node@v3 with: node-version: ${{ matrix.node }} - run: npm ci - run: npm run build - run: npm test - run: npm run lint ``` ### 2. **Automated NPM Publishing** Create `.github/workflows/publish.yml`: ```yaml name: Publish to NPM on: release: types: [created] jobs: publish: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - uses: actions/setup-node@v3 with: node-version: '18' registry-url: 'https://registry.npmjs.org' - run: npm ci - run: npm run build - run: npm test - run: npm publish env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} ``` ### 3. **Issue Templates** Create `.github/ISSUE_TEMPLATE/bug_report.md`: ```markdown --- name: Bug report about: Create a report to help us improve title: '[BUG] ' labels: 'bug' --- **Describe the bug** A clear description of what the bug is. **To Reproduce** 1. Install with '...' 2. Configure '...' 3. Run '...' 4. See error **Expected behavior** What should happen **Environment:** - OS: [e.g. macOS 14.0] - Node: [e.g. 18.17.0] - Version: [e.g. 1.0.0] ``` ### 4. **Badges That Matter** ```markdown [](https://www.npmjs.com/package/cursor-admin-mcp) [](https://www.npmjs.com/package/cursor-admin-mcp) [](https://opensource.org/licenses/MIT) [](https://github.com/h3ro-dev/cursor-admin-mcp/actions) [](https://modelcontextprotocol.io) ``` ## 🎯 Listing Requirements ### For Official MCP Registry 1. **Submit PR to modelcontextprotocol/servers**: - Add entry to community section - Include brief description - Link to your repo 2. **Required for acceptance**: - Working implementation - Clear documentation - MIT or Apache 2.0 license - Maintained alphabetical order ### For Community Directories 1. **MCP List (mcplist.ai)**: - Submit via their form - Include category tags - Provide usage examples 2. **Awesome MCP Servers**: - PR to awesome list - One-line description - Proper categorization ## 📈 Growth Hacks ### 1. **SEO-Optimized Description** ``` "Cursor Admin MCP Server - Real-time team analytics, usage tracking, and spending insights for Cursor IDE. Monitor developer productivity, AI acceptance rates, and credit usage through Model Context Protocol." ``` ### 2. **Social Proof** - Add testimonials to README - Include usage statistics - Show example outputs ### 3. **Visual Appeal** - Logo/banner image - Demo GIF/video - Architecture diagram - Before/after comparisons ### 4. **Easy Onboarding** ```markdown ## 🏃 Quick Test Try it right now without installation: ```bash CURSOR_API_KEY=your_key npx cursor-admin-mcp ``` ``` ## 🚀 Launch Checklist - [ ] Clean, organized repository structure - [ ] Comprehensive README with quick start - [ ] All essential files (LICENSE, CONTRIBUTING, etc.) - [ ] Working examples in `/examples` - [ ] 90%+ test coverage - [ ] CI/CD pipelines configured - [ ] NPM package published - [ ] Submitted to MCP registries - [ ] Created demo video/GIF - [ ] Added to personal portfolio ## 💡 Pro Tips 1. **Version Everything**: Use semantic versioning (1.0.0) 2. **Changelog**: Keep CHANGELOG.md updated 3. **Examples**: More examples = more adoption 4. **Respond Quickly**: First 48 hours of issues/PRs crucial 5. **Cross-Promote**: Share in Discord, Reddit, Twitter Remember: Your MCP server is a power-up waiting to be discovered. Make it irresistible to install and impossible to uninstall!