MCP Academy · 课时

为工具命名并写好描述

编写模型真正能够据此执行操作的描述。

第 1 / 4 课13 个步骤

为工具命名并写好描述 是 CoddyKit 上的免费 MCP Academy 课时。 这是第 1 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 MCP Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 MCP Academy 课程共包含 4 节课。

模型先读取

AI 真正运行您的 tool 之前,会先读取它的名称和描述,以判断这个 tool 是否适合当前任务。🧭

像动词一样命名

优秀的 MCP tool 名称应该让人一眼看出它的作用,例如 get_weather 或 send_email。名称要简短、以动作为先,不留歧义。

名称从何而来

在 FastMCP 中,tool 的名称默认取自您的 Python 函数名,因此请谨慎命名函数,并使用 snake_case。

@mcp.tool()
def get_weather(city: str) -> str:
    ...

覆盖默认名称

如果函数名不够理想,可以向装饰器传入明确的名称,这样模型看到的就是您指定的名称。

@mcp.tool(name="get_weather")
def weather_lookup(city: str) -> str:
    ...

描述就是一个 Prompt

模型会将 tool 的描述作为指导来阅读。请把它当作一个简短的 prompt,告诉 AI 何时以及为什么调用这个 tool。

文档字符串会变成描述

FastMCP 会自动将函数的文档字符串转换为 tool 描述,因此编写时要面向模型,而不只是面向人类。

@mcp.tool()
def get_weather(city: str) -> str:
    """Get the current weather for a city."""

说明它会返回什么

优秀的描述会说明输入和输出,这样模型在调用 tool 之前就知道会得到什么结果。

明确说明限制

请在描述中说明边界:支持哪些城市、哪些格式,以及不能执行哪些操作。清晰的限制可以防止模型误用您的 tool。

避免使用含糊的动词

像“处理”或“应对”这样的词无法向模型提供有效信息。请使用准确的动词,这样 AI 才能在调用时区分您的各个 tools。

一个 Tool,一个职责

让每个 tool 专注于一项职责。职责单一且命名清晰的 tool,比一个什么都做的 tool 更容易让模型正确选择。

大声读出名称并进行测试

把名称和描述的第一行放在一起读一遍。如果陌生人无法猜出它的作用,模型可能也无法猜出。

快速检查

FastMCP 默认从哪里获取 tool 的描述?

回顾

模型会先读取名称和描述。请使用表示操作的名称、文档字符串描述和清晰的限制,让 AI 正确调用您的 tool。✅

免费开始

用 AI 导师学习 Python — 免费

在浏览器中编写并运行真实代码,获得全天候 AI 导师的即时帮助,并在网页或应用中继续学习。

课程
30
课程
120

常见问题解答

「为工具命名并写好描述」课时是免费的吗?

是的 — 「为工具命名并写好描述」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 MCP Academy 课程的其余内容,请升级到 CoddyKit PRO。 MCP Academy 课程共包含 4 节课。

「为工具命名并写好描述」这节课中我会学到什么?

编写模型真正能够据此执行操作的描述。 你通过在浏览器中直接运行的动手代码来练习 MCP Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 MCP Academy 需要有经验吗?

无需任何先前经验。CoddyKit 上的 MCP Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 1 节课,共 4 节。

「为工具命名并写好描述」课时需要多长时间?

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。

我能在这节 MCP Academy 课中编写并运行代码吗?

能。每节 MCP Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 为工具命名并写好描述
  2. 使用类型提示声明参数
  3. 返回有用的结果
  4. 从头到尾构建计算器工具
← 返回 MCP Academy