Sunucuyu Belgeleme ve Yayımlama
Bir README yazın ve başkalarının kurabilmesi için paylaşın.
Sunucuyu Belgeleme ve Yayımlama, CoddyKit'te ücretsiz bir MCP Academy dersidir. Bu, 4 dersinin 4. dersidir. Aşağıdan dersin tamamını ücretsiz okuyabilir, sonra tarayıcıda yerleşik kod editörü ve 7/24 yapay zeka koçu ile uygulamalı olarak pratik yapabilirsin. Bu, MCP Academy öğrenme yolunun bir parçasıdır ve ilerlemeniz web ve CoddyKit uygulaması arasında senkronize olur. MCP Academy kursu toplamda 4 dersten oluşur.
Benimsenmesini Kolaylaştırın
Kimsenin kuramadığı harika bir sunucu hiç kimseye yardımcı olmaz. Son adım, başkalarının onu dakikalar içinde çalıştırabilmesi için belgelemek ve yayımlamaktır. 📦
README'ye Başlayın
Sunucunuzun ne yaptığını anlatan tek satırlık bir özetle başlayın. Okuyucu, sorununuzu çözüp çözmediğini ve kurulmaya değer olup olmadığını saniyeler içinde anlamalıdır.
Yetenekleri Listeleyin
Her tool'u, resource'u ve prompt'u kısa bir amaç açıklamasıyla yazın. Bu liste, kullanıcıların tam olarak neler yapabileceklerini görmek için gözden geçirdiği menüdür.
Kurulum Adımlarını Gösterin
Kopyalanıp yapıştırılabilecek kurulum komutları verin. Bağımlılıkları getirmek için gereken kesin adımları listelemek, insanların denemekten vazgeçmesine yol açan belirsizliği ortadan kaldırır.
# Clone and install
# git clone <your-repo>
# cd notes-mcp
# uv syncYapılandırmayı Belgeleyin
Veritabanı yolu veya API anahtarı gibi sunucunuzun okuduğu ortam değişkenlerini açıklayın. Açık yapılandırma belgeleri, en yaygın kurulum hatalarını önler.
İstemci Yapılandırmasını Gösterin
Kullanıcıların Claude Desktop'a yapıştıracağı tam JSON bloğunu ekleyin. Hazır yapılandırmayı vermek, beşinci denemede değil ilk denemede bağlanmalarını sağlar.
{
"mcpServers": {
"notes": { "command": "uv", "args": ["run", "server.py"] }
}
}Bir Kullanım Örneği Ekleyin
Gerçekçi bir örnek gösterin: kullanıcının yazdığı bir prompt ve sunucunun döndürdüğü sonuç. Somut bir gösterim, değeri herhangi bir özellik listesinden daha hızlı anlatır.
Sürümünüzü Sabitleyin
Kullanıcıların ne yüklediğini bilmesi için açık bir sürüm numarası kaydedin. Sürümleme, mevcut kurulumları bozmadan daha sonra değişiklik yayımlamanızı sağlar.
Lisansı Belirtin
Başkalarının çalışmanızı kullanmasına ve paylaşmasına izin verildiğini bilmeleri için bir lisans dosyası ekleyin. Lisans olmadan birçok ekip projeye hiç dokunmaz.
Bir Depoya Gönderin
Kodu GitHub gibi herkese açık bir depoda yayımlayın. Paylaşılabilir bir bağlantı, yerel projenizi topluluğun bulabileceği bir şeye dönüştürür.
# git init
# git add .
# git commit -m "Initial MCP server"
# git pushBir Kayıt Sistemine Gönderin
Son olarak sunucunuzu bir MCP kayıt sisteminde listeleyin; böylece istemciler onu keşfedip kurabilir. Katalogda yer almak, yabancıların çalışmanızı bulma yoludur.
Hızlı Kontrol
README'nizde nelerin bulunması gerektiğini doğrulayalım.
Özet
Açık bir README yazdınız, kurulum ve yapılandırma adımlarını verdiniz, lisans eklediniz ve bir kayıt sisteminde yayımladınız. Bitirme projesi MCP sunucunuz artık paylaşmaya hazır. 🎉
Yapay zeka eğitmeniyle Python öğren — ücretsiz
Tarayıcında gerçek kod yaz ve çalıştır, 7/24 yapay zeka eğitmeninden anında yardım al; web'de ya da uygulamada kaldığın yerden devam et.
- Kurslar
- 30
- Dersler
- 120
Sıkça Sorulan Sorular
“Sunucuyu Belgeleme ve Yayımlama” dersi ücretsiz mi?
Evet — “Sunucuyu Belgeleme ve Yayımlama” dersin tüm metni burada web'de ücretsiz olarak okunabilir. Etkileşimli olarak pratik yapmak (yerleşik kod editörü ve 7/24 yapay zeka koçu) ve MCP Academy kursunun geri kalanını açmak için CoddyKit PRO'ya yükselt. MCP Academy kursu toplamda 4 dersten oluşur.
“Sunucuyu Belgeleme ve Yayımlama” dersinde ne öğreneceğim?
Bir README yazın ve başkalarının kurabilmesi için paylaşın. MCP Academy ile uygulamalı kodu tarayıcıda doğrudan çalıştırarak pratik yaparsın ve 7/24 yapay zeka koçu dersi çalışırken sorularını yanıtlar.
MCP Academy öğrenmeye başlamak için deneyim gerekli mi?
Önceden deneyim gerekmez. CoddyKit'te MCP Academy, başlangıçtan ileri seviyeye kadar yapılandırıldığı için buradan başlayabilir veya başından başlayıp kendi hızında ilerleme yapabilirsin. Bu, 4 dersinin 4. dersidir.
“Sunucuyu Belgeleme ve Yayımlama” dersi ne kadar sürer?
Çoğu CoddyKit dersi yaklaşık 5–10 dakika sürer. Her biri kısa ve etkileşimli olduğu için sabit ilerleme yaparsın ve web ile uygulama arasında tam olarak bıraktığın yerden devam edebilirsin.
Bu MCP Academy dersinde kod yazıp çalıştırabilir miyim?
Evet. Her MCP Academy dersi yerleşik bir kod editörü içerir, bu sayede tarayıcıda gerçek kod yazıp çalıştırabilir ve anlık yapay zeka geri bildirimi alırsın — yerel kurulum gerekli değildir.
Bu kursun tüm dersleri
- Projeyi ve Araçları Kapsamlandırma
- Araçları, Kaynakları ve İstemleri Uygulama
- Test Etme, İnceleme ve Güçlendirme
- Sunucuyu Belgeleme ve Yayımlama