ตั้งชื่อและอธิบายเครื่องมือให้ดี
เขียนคำอธิบายที่โมเดลนำไปดำเนินการได้จริง
ตั้งชื่อและอธิบายเครื่องมือให้ดี เป็นบทเรียน MCP Academy ฟรีบน CoddyKit นี่คือบทเรียนที่ 1 จากทั้งหมด 4 บทเรียน คุณสามารถอ่านบทเรียนทั้งหมดด้านล่างฟรี — จากนั้นลองปฏิบัติด้วยตัวคุณเองในเบราว์เซอร์พร้อมตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7 บทเรียนนี้เป็นส่วนหนึ่งของเส้นทางการเรียน MCP Academy และความก้าวหน้าของคุณจะซิงค์ข้ามเว็บและแอป CoddyKit คอร์ส MCP Academy มีบทเรียนทั้งหมด 4 บทเรียน
โมเดลอ่านก่อน
ก่อนที่ AI จะเรียกใช้เครื่องมือของคุณ มันจะอ่านชื่อและคำอธิบายเพื่อพิจารณาว่าเครื่องมือนี้เหมาะกับงานหรือไม่ 🧭
ตั้งชื่อเป็นคำกริยา
ชื่อเครื่องมือ MCP ที่ดีควรบอกได้ทันทีว่าเครื่องมือทำอะไร เช่น get_weather หรือ send_email ควรสั้น เริ่มด้วยการกระทำ และไม่ทำให้เข้าใจผิด
ชื่อมาจากไหน
ใน FastMCP ค่าเริ่มต้นของชื่อเครื่องมือมาจากชื่อฟังก์ชัน Python ดังนั้นควรตั้งชื่อฟังก์ชันอย่างรอบคอบและใช้รูปแบบ snake_case
@mcp.tool()
def get_weather(city: str) -> str:
...กำหนดชื่อใหม่
หากชื่อฟังก์ชันไม่เหมาะสม ให้ส่งชื่อที่ระบุชัดเจนไปยังตัวตกแต่ง เพื่อให้โมเดลเห็นชื่อที่คุณต้องการทุกประการ
@mcp.tool(name="get_weather")
def weather_lookup(city: str) -> str:
...คำอธิบายคือ Prompt
คำอธิบายของเครื่องมือจะถูกโมเดลอ่านเป็นแนวทาง ให้มองคำอธิบายนี้เหมือน prompt ขนาดเล็กที่บอก AI ว่าควรเรียกใช้เครื่องมือนี้เมื่อใดและเพราะเหตุใด
Docstring กลายเป็นคำอธิบาย
FastMCP จะเปลี่ยน docstring ของฟังก์ชันให้เป็นคำอธิบายเครื่องมือโดยอัตโนมัติ ดังนั้นควรเขียนโดยคำนึงถึงโมเดล ไม่ใช่เฉพาะมนุษย์
@mcp.tool()
def get_weather(city: str) -> str:
"""Get the current weather for a city."""บอกสิ่งที่ส่งคืน
คำอธิบายที่ดีจะระบุข้อมูลนำเข้าและผลลัพธ์ เพื่อให้โมเดลทราบว่าจะได้รับอะไรกลับมาก่อนเรียกใช้เครื่องมือ
ระบุข้อจำกัดให้ชัดเจน
ระบุขอบเขตไว้ในคำอธิบาย: รองรับเมืองใด รูปแบบใด และทำอะไรไม่ได้บ้าง ข้อจำกัดที่ชัดเจนช่วยป้องกันไม่ให้โมเดลใช้เครื่องมือของคุณผิดวิธี
หลีกเลี่ยงคำกริยาที่คลุมเครือ
คำอย่าง process หรือ handle ไม่ได้บอกอะไรแก่โมเดล ให้ใช้คำกริยาที่เจาะจง เพื่อให้ AI แยกเครื่องมือของคุณออกจากกันได้ขณะเรียกใช้
หนึ่งเครื่องมือ หนึ่งหน้าที่
ให้แต่ละเครื่องมือมุ่งเน้นที่หน้าที่เดียว เครื่องมือที่มีขอบเขตแคบและชื่อชัดเจนช่วยให้โมเดลเลือกได้ถูกต้องง่ายกว่าเครื่องมือที่ทำทุกอย่าง
ทดสอบชื่อด้วยการอ่านออกเสียง
อ่านชื่อและบรรทัดแรกของคำอธิบายต่อกัน หากคนแปลกหน้าไม่สามารถเดาได้ว่ามันทำอะไร โมเดลก็น่าจะเดาไม่ได้เช่นกัน
ตรวจสอบอย่างรวดเร็ว
โดยค่าเริ่มต้น FastMCP ดึงคำอธิบายของเครื่องมือมาจากที่ใด
ทบทวน
โมเดลจะอ่านชื่อและคำอธิบายก่อน ใช้ชื่อที่สื่อการกระทำ คำอธิบายจาก docstring และข้อจำกัดที่ชัดเจน เพื่อให้ AI เรียกใช้เครื่องมือของคุณได้อย่างถูกต้อง ✅
เรียนรู้ Python ด้วย AI tutor — ฟรี
เขียนและเรียกใช้โค้ดจริงในเบราว์เซอร์ของคุณ รับความช่วยเหลือทันทีจาก AI tutor 24/7 และเรียนรู้ต่อจากที่คุณหยุดบนเว็บหรือในแอป
- คอร์ส
- 30
- บทเรียน
- 120
คำถามที่พบบ่อย
บทเรียน “ตั้งชื่อและอธิบายเครื่องมือให้ดี” ฟรีหรือไม่
ใช่ — ข้อความเต็มของ “ตั้งชื่อและอธิบายเครื่องมือให้ดี” ฟรีให้อ่านที่นี่บนเว็บ เพื่อปฏิบัติแบบโต้ตอบ (ตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7) และปลดล็อคส่วนที่เหลือของคอร์ส MCP Academy ให้อัปเกรดเป็น CoddyKit PRO คอร์ส MCP Academy มีบทเรียนทั้งหมด 4 บทเรียน
คุณจะเรียนรู้อะไรในบทเรียน “ตั้งชื่อและอธิบายเครื่องมือให้ดี”
เขียนคำอธิบายที่โมเดลนำไปดำเนินการได้จริง คุณปฏิบัติ MCP Academy ด้วยโค้ดที่ใช้งานได้จริงที่คุณเรียกใช้โดยตรงในเบราว์เซอร์ และติวเตอร์ AI ตลอด 24/7 ตอบคำถามของคุณขณะที่คุณไปผ่านบทเรียน
คุณต้องมีประสบการณ์ก่อนที่จะเริ่มเรียน MCP Academy หรือไม่
ไม่จำเป็นต้องมีประสบการณ์มาก่อน MCP Academy บน CoddyKit ออกแบบมาสำหรับผู้เริ่มต้นไปจนถึงผู้เรียนขั้นสูง คุณสามารถเริ่มต้นที่นี่หรือเริ่มจากตัวแรกและเรียนด้วยความเร็วของคุณเอง นี่คือบทเรียนที่ 1 จากทั้งหมด 4 บทเรียน
บทเรียน “ตั้งชื่อและอธิบายเครื่องมือให้ดี” ใช้เวลานานแค่ไหน
บทเรียน CoddyKit ส่วนใหญ่ใช้เวลาประมาณ 5–10 นาที แต่ละบทเรียนจึงสั้นและเป็นแบบโต้ตอบ คุณสามารถก้าวหน้าอย่างต่อเนื่องและกลับมาเรียนต่อจากตรงที่เพิ่งหยุดบนเว็บและแอปได้เลย
ฉันเขียนและรันโค้ดในบทเรียน MCP Academy นี้ได้ไหม
ได้ บทเรียน MCP Academy ทุกบทมีตัวแก้ไขโค้ดในตัว คุณจึงเขียนและรันโค้ดจริงได้เลยในเบราว์เซอร์ และได้รับข้อเสนอแนะจาก AI ในทันที — ไม่ต้องติดตั้งในเครื่องของคุณ
บทเรียนทั้งหมดในหลักสูตรนี้
- ตั้งชื่อและอธิบายเครื่องมือให้ดี
- ประกาศพารามิเตอร์ด้วยคำใบ้ชนิดข้อมูล
- ส่งคืนผลลัพธ์ที่มีประโยชน์
- เครื่องมือเครื่องคิดเลขตั้งแต่ต้นจนจบ