Skip to content

GITHUB_OPTIMIZATION.md

Latest commit

 

History

History
120 lines (97 loc) · 3.63 KB

GITHUB_OPTIMIZATION.md

File metadata and controls

120 lines (97 loc) · 3.63 KB
Raw

GitHub Repository Optimization Guide

This document outlines the steps taken to optimize LeanMCP's discoverability on GitHub and search engines.

🎯 Optimization Goals

  • Improve search ranking for "lean mcp sdk", "production mcp server", "typescript mcp"
  • Compete directly with mcp-use in search results
  • Increase organic discovery through GitHub search
  • Establish professional presence with documentation site

✅ Completed Optimizations

1. Repository Description & Metadata

  • Updated package.json description: "LeanMCP SDK: Efficient, modular TypeScript toolkit for production MCP servers. Lighter than mcp-use with built-in auth, multi-tenancy, and human-in-the-loop."
  • Added comprehensive keywords: mcp, model-context-protocol, typescript, sdk, ai, chatgpt, claude, auth, production, lightweight, opensource, server, api, framework
  • Repository metadata: Added homepage, bugs URL, and repository URL

2. GitHub Topics to Add (Manual Step)

Go to GitHub repository settings and add these topics:

mcp
model-context-protocol  
typescript
sdk
ai
chatgpt
claude
auth
production
lightweight
opensource
server
api
framework
human-in-the-loop
multi-tenancy

3. GitHub Pages Documentation Site

  • Created: docs/index.html - Professional landing page
  • Created: docs/examples.html - Interactive examples showcase
  • Created: docs/CNAME - Custom domain setup (docs.leanmcp.com)
  • Created: .github/workflows/pages.yml - Automated deployment

4. SEO-Optimized README

  • Updated header: Includes competitive positioning against mcp-use
  • Keywords integration: Natural inclusion of search terms
  • Professional badges: Comprehensive badge system for credibility

📋 Manual Steps Required

1. Enable GitHub Pages

  1. Go to repository Settings → Pages
  2. Source: GitHub Actions
  3. Custom domain: docs.leanmcp.com (optional)

2. Add Repository Topics

  1. Go to repository main page
  2. Click the gear icon next to "About"
  3. Add the topics listed above
  4. Save changes

3. Create Release v0.1.0

  1. Go to Releases → Create new release
  2. Tag: v0.1.0
  3. Title: "LeanMCP SDK v0.1.0 - Production-Ready MCP Servers"
  4. Description: Use content from CHANGELOG.md

🚀 Expected Impact

Search Rankings

  • Target: Top 3 results for "lean mcp sdk"
  • Target: Top 5 results for "production mcp server typescript"
  • Target: Competitive with mcp-use for "mcp typescript sdk"

Discoverability Metrics

  • GitHub Stars: 10 → 100+ (10x growth)
  • Weekly npm downloads: Track growth
  • Documentation site visits: Monitor via GitHub Pages analytics
  • Organic search traffic: Monitor via search console

🔍 Competitive Analysis

vs mcp-use

  • Advantage: More specific positioning (production-ready)
  • Advantage: Built-in enterprise features (auth, multi-tenancy)
  • Advantage: Professional documentation site
  • Advantage: Clear competitive messaging

SEO Keywords Targeted

  • "mcp server sdk"
  • "typescript mcp framework"
  • "production mcp server"
  • "mcp auth integration"
  • "chatgpt mcp server"
  • "claude mcp integration"

📊 Monitoring & Metrics

Track these metrics monthly:

  1. GitHub repository stars and forks
  2. npm package downloads
  3. GitHub search ranking for key terms
  4. Documentation site traffic
  5. Community engagement (Discord, issues, PRs)

🔄 Ongoing Optimization

Content Strategy

  • Regular blog posts about MCP development
  • Tutorial videos and demos
  • Community showcase projects
  • Integration guides for popular services

Technical SEO

  • Structured data markup
  • Performance optimization
  • Mobile responsiveness
  • Accessibility improvements