서버 문서화 및 게시하기
README를 작성하고 다른 사람이 설치할 수 있도록 공유합니다.
서버 문서화 및 게시하기은(는) CoddyKit의 무료 MCP Academy 강의입니다. 이것은 4개 중 4번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 MCP Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. MCP Academy 강의에는 총 4개의 강의가 포함되어 있습니다.
쉽게 도입할 수 있게 만드세요
아무도 설치할 수 없는 훌륭한 서버는 누구에게도 도움이 되지 않습니다. 마지막 단계는 다른 사람들이 몇 분 안에 실행할 수 있도록 문서화하고 게시하는 것입니다. 📦
README를 시작하세요
서버가 무엇을 하는지 한 줄 요약으로 시작하세요. 독자는 몇 초 안에 이 서버가 자신의 문제를 해결하고 설정할 가치가 있는지 알아야 합니다.
기능을 나열하세요
각각의 간단한 목적과 함께 모든 tool, resource, prompt를 기록하세요. 이 목록은 사용자가 무엇을 할 수 있는지 정확히 확인하기 위해 훑어보는 메뉴입니다.
설치 단계를 보여 주세요
복사하여 붙여 넣을 수 있는 설치 명령을 제공하세요. 의존성을 가져오는 정확한 단계를 나열하면 사람들이 시도하지 못하게 만드는 추측을 없앨 수 있습니다.
# Clone and install
# git clone <your-repo>
# cd notes-mcp
# uv sync구성을 문서화하세요
데이터베이스 경로나 API 키처럼 서버가 읽는 환경 변수를 설명하세요. 명확한 구성 문서는 가장 흔한 설정 실패를 예방합니다.
클라이언트 구성을 보여 주세요
사용자가 Claude Desktop에 붙여 넣을 정확한 JSON 블록을 포함하세요. 준비된 구성을 제공하면 다섯 번째가 아니라 첫 번째 시도에 연결할 수 있습니다.
{
"mcpServers": {
"notes": { "command": "uv", "args": ["run", "server.py"] }
}
}사용 예를 추가하세요
현실적인 예시 하나를 보여 주세요. 사용자가 입력하는 prompt와 서버가 반환하는 결과를 함께 제시합니다. 구체적인 시연이 기능 목록보다 가치를 더 빠르게 전달합니다.
버전을 고정하세요
사용자가 무엇을 설치하는지 알 수 있도록 명확한 버전 번호를 기록하세요. 버전 관리를 하면 기존 설정을 망가뜨리지 않고 나중에 변경 사항을 배포할 수 있습니다.
라이선스를 명시하세요
다른 사람들이 작업물을 사용하고 공유해도 되는지 알 수 있도록 라이선스 파일을 추가하세요. 라이선스가 없으면 많은 팀이 프로젝트를 아예 사용하지 않습니다.
저장소에 올리세요
GitHub와 같은 공개 저장소에 코드를 게시하세요. 공유 가능한 링크가 있어야 로컬 프로젝트를 커뮤니티가 찾을 수 있는 프로젝트로 바꿀 수 있습니다.
# git init
# git add .
# git commit -m "Initial MCP server"
# git push레지스트리에 제출하세요
마지막으로 MCP 레지스트리에 서버를 등록하여 클라이언트가 이를 검색하고 설치할 수 있게 하세요. 카탈로그에 등록되어야 낯선 사람들도 작업물을 찾을 수 있습니다.
빠른 확인
README에 무엇을 포함해야 하는지 확인해 보겠습니다.
복습
명확한 README를 작성하고 설치 및 구성 단계를 안내했으며, 라이선스를 적용하고 레지스트리에 게시했습니다. 이제 최종 프로젝트인 MCP 서버를 공유할 준비가 되었습니다. 🎉
AI 튜터와 함께 Python을(를) 배우세요 — 무료
브라우저에서 실제 코드를 작성하고 실행하며, 24/7 AI 튜터로부터 즉각적인 도움을 받고, 웹이나 앱에서 중단한 부분부터 계속 학습하세요.
- 코스
- 30
- 레슨
- 120
자주 묻는 질문
“서버 문서화 및 게시하기” 강의는 무료인가요?
네 — “서버 문서화 및 게시하기” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 MCP Academy 강의 전체를 잠금 해제할 수 있습니다. MCP Academy 강의에는 총 4개의 강의가 포함되어 있습니다.
“서버 문서화 및 게시하기”에서 뭘 배우나요?
README를 작성하고 다른 사람이 설치할 수 있도록 공유합니다. 브라우저에서 직접 실행하는 실습 코드로 MCP Academy을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.
MCP Academy을(를) 시작하는 데 경험이 필요한가요?
사전 경험은 필요하지 않습니다. CoddyKit의 MCP Academy은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 4번째 강의입니다.
“서버 문서화 및 게시하기” 강의는 얼마나 걸리나요?
대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.
이 MCP Academy 강의에서 코드를 작성하고 실행할 수 있나요?
네. 모든 MCP Academy 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.
이 강의의 모든 강의
- 프로젝트와 도구의 범위 정하기
- 도구, 리소스와 프롬프트 구현하기
- 테스트, 검사와 강화
- 서버 문서화 및 게시하기