diff --git a/docs/BLOG_POST_DRAFT.md b/docs/BLOG_POST_DRAFT.md new file mode 100644 index 0000000..dcc3f7f --- /dev/null +++ b/docs/BLOG_POST_DRAFT.md @@ -0,0 +1,338 @@ +# Introducing the Mapbox DevKit MCP Server: AI-Powered Map Development + +_Draft blog post for announcing the Mapbox DevKit MCP Server_ + +--- + +Building map applications has traditionally required deep expertise in cartography, style specifications, token management, and accessibility standards. Today, we're excited to introduce the **Mapbox DevKit MCP Server**β€”bringing AI assistance to the entire map development workflow. + +## What is the Mapbox DevKit MCP Server? + +The Mapbox DevKit MCP Server is a [Model Context Protocol](https://modelcontextprotocol.io) server that transforms AI assistants like Claude into expert Mapbox development partners. Through natural language conversations, developers can create custom map styles, validate production readiness, manage access tokens securely, and learn cartography best practices. + +It's part of Mapbox's commitment to making map development more accessible while maintaining professional quality and security standards. + +## Key Capabilities + +### 🎨 AI-Powered Style Creation + +Create custom map styles through natural conversation: + +``` +You: "Create a dark cyberpunk map style emphasizing nightlife venues" + +Claude: I'll create a dark-themed map style with neon colors perfect for nightlife. +[Creates style with vibrant magentas, cyans, and purples on dark backgrounds] + +βœ… Style created: mapbox://styles/username/ckl3d2m4p0001 +πŸ”— Preview: https://api.mapbox.com/styles/v1/... +βœ… Validation: Production-ready (all checks passed) +``` + +The style builder understands themes like "nature-focused," "minimal monochrome," or "retro 80s neon" and automatically generates appropriate color schemes, layer styling, and typography. + +### βœ… Production-Ready Validation + +Before deploying to production, validate your styles automatically: + +- **Expression validation**: Catch syntax errors in filters, paint properties, and layout expressions +- **Accessibility checks**: WCAG 2.1 compliance for color contrast (AA/AAA levels) +- **GeoJSON validation**: Verify coordinate ranges, polygon ring closure, and data structure +- **Performance optimization**: Identify unused sources, duplicate layers, and simplifiable expressions +- **Style comparison**: Understand what changed between versions + +All validation runs **offline** (no API calls) and completes in milliseconds. + +### πŸ” Secure Token Management + +Set up access tokens with proper security from day one: + +``` +You: "Set up tokens for my restaurant finder app at restaurantfinder.com" + +Claude: I'll create a secure token setup for your project. + +βœ… Development Token (pk.ey...) + - Restricted to: http://localhost:* + - Scopes: styles:read, styles:list + +βœ… Production Token (pk.ey...) + - Restricted to: https://restaurantfinder.com + - Scopes: styles:read + +βœ… Backend Secret Token (sk.ey...) + - Server-side only (never expose in client code) + - Scopes: styles:write, styles:read + +🎯 Initial style created and validated +πŸ”— Preview: [URL] +``` + +The server ensures: + +- URL restrictions are set correctly +- Public tokens never get secret scopes +- Backend tokens are never suggested for client-side use +- Token scope matches your actual needs + +### πŸŽ“ Built-in Cartography Expertise + +Learn best practices through 5 specialized **agent skills**: + +- **mapbox-cartography**: Color theory, visual hierarchy, typography principles +- **mapbox-token-security**: Scope management, rotation strategies, security patterns +- **mapbox-style-patterns**: Common layer configurations for typical use cases +- **mapbox-integration-patterns**: Framework-specific integration (React, Vue, Svelte, Angular) +- **mapbox-style-quality**: Validation workflows, accessibility, optimization strategies + +These skills teach AI assistants (and you!) professional map development practices. + +### πŸš€ Workflow Automation + +Seven orchestrated prompts handle common development tasks: + +1. **create-and-preview-style**: Create a style and generate shareable preview link +2. **build-custom-map**: Use AI to build themed map styles +3. **design-data-driven-style**: Create maps with dynamic, data-driven properties +4. **setup-mapbox-project**: Complete project setup with proper token security +5. **debug-mapbox-integration**: Systematic troubleshooting for integration issues +6. **analyze-geojson**: Validate and visualize GeoJSON data +7. **prepare-style-for-production**: Comprehensive quality validation workflow + +Each prompt chains multiple tools together with best practices built-in. + +## Real-World Use Cases + +### Rapid Prototyping + +Product manager: "Can we see what a dark mode map would look like for our nightlife app?" + +With DevKit: **5 minutes** to fully styled, validated preview +Without DevKit: **2-4 hours** of manual styling and iteration + +### Quality Assurance + +Developer: "Is this style ready for production?" + +With DevKit: **Automatic validation** catches expression errors, accessibility issues, optimization opportunities +Without DevKit: **Runtime errors**, failed accessibility audits, unoptimized performance + +### Security Setup + +New project: "We need to set up Mapbox tokens securely" + +With DevKit: **Guided setup** with proper restrictions, scopes, and validation +Without DevKit: **Common mistakes** like missing URL restrictions, wrong scopes, exposed secrets + +## How It Works + +The Mapbox DevKit MCP Server uses the [Model Context Protocol](https://modelcontextprotocol.io)β€”an open standard for connecting AI assistants to external tools and data sources. + +**For developers**: Install via npm and configure in your AI client (Claude Desktop, VS Code, Cursor): + +```bash +npm install -g @mapbox/mcp-devkit-server +``` + +**For AI assistants**: Access 25+ tools, 7 prompts, 4 resources, and 5 skills through natural conversation. + +## What Makes It Different? + +### vs. Main Mapbox MCP Server + +Mapbox now offers **two complementary MCP servers**: + +| Capability | Mapbox MCP Server | Mapbox DevKit MCP Server | +| ------------ | ------------------------------ | -------------------------------------- | +| **Purpose** | Geospatial intelligence | Map development toolkit | +| **Use Case** | Apps need location features | Building map applications | +| **Features** | Geocoding, routing, POI search | Style creation, validation, token mgmt | +| **Target** | AI agents, chatbots | Developers building maps | + +Use the main server when your **app needs geospatial features**. Use DevKit when you're **building the map itself**. + +### vs. Manual Development + +- ⏱️ **10x faster prototyping** through natural language +- βœ… **Better quality** through automatic validation +- πŸ“š **Educational** with built-in best practices +- πŸ”„ **Iterative** development through conversation + +## Getting Started + +### Installation + +**npm (recommended):** + +```bash +npm install -g @mapbox/mcp-devkit-server +``` + +**npx (no installation):** + +```bash +npx @mapbox/mcp-devkit-server +``` + +### Configuration + +Add to your MCP client (Claude Desktop example): + +```json +{ + "mcpServers": { + "mapbox-devkit": { + "command": "npx", + "args": ["-y", "@mapbox/mcp-devkit-server"], + "env": { + "MAPBOX_ACCESS_TOKEN": "your_token_here" + } + } + } +} +``` + +### First Map + +Open your AI assistant and try: + +``` +"Create a nature-focused map style emphasizing parks and green spaces, +centered on Central Park in New York" +``` + +The AI will: + +1. Create a custom style with earth tones and emphasized parks +2. Generate a preview URL +3. Validate for production readiness +4. Report any accessibility or quality issues + +## Technical Highlights + +### Comprehensive Tool Suite + +**25+ tools** organized by category: + +- **Style Management**: Create, update, retrieve, delete, preview styles +- **Token Management**: Create, list tokens with proper scopes +- **Validation**: Expression validation, GeoJSON validation, accessibility checks +- **Optimization**: Style optimization, comparison, performance analysis +- **Utilities**: Coordinate conversion, bounding boxes, geocoding +- **Documentation**: Reference materials, field definitions, best practices + +### Offline-First Design + +Many operations run entirely offline: + +- Style validation (expressions, GeoJSON) +- Accessibility checking (WCAG contrast ratios) +- Style optimization (redundancy removal) +- Style comparison (diff analysis) + +No API calls = fast, free, private. + +### Quality by Default + +All style-creation workflows **automatically validate** before presenting results: + +- Expression syntax checking +- WCAG AA accessibility compliance +- Optimization opportunities +- Deployment readiness assessment + +Warnings are informationalβ€”users can ignore them for prototypes but have visibility into production readiness. + +### Enterprise-Ready + +- **Distributed tracing**: OpenTelemetry integration for observability +- **Configurable**: Environment variables for feature toggles +- **Tested**: 386 test cases with comprehensive coverage +- **Documented**: Extensive documentation and examples +- **Type-safe**: Full TypeScript implementation with Zod validation + +## What's Next? + +We're continuously improving the Mapbox DevKit MCP Server based on developer feedback. Upcoming features include: + +- **Tileset integration**: Validate and preview custom tilesets +- **Batch operations**: Style migration and bulk updates +- **Advanced analytics**: Usage insights and optimization recommendations +- **Team workflows**: Shared styles and collaborative development +- **Framework templates**: Quick-start projects for React, Vue, Svelte + +## Learn More + +- **GitHub**: [github.com/mapbox/mcp-devkit-server](https://github.com/mapbox/mcp-devkit-server) +- **npm**: [@mapbox/mcp-devkit-server](https://www.npmjs.com/package/@mapbox/mcp-devkit-server) +- **MCP Registry**: [registry.modelcontextprotocol.io](https://registry.modelcontextprotocol.io) +- **Documentation**: [Full API reference and guides](https://github.com/mapbox/mcp-devkit-server#readme) + +## Join the Community + +We'd love to hear how you're using the Mapbox DevKit MCP Server: + +- **Share** your maps on Twitter/X with [#MapboxDevKit](https://twitter.com/hashtag/MapboxDevKit) +- **Report issues** or request features on [GitHub](https://github.com/mapbox/mcp-devkit-server/issues) +- **Contribute** improvements via pull requests +- **Connect** with other developers on [Mapbox Community Forum](https://community.mapbox.com) + +--- + +_The Mapbox DevKit MCP Server is open source (MIT License) and available today. Get started at [github.com/mapbox/mcp-devkit-server](https://github.com/mapbox/mcp-devkit-server)._ + +--- + +## Quotes (to be filled in) + +> "Quote from Mapbox leadership about AI-powered development tools" +> β€” [Name], [Title], Mapbox + +> "Quote from developer who used the tool during beta" +> β€” [Name], [Company/Title] + +> "Quote about MCP ecosystem" +> β€” [Name], Anthropic or MCP community + +--- + +## Technical Details (Appendix) + +### System Requirements + +- Node.js 22+ +- Mapbox access token +- MCP-compatible client (Claude Desktop, VS Code, Cursor, etc.) + +### Supported Platforms + +- macOS (Intel and Apple Silicon) +- Linux (all major distributions) +- Windows 10/11 +- Docker (cross-platform) + +### Integration Options + +- **CLI**: Direct command-line usage +- **MCP Clients**: Claude Desktop, VS Code, Cursor +- **Programmatic**: Import as Node.js package +- **Docker**: Containerized deployment + +### Security & Privacy + +- All API calls use HTTPS +- Access tokens stored securely in environment variables +- Offline tools process data locally +- No telemetry without explicit opt-in (OpenTelemetry) +- Open source for transparency + +--- + +**Media Contact**: [Contact information] + +**Assets Available**: + +- Screenshots of tool in action +- Demo video (5 minutes) +- Architecture diagrams +- Logo/branding assets diff --git a/docs/POSITIONING.md b/docs/POSITIONING.md new file mode 100644 index 0000000..5212bd4 --- /dev/null +++ b/docs/POSITIONING.md @@ -0,0 +1,367 @@ +# Mapbox DevKit MCP Server - Positioning & Marketing + +This document explains how the Mapbox DevKit MCP Server differs from the main Mapbox MCP Server and provides messaging for marketing and communications. + +## The Two Mapbox MCP Servers + +Mapbox offers **two complementary MCP servers** for different use cases: + +| Feature | Mapbox MCP Server | Mapbox DevKit MCP Server | +| -------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| **Purpose** | Geospatial intelligence for AI agents | Map development toolkit for developers | +| **Target Users** | AI agents, chatbots, assistants | Developers building map applications | +| **Primary Use Case** | Apps that need location features | Building and styling maps | +| **Key Capabilities** | Geocoding, POI search, routing, directions | Style creation, validation, token management | +| **When to Use** | Your app needs to find places, calculate routes | You're building a map application | +| **Repository** | [github.com/mapbox/mcp-server](https://github.com/mapbox/mcp-server) | [github.com/mapbox/mcp-devkit-server](https://github.com/mapbox/mcp-devkit-server) | +| **Announced** | July 2025 | October 2024 | + +## Unique Value Proposition + +### Mapbox DevKit MCP Server + +**Tagline**: "AI-powered development toolkit for building Mapbox applications" + +**What it does**: + +- 🎨 **Create custom map styles** with AI-powered style builder +- βœ… **Validate styles** before production (expressions, accessibility, optimization) +- πŸ” **Manage access tokens** with proper scopes and security +- πŸ“Š **Visualize GeoJSON** data with interactive previews +- πŸŽ“ **Learn cartography** through built-in skills (design, security, patterns) +- πŸš€ **Production-ready workflows** with quality checks and best practices + +**Differentiators**: + +1. **Developer-focused**: Tools for building maps, not using them +2. **Quality validation**: WCAG accessibility checks, expression validation, optimization +3. **Educational**: Built-in skills teach cartography and security best practices +4. **Workflow automation**: Orchestrated prompts for common development tasks +5. **Offline tools**: Many operations don't require API calls (validation, comparison) + +## Messaging Framework + +### Elevator Pitch (30 seconds) + +"The Mapbox DevKit MCP Server is an AI development assistant for building Mapbox applications. It helps developers create and validate map styles, manage access tokens securely, check accessibility compliance, and learn cartography best practicesβ€”all through natural language conversations with AI." + +### Extended Pitch (2 minutes) + +"Building map applications traditionally requires deep knowledge of Mapbox GL JS, style specifications, token management, and cartography principles. The Mapbox DevKit MCP Server brings AI assistance to this entire workflow. + +Through natural language, developers can: + +- Create custom map styles with themes like 'dark cyberpunk' or 'nature-focused' +- Validate styles for production readiness (expression syntax, WCAG accessibility, optimization) +- Set up proper token security with URL restrictions and scope management +- Visualize and validate GeoJSON data before using it +- Learn cartography through built-in skills covering design, security, and common patterns + +The server includes 25+ tools, 7 workflow prompts, and 5 agent skills that teach best practices. It's perfect for developers building map applications who want to move faster without compromising on quality or security. + +It complements the main Mapbox MCP Server: use that for geospatial features in your app, and use DevKit for building the map itself." + +## Target Audiences + +### 1. Frontend Developers + +**Pain points**: + +- Complex style specification syntax +- Accessibility concerns (color contrast, readability) +- Token management confusion +- Learning curve for cartography + +**Message**: "Build production-ready maps with AI assistanceβ€”no cartography degree required" + +### 2. Full-Stack Developers + +**Pain points**: + +- Security best practices for tokens +- Integration patterns across frameworks +- Testing and validation workflows +- Time constraints + +**Message**: "Accelerate map development with automated quality checks and security validation" + +### 3. AI/ML Engineers + +**Pain points**: + +- Adding location features to AI applications +- Map visualization for data +- Integration with existing AI tools +- Learning Mapbox ecosystem + +**Message**: "Add maps to your AI applications through the same conversation interface you're already using" + +### 4. Technical Product Managers + +**Pain points**: + +- Understanding technical requirements +- Estimating map feature complexity +- Ensuring accessibility compliance +- Managing technical debt + +**Message**: "Prototype map features instantly and ensure production-ready quality from day one" + +## Use Case Examples + +### Use Case 1: Rapid Prototyping + +**Scenario**: Product team wants to see what a "dark mode map for nightlife" would look like + +**With DevKit**: + +``` +User: "Create a dark mode map style emphasizing nightlife venues" +AI: [Uses build-custom-map prompt] + - Creates themed style + - Generates preview + - Validates accessibility + - Shows: "Dark mode style created at mapbox://styles/..." +``` + +**Without DevKit**: + +- 2-4 hours manual styling +- Multiple iterations for dark mode colors +- Manual accessibility checking +- No preview without deployment + +### Use Case 2: Production Deployment + +**Scenario**: Developer needs to ship a map style to production + +**With DevKit**: + +``` +User: "Prepare my style username/my-style for production" +AI: [Uses prepare-style-for-production prompt] + - Validates all expressions + - Checks WCAG accessibility + - Optimizes file size + - Reports: "Ready for deployment" or lists issues +``` + +**Without DevKit**: + +- Manual expression testing +- Runtime errors in production +- Missing accessibility issues +- Unoptimized file sizes + +### Use Case 3: Security Setup + +**Scenario**: New project needs proper token configuration + +**With DevKit**: + +``` +User: "Set up tokens for my new restaurant finder app at restaurantfinder.com" +AI: [Uses setup-mapbox-project prompt] + - Creates dev token (localhost only) + - Creates prod token (domain-restricted) + - Creates backend secret token + - Validates security setup +``` + +**Without DevKit**: + +- Manual token creation +- Often missing URL restrictions +- Confusion about public vs. secret tokens +- Security vulnerabilities + +## Content Marketing Ideas + +### Blog Posts + +1. **"From Prompt to Production: Building a Custom Map in 5 Minutes"** + - Use build-custom-map prompt + - Show entire workflow + - Compare with manual process + +2. **"Ensuring Accessibility in Map Design with AI"** + - Explain WCAG requirements + - Show check_color_contrast_tool + - Demo prepare-style-for-production + +3. **"Token Security Best Practices with Mapbox DevKit"** + - Common security mistakes + - How DevKit prevents them + - Setup workflow automation + +4. **"5 Map Styles We Built Using AI in One Afternoon"** + - Showcase different themes + - Show variety possible + - Include code/configuration + +### Video Tutorials + +1. **"Getting Started with Mapbox DevKit MCP Server"** (5 min) +2. **"Building a Data-Driven Map with AI"** (10 min) +3. **"Validating Map Styles for Production"** (8 min) +4. **"Map Development with Claude Desktop"** (15 min) + +### Social Media + +**Twitter/X threads**: + +- "πŸ—ΊοΈ Thread: 7 ways AI is changing map development" +- "🎨 Built these 5 map styles with AI in an hour" +- "βœ… Production-ready maps: What to check before deployment" + +**LinkedIn posts**: + +- Case studies from companies using DevKit +- ROI analysis (time saved, quality improvement) +- Integration with existing workflows + +### Conference Talks + +**Suggested topics**: + +- "AI-Powered Geospatial Development" (FOSS4G, State of the Map) +- "Building Accessible Maps with AI Assistance" (A11y conferences) +- "The Future of Developer Tools" (DevRel conferences) +- "Integrating Maps into AI Applications" (AI/ML conferences) + +## Competitive Differentiation + +### vs. Manual Development + +- ⏱️ **10x faster** for initial prototypes +- βœ… **Better quality** through automatic validation +- πŸ“š **Educational** with built-in best practices +- πŸ”„ **Iterative** through conversation + +### vs. Other MCP Servers + +- 🎯 **Specialized** for Mapbox development (not general-purpose) +- πŸ§ͺ **Validation tools** unique to map development +- πŸŽ“ **Skills system** teaches domain expertise +- πŸ”— **Workflow automation** through prompts + +### vs. Traditional Dev Tools + +- πŸ’¬ **Natural language** interface (no DSL to learn) +- πŸ€– **AI-powered** suggestions and generation +- πŸ” **Proactive** quality checks +- πŸ“– **Contextual** documentation and help + +## Success Metrics + +Track these to measure adoption: + +### Awareness + +- npm package downloads +- GitHub stars +- Registry page views +- Social media mentions + +### Engagement + +- Tool usage frequency +- Prompt invocations +- Skill references +- Issue/discussion activity + +### Quality + +- User satisfaction (surveys) +- Time to first map +- Production deployment rate +- Quality issue reduction + +## Partnership Opportunities + +### AI Platforms + +- **Claude Desktop**: Featured integration guide +- **GitHub Copilot**: Complementary capabilities +- **Cursor**: Built-in discovery +- **VS Code**: Extension marketplace + +### Developer Tools + +- **Mapbox Studio**: Cross-reference in docs +- **Mapbox SDKs**: Integration examples +- **CI/CD platforms**: Validation workflows + +### Education + +- **Coding bootcamps**: Curriculum integration +- **Online courses**: Tutorial partnerships +- **University programs**: Academic licenses +- **Developer advocates**: Training materials + +## Launch Strategy + +### Phase 1: Registry Submission (Week 1) + +- βœ… Submit to official MCP registry +- βœ… Ensure npm package is updated +- βœ… Update all documentation + +### Phase 2: Mapbox Channels (Week 2-3) + +- πŸ“ Blog post on mapbox.com +- πŸ“§ Email to developer newsletter +- πŸ”— Add to Mapbox API documentation +- πŸ’¬ Announce on Mapbox forums + +### Phase 3: Community Outreach (Week 4-6) + +- 🐦 Twitter/X announcement thread +- πŸ“Ί YouTube tutorial video +- πŸ“° Dev.to/Hashnode articles +- πŸ—£οΈ Present at virtual meetups + +### Phase 4: Paid Amplification (Month 2-3) + +- πŸ’° Sponsored content on developer platforms +- πŸŽ₯ Video ads on developer YouTube channels +- πŸ“± Social media advertising (LinkedIn, Twitter) +- 🎀 Podcast sponsorships + +## Call to Action Templates + +### For README/Documentation + +> **Try it now:** +> +> ```bash +> npx @mapbox/mcp-devkit-server +> ``` +> +> Create your first custom map style in minutes with AI assistance. + +### For Blog Posts + +> Ready to build production-ready maps faster? [Get started with Mapbox DevKit MCP Server](https://github.com/mapbox/mcp-devkit-server) or [install via npm](https://www.npmjs.com/package/@mapbox/mcp-devkit-server). + +### For Social Media + +> πŸ—ΊοΈ Building a map app? Let AI handle the styling, validation, and security. +> +> Try Mapbox DevKit MCP Server: [link] +> +> #MCP #Mapbox #AI #DevTools + +## Contact & Support + +For partnership inquiries or press: + +- **Product**: [product contact] +- **Marketing**: [marketing contact] +- **DevRel**: [devrel contact] + +For technical questions: + +- **GitHub Issues**: https://github.com/mapbox/mcp-devkit-server/issues +- **Documentation**: https://github.com/mapbox/mcp-devkit-server#readme +- **MCP Registry**: https://registry.modelcontextprotocol.io diff --git a/docs/REGISTRY_SUBMISSION.md b/docs/REGISTRY_SUBMISSION.md new file mode 100644 index 0000000..88ab116 --- /dev/null +++ b/docs/REGISTRY_SUBMISSION.md @@ -0,0 +1,146 @@ +# MCP Registry Submission Guide + +This document outlines the steps to submit the Mapbox DevKit MCP Server to the official MCP Registry. + +## Prerequisites + +- βœ… Node.js 22+ installed +- βœ… npm account (package already published: `@mapbox/mcp-devkit-server`) +- βœ… GitHub account with access to `mapbox` organization +- βœ… `server.json` file configured (already in repository) +- βœ… `mcpName` set in `package.json` (already configured) + +## Submission Steps + +### 1. Install mcp-publisher + +Choose one of the following methods: + +**macOS (Homebrew):** + +```bash +brew install mcp-publisher +``` + +**Linux (curl):** + +```bash +curl -fsSL https://mcp-get.com/install.sh | sh +``` + +**Windows:** +Download from: https://github.com/modelcontextprotocol/registry/releases + +### 2. Verify server.json + +The `server.json` file is already configured with: + +- βœ… Name: `io.github.mapbox/mcp-devkit-server` +- βœ… Description: Developer-focused toolkit positioning +- βœ… Package: `@mapbox/mcp-devkit-server` (npm) +- βœ… Version: Synced with package.json +- βœ… Environment variables: `MAPBOX_ACCESS_TOKEN` +- βœ… Transport: stdio + +**Review the file:** + +```bash +cat server.json +``` + +### 3. Authenticate with GitHub + +```bash +mcp-publisher login github +``` + +This will: + +- Open a browser for GitHub OAuth +- Request permission to verify repository ownership +- Store credentials locally + +### 4. Publish to Registry + +```bash +mcp-publisher publish +``` + +The tool will: + +- Validate `server.json` schema +- Verify npm package exists +- Check GitHub repository access +- Submit to registry at https://registry.modelcontextprotocol.io + +### 5. Verify Publication + +Once published, verify at: + +- **Registry**: https://registry.modelcontextprotocol.io +- **Search for**: "mapbox devkit" or "io.github.mapbox/mcp-devkit-server" + +## Updating the Registry Entry + +When releasing new versions: + +1. **Update version** in both `package.json` and `server.json` +2. **Publish to npm**: `npm publish` +3. **Update registry**: `mcp-publisher publish` + +The registry will automatically detect and publish the update. + +## Troubleshooting + +### Authentication Issues + +**Problem**: `mcp-publisher login github` fails + +**Solution**: Ensure you have: + +- GitHub account with access to `mapbox` organization +- Correct repository permissions +- Network access to GitHub OAuth + +### Validation Errors + +**Problem**: `server.json` validation fails + +**Solution**: + +- Check schema version is current +- Verify all required fields are present +- Ensure npm package exists: `npm view @mapbox/mcp-devkit-server` + +### Version Mismatch + +**Problem**: Registry shows old version + +**Solution**: + +- Ensure `server.json` version matches `package.json` +- Run version sync: `npm run sync-manifest` +- Republish: `mcp-publisher publish` + +## Registry Policies + +The MCP Registry has moderation guidelines: + +- ❌ No spam or malicious servers +- ❌ No impersonation +- ❌ No trademark violations +- βœ… Must be publicly accessible +- βœ… Must follow MCP specification + +## Support + +- **Registry issues**: https://github.com/modelcontextprotocol/registry/issues +- **MCP spec questions**: https://github.com/modelcontextprotocol/specification +- **This server issues**: https://github.com/mapbox/mcp-devkit-server/issues + +## Resources + +- [Official MCP Registry](https://registry.modelcontextprotocol.io) +- [Registry Documentation](https://registry.modelcontextprotocol.io/docs) +- [mcp-publisher CLI](https://github.com/modelcontextprotocol/registry) +- [MCP Specification](https://spec.modelcontextprotocol.io) diff --git a/docs/REGISTRY_SUBMISSION_CHECKLIST.md b/docs/REGISTRY_SUBMISSION_CHECKLIST.md new file mode 100644 index 0000000..bac07f1 --- /dev/null +++ b/docs/REGISTRY_SUBMISSION_CHECKLIST.md @@ -0,0 +1,285 @@ +# MCP Registry Submission - Action Checklist + +Quick checklist for submitting to the official MCP Registry. + +## Pre-Submission Checklist + +- [x] Package published to npm: `@mapbox/mcp-devkit-server@0.4.6` +- [x] `server.json` configured with updated description +- [x] `mcpName` set in package.json: `io.github.mapbox/mcp-devkit-server` +- [x] GitHub repository is public and accessible +- [ ] Latest version built and tested (`npm run build && npm test`) +- [ ] README.md updated with clear installation instructions +- [ ] Environment variables documented + +## Registry Submission Steps + +### Step 1: Install mcp-publisher + +Choose your platform: + +**macOS:** + +```bash +brew install mcp-publisher +``` + +**Linux:** + +```bash +curl -fsSL https://mcp-get.com/install.sh | sh +``` + +**Windows:** +Download from: https://github.com/modelcontextprotocol/registry/releases + +**Verify installation:** + +```bash +mcp-publisher --version +``` + +### Step 2: Review server.json + +```bash +cat server.json +``` + +Verify: + +- [x] Name: `io.github.mapbox/mcp-devkit-server` +- [x] Description mentions: style creation, validation, accessibility, token management +- [x] Version matches package.json: `0.4.6` +- [x] Repository URL correct +- [x] npm package identifier: `@mapbox/mcp-devkit-server` + +### Step 3: Authenticate + +```bash +mcp-publisher login github +``` + +This will: + +1. Open browser for GitHub OAuth +2. Request permission to verify repository ownership +3. Store credentials locally (~/.mcp-publisher/) + +**Expected output:** + +``` +βœ… Successfully authenticated with GitHub +``` + +### Step 4: Publish + +```bash +mcp-publisher publish +``` + +**Expected output:** + +``` +βœ… Validating server.json... +βœ… Verifying npm package exists... +βœ… Checking GitHub repository access... +βœ… Publishing to registry... +βœ… Successfully published io.github.mapbox/mcp-devkit-server@0.4.6 +``` + +### Step 5: Verify + +Visit the registry and search: + +- URL: https://registry.modelcontextprotocol.io +- Search: "mapbox devkit" or "io.github.mapbox/mcp-devkit-server" + +**Expected result:** + +- Server appears in search results +- Description, version, and repository link are correct +- Installation instructions are clear + +## Post-Submission Checklist + +### Immediate (Same Day) + +- [ ] Verify listing on registry +- [ ] Test installation from registry: `npx @mapbox/mcp-devkit-server` +- [ ] Share announcement on Twitter/X: "πŸŽ‰ Mapbox DevKit MCP Server is now in the official @MCP registry! [link]" +- [ ] Post in Anthropic Discord #mcp channel +- [ ] Add badge to README: "Available on MCP Registry" + +### Week 1 + +- [ ] Publish blog post on mapbox.com +- [ ] Email Mapbox developer newsletter +- [ ] Post on Mapbox community forum +- [ ] Create demo video for YouTube +- [ ] Update Mapbox API documentation + +### Week 2-4 + +- [ ] Write Dev.to article: "Building Maps with AI: A Guide" +- [ ] Write Hashnode article: "From Prototype to Production with Mapbox DevKit" +- [ ] Share on Reddit: r/ClaudeAI, r/webdev, r/gis +- [ ] Present at virtual meetup +- [ ] Submit talk proposals for conferences + +### Month 2+ + +- [ ] Track metrics: npm downloads, GitHub stars, registry views +- [ ] Collect user testimonials +- [ ] Create case studies +- [ ] Plan v1.0 release with new features + +## Registry Marketing Assets + +### GitHub README Badge + +Add to README.md: + +```markdown +[![MCP Registry](https://img.shields.io/badge/MCP%20Registry-Available-blue)](https://registry.modelcontextprotocol.io/server/io.github.mapbox/mcp-devkit-server) +``` + +### Social Media Copy + +**Twitter/X:** + +``` +πŸŽ‰ Mapbox DevKit MCP Server is now in the official MCP Registry! + +Build production-ready maps with AI assistance: +βœ… Custom style creation +βœ… Accessibility validation (WCAG) +βœ… Secure token management +βœ… 25+ developer tools + +Try it: npx @mapbox/mcp-devkit-server + +#MCP #Mapbox #AI +``` + +**LinkedIn:** + +``` +Exciting news! The Mapbox DevKit MCP Server is now available in the official Model Context Protocol Registry. + +This AI-powered development toolkit helps developers: +β€’ Create custom map styles through natural conversation +β€’ Validate styles for production readiness (expressions, accessibility, optimization) +β€’ Manage access tokens with proper security from day one +β€’ Learn cartography best practices through built-in skills + +It's designed to complement the main Mapbox MCP Serverβ€”use that for geospatial features in your app, and use DevKit for building the map itself. + +Get started: https://registry.modelcontextprotocol.io + +#DeveloperTools #AI #Geospatial #Mapbox +``` + +### Hacker News + +**Title:** "Mapbox DevKit MCP Server – AI-powered toolkit for building map applications" + +**Submission URL:** https://registry.modelcontextprotocol.io/server/io.github.mapbox/mcp-devkit-server + +**Comment:** + +``` +Hey HN! I'm sharing the Mapbox DevKit MCP Serverβ€”an AI-powered development toolkit for building Mapbox applications. + +It helps developers create and validate map styles, manage access tokens securely, check WCAG accessibility, and learn cartography best practices through natural language conversations with AI assistants like Claude. + +Key features: +- 25+ tools for map development (style creation, validation, token management) +- 7 orchestrated workflow prompts (e.g., "prepare style for production") +- 5 agent skills that teach cartography and security best practices +- Production validation: expression syntax, WCAG compliance, optimization + +It's different from the main Mapbox MCP Server (which provides geospatial features like geocoding and routing). This one is specifically for developers building map applications. + +Would love feedback from folks building map applications or using AI coding assistants! + +GitHub: https://github.com/mapbox/mcp-devkit-server +``` + +## Troubleshooting + +### Issue: Authentication fails + +**Error:** "Failed to authenticate with GitHub" + +**Solution:** + +1. Check GitHub account has access to mapbox organization +2. Verify repository is public +3. Try: `mcp-publisher logout && mcp-publisher login github` + +### Issue: Validation error + +**Error:** "server.json validation failed" + +**Solution:** + +1. Check schema version is current +2. Verify all required fields present +3. Run: `cat server.json | jq .` to validate JSON syntax + +### Issue: Package not found + +**Error:** "npm package @mapbox/mcp-devkit-server not found" + +**Solution:** + +1. Verify package is published: `npm view @mapbox/mcp-devkit-server` +2. Check version in server.json matches npm +3. Wait a few minutes for npm registry to update + +## Support Contacts + +**Registry issues:** + +- GitHub: https://github.com/modelcontextprotocol/registry/issues + +**MCP questions:** + +- Discord: https://discord.gg/anthropic (#mcp channel) +- Spec: https://github.com/modelcontextprotocol/specification + +**This server:** + +- GitHub: https://github.com/mapbox/mcp-devkit-server/issues +- Internal: [Add internal contact info] + +## Success Metrics to Track + +After submission, monitor: + +### Week 1 + +- [ ] Registry page views +- [ ] npm package downloads +- [ ] GitHub stars/forks +- [ ] Social media engagement + +### Month 1 + +- [ ] Active installations (via npm) +- [ ] GitHub issues/discussions +- [ ] Community feedback/testimonials +- [ ] Blog post views + +### Quarter 1 + +- [ ] Production deployments +- [ ] Developer retention +- [ ] Feature requests +- [ ] Community contributions + +--- + +**Last Updated:** [Date] +**Owner:** [Name/Team] +**Status:** Ready for submission diff --git a/server.json b/server.json index 21118ce..3a24c3d 100644 --- a/server.json +++ b/server.json @@ -1,7 +1,7 @@ { "$schema": "https://static.modelcontextprotocol.io/schemas/2025-10-17/server.schema.json", "name": "io.github.mapbox/mcp-devkit-server", - "description": "Provides AI assistants with direct access to Mapbox developer APIs and documentation.", + "description": "AI-powered Mapbox development toolkit for building map applications. Create and validate styles, manage tokens, check accessibility (WCAG), optimize performance, and get expert cartography guidance. Complements the main Mapbox MCP server with development-focused tools.", "repository": { "url": "https://github.com/mapbox/mcp-devkit-server", "source": "github"