โครงสร้างโครงการสำหรับเซิร์ฟเวอร์

เซิร์ฟเวอร์ขนาดเล็กอาจอยู่ในไฟล์เดียวได้ แต่การจัดวางที่ดีช่วยให้ขยายต่อได้โดยไม่กลายเป็นระเบียบยุ่งเหยิง การวางแผนเล็กน้อยตอนนี้ช่วยลดปัญหาใหญ่ในภายหลัง 🗂️

เซิร์ฟเวอร์ส่วนใหญ่เริ่มต้นจาก server.py ไฟล์เดียว ซึ่งเก็บอินสแตนซ์ FastMCP พร้อมเครื่องมือหนึ่งหรือสองรายการ แค่นี้ก็เพียงพอสำหรับเริ่มทำงาน

ที่โฟลเดอร์รากจะมี pyproject.toml ซึ่งประกาศชื่อโปรเจกต์และสิ่งที่โปรเจกต์ต้องพึ่งพา uv จะอ่านไฟล์นี้เพื่อทราบว่าต้องติดตั้งอะไรอย่างแน่ชัด

ถัดจากไฟล์นั้นจะมี uv.lock ซึ่งเป็นบันทึกที่ตรึงเวอร์ชันที่แก้ไขแล้วทั้งหมดไว้ ควรคอมมิตไฟล์นี้เพื่อให้เพื่อนร่วมทีมสร้างการตั้งค่าที่เหมือนกันทุกประการ

โฟลเดอร์ .venv เป็นสิ่งที่สร้างขึ้นโดยอัตโนมัติ ไม่ใช่ซอร์สโค้ด ให้เพิ่มโฟลเดอร์นี้ใน .gitignore เพื่อไม่คอมมิตสภาพแวดล้อมขนาดใหญ่ที่เฉพาะกับแต่ละเครื่อง

เมื่อโปรเจกต์เติบโต ให้แยกโค้ดตามหน้าที่ การวาง tools ทรัพยากร และพรอมต์ไว้ในโมดูลแยกกันช่วยให้แต่ละไฟล์มีจุดมุ่งหมายชัดเจนและอ่านง่าย

เซิร์ฟเวอร์ที่กำลังเติบโตมักมีหน้าตาเช่นนี้: จุดเริ่มต้นของเซิร์ฟเวอร์อยู่ถัดจากโฟลเดอร์สำหรับความสามารถแต่ละประเภท โฟลเดอร์ที่ชัดเจนช่วยให้ค้นหาได้รวดเร็ว 🌳

ควรมี จุดเริ่มต้น เพียงจุดเดียว ซึ่งสร้างอินสแตนซ์ FastMCP และลงทะเบียนทุกอย่าง ไคลเอนต์จำเป็นต้องเปิดใช้ไฟล์นี้เพียงไฟล์เดียว

กำหนดเครื่องมือในโมดูลของตนเอง จากนั้นนำเข้าและลงทะเบียนเครื่องมือเหล่านั้นในไฟล์เริ่มต้น server.py ของคุณจะยังสั้นและสแกนดูได้ง่าย

README สั้น ๆ ที่บอกผู้อื่นถึงวิธีติดตั้งและเรียกใช้เซิร์ฟเวอร์จะช่วยให้แชร์โปรเจกต์ได้ คุณในอนาคตจะขอบคุณตัวคุณในวันนี้

อย่าเขียนคีย์ลงในโค้ดโดยตรง ให้อ่านคีย์จาก ตัวแปรสภาพแวดล้อม และเก็บไฟล์ .env ตัวอย่างไว้ เพื่อให้การตั้งค่าปลอดภัยและย้ายไปใช้ที่อื่นได้ 🔐

คุณได้เรียนรู้ให้เริ่มจากไฟล์เดียว ติดตาม pyproject.toml และไฟล์ล็อก ไม่ติดตาม .venv และแยกโค้ดตามองค์ประกอบพื้นฐานแล้ว เซิร์ฟเวอร์ของคุณจึงเติบโตได้อย่างเป็นระเบียบ ✅