MCP GitHub README Generator
Integrates with GitHub to analyze repository structure, detect technologies, and fetch metadata for automatic README generation.
Enables triggering automated README generation workflows via n8n webhooks, allowing integration into automation pipelines.
Provides AI-powered content generation for READMEs using locally hosted Ollama models.
Provides AI-powered content generation for READMEs using OpenAI's models.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@MCP GitHub README GeneratorGenerate a README for https://github.com/vuejs/core"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
🤖 MCP GitHub README Generator
🚀 AI destekli GitHub repository analizi ile otomatik README.md oluşturucu
Model Context Protocol (MCP) standardında geliştirilmiş, akıllı analiz yapan hibrit tool
📸 Proje Önizlemesi

Modern web arayüzü ile GitHub repository analizi ve README.md oluşturma
Related MCP server: devflow-mcp
✨ Özellikler
🔍 Derin Repo Analizi - Tüm dosya yapısını ve teknolojileri otomatik tespit
📝 Akıllı İçerik Üretimi - Proje türüne göre özelleştirilmiş README bölümleri
🌐 Çoklu Kullanım Modu - MCP tool'u VEYA web arayüzü olarak kullanım
🎨 Modern Tasarım - Badge'ler, ikonlar ve responsive layout
⚡ Hızlı Kurulum - Tek komutla çalışır duruma gelir
🔧 n8n Entegrasyonu - Workflow automation desteği
🤝 MCP Standartları - Model Context Protocol ile tam uyumlu
🛠️ Teknoloji Yığını
Kategori | Teknolojiler |
Frontend |
|
MCP Server |
|
Build Tool | |
AI Providers |
|
Automation |
🎯 Kullanım Modları
1. 🌐 Web Arayüzü Modu
Modern, kullanıcı dostu web arayüzü ile:
# Geliştirme sunucusunu başlat
npm run dev
# Production build
npm run buildÖzellikler:
Görsel repository analizi
Gerçek zamanlı README önizleme
Drag & drop dosya yükleme
Responsive tasarım
2. 🤖 MCP Tool Modu
AI client'ları (Claude, Cursor, Continue.dev) ile entegrasyon:
# MCP server'ı build et
npm run build:mcp
# MCP server'ı başlat
npm run mcpDesteklenen AI Client'lar:
Claude Desktop
Cursor IDE
Continue.dev
Diğer MCP uyumlu client'lar
3. 🔄 n8n Workflow Modu
Otomatik README oluşturma workflow'ları:
# n8n workflow'unu import et
# n8n-workflows/readme-generator-workflow.json📸 Önizleme
Web Arayüzü
🎯 GitHub Repo Analizi
┌─────────────────────────────────────────────┐
│ https://github.com/user/awesome-project │
│ ↓ Dosya tarama ve analiz │
│ ✅ package.json → React + TypeScript │
│ ✅ src/ klasörü → Komponent yapısı │
│ ✅ API endpoints → Backend entegrasyonu │
└─────────────────────────────────────────────┘
📝 Otomatik README.md Üretimi
┌─────────────────────────────────────────────┐
│ ✨ Proje başlığı + badge'ler │
│ 📋 Özellik listesi │
│ 🛠️ Teknoloji yığını │
│ ⚡ Kurulum adımları │
│ 📖 Kullanım rehberi │
│ 🤝 Katkı kılavuzu │
└─────────────────────────────────────────────┘MCP Tool Kullanımı
Claude: "Bu GitHub repository için README oluştur: https://github.com/facebook/react"
MCP Tool: ✅ Repository analiz ediliyor...
✅ Teknolojiler tespit ediliyor...
✅ README.md oluşturuluyor...
📄 Profesyonel README.md hazır!🚀 Hızlı Başlangıç
Ön Gereksinimler
Node.js 18+
npm veya yarn
GitHub token (opsiyonel, rate limit için)
Kurulum
# Repository'yi klonlayın
git clone https://github.com/yourusername/mcp-readme-generator.git
cd mcp-readme-generator
# Bağımlılıkları yükleyin
npm install
# Environment variables'ları ayarlayın
cp .env.example .env
# .env dosyasını düzenleyin
# Web arayüzü için
npm run dev
# MCP server için
npm run build:mcp
npm run mcpMCP Entegrasyonu
Claude Desktop
~/Library/Application Support/Claude/claude_desktop_config.json:
{
"mcpServers": {
"readme-generator": {
"command": "node",
"args": ["./dist/mcp-server.js"],
"env": {
"GITHUB_TOKEN": "your_github_token"
}
}
}
}Continue.dev
.continue/config.json:
{
"mcpServers": [
{
"name": "readme-generator",
"command": "node ./dist/mcp-server.js"
}
]
}📚 Kullanım Örnekleri
Web Arayüzü
Tarayıcıda
http://localhost:5173açınGitHub repository URL'ini girin
Dil ve stil seçeneklerini ayarlayın
"Analiz Et" butonuna tıklayın
README'yi indirin
MCP Tool
// Claude ile kullanım
"Bu repository için Türkçe README oluştur: https://github.com/vercel/next.js"
// Cursor ile kullanım
"Analyze this repo and generate a detailed README: https://github.com/microsoft/vscode"n8n Workflow
# Webhook'a POST request
curl -X POST https://your-n8n.com/webhook/readme-webhook \
-H "Content-Type: application/json" \
-d '{
"repoUrl": "https://github.com/user/project",
"config": {
"language": "tr",
"style": "modern",
"notify": true
}
}'📁 Proje Yapısı
mcp-readme-generator/
├── 📁 src/
│ ├── 📁 components/ # React bileşenleri
│ │ └── MCPDemo.tsx # Ana demo bileşeni
│ ├── 📄 mcp-server.ts # MCP server implementation
│ ├── 📄 App.tsx # React app
│ └── 📄 main.tsx # Entry point
├── 📁 docs/ # Dokümantasyon
│ ├── 📄 MCP_INTEGRATION.md # MCP entegrasyon rehberi
│ ├── 📄 N8N_SETUP.md # n8n kurulum rehberi
│ └── 📄 EXAMPLE_OUTPUT.md # Örnek çıktılar
├── 📁 n8n-workflows/ # n8n workflow dosyaları
│ └── 📄 readme-generator-workflow.json
├── 📄 package.json
├── 📄 mcp-config.json # MCP konfigürasyonu
├── 📄 .env.example # Environment variables
└── 📄 README.md🔧 API Referansı
MCP Tools
generate_readme
GitHub repository için README.md oluşturur.
Parametreler:
repoUrl(string, required): GitHub repository URL'ilanguage('tr' | 'en' | 'multi'): Çıktı dili (default: 'en')style('minimal' | 'modern' | 'detailed'): README stili (default: 'modern')includeBadges(boolean): Badge'leri dahil et (default: true)includeTree(boolean): Proje ağacını dahil et (default: true)
analyze_repository
Repository yapısını ve teknolojilerini analiz eder.
Parametreler:
repoUrl(string, required): GitHub repository URL'ideep(boolean): Derin analiz yap (default: false)
trigger_n8n_workflow
n8n workflow'unu tetikler.
Parametreler:
webhookUrl(string, required): n8n webhook URL'irepoUrl(string, required): GitHub repository URL'iconfig(object): Konfigürasyon ayarları
Response Format
interface ReadmeResult {
success: boolean;
analysis: {
name: string;
description: string;
technologies: string[];
projectType: 'frontend' | 'backend' | 'fullstack' | 'cli' | 'library';
hasTests: boolean;
hasCI: boolean;
};
readme: string;
metadata: {
generatedAt: string;
language: string;
style: string;
};
}🌟 Desteklenen Proje Türleri
✅ Frontend: React, Vue, Angular, Svelte
✅ Backend: Node.js, Python, Rust, Go
✅ Mobile: React Native, Flutter
✅ Desktop: Electron, Tauri
✅ CLI Tools: Node.js, Python, Rust
✅ Libraries: npm packages, Python packages
🔄 n8n Workflow Özellikleri
Otomatik İşlemler
Repository analizi
Teknoloji tespiti
README oluşturma
Email bildirimi (opsiyonel)
Webhook response
Konfigürasyon
{
"repoUrl": "https://github.com/user/project",
"config": {
"language": "tr",
"style": "modern",
"includeBadges": true,
"includeTree": true,
"notify": true
}
}🤝 Katkıda Bulunma
Projeye katkıda bulunmak için:
🍴 Fork edin
🌟 Feature branch oluşturun:
git checkout -b feature/amazing-feature💾 Commit yapın:
git commit -m 'feat: add amazing feature'📤 Push edin:
git push origin feature/amazing-feature🔄 Pull Request açın
Geliştirme Ortamı Kurulumu
# Repository'yi fork edin ve klonlayın
git clone https://github.com/MustafaKemal0146/github-readme-generator-mcp.git
# Bağımlılıkları yükleyin
npm install
# Web arayüzünü başlatın
npm run dev
# MCP server'ı test edin
npm run build:mcp
npm run mcp📋 Roadmap
🎨 Custom Template System - Kullanıcı tanımlı şablonlar
🔍 Advanced Analytics - Kod kalitesi analizi
🌐 Multi-language Support - Daha fazla dil desteği
📊 Statistics Dashboard - Proje istatistikleri
🔗 GitHub Actions Integration - CI/CD entegrasyonu
📱 Mobile App - React Native companion app
🤖 More AI Providers - Groq, Cohere, local models
🚨 Troubleshooting
GitHub Rate Limit
# GitHub token ekleyin
export GITHUB_TOKEN=your_token_hereMCP Server Başlatma
# Build kontrolü
npm run build:mcp
# Server test
node dist/mcp-server.js --helpn8n Webhook
# Webhook test
curl -X POST your-webhook-url \
-H "Content-Type: application/json" \
-d '{"repoUrl": "https://github.com/test/repo"}'📄 Lisans
Bu proje MIT Lisansı altında lisanslanmıştır.
🙏 Teşekkürler
Model Context Protocol - MCP standartları için
GitHub API - Repository analizi için
OpenAI - AI destekli içerik üretimi için
n8n - Workflow automation için
Shields.io - Güzel badge'ler için
📞 İletişim
🛜 WebSite: https://mustafakemalcingil.site/
📧 Email: ismustafakemal0146@gmail.com
💼 LinkedIn: mustafakemal0146
🐙 GitHub: @mustafakemal0146
🌟 Bu projeyi beğendiyseniz yıldız vermeyi unutmayın!
This server cannot be installed
Maintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Latest Blog Posts
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/MustafaKemal0146/github-readme-generator-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server