将 REST API 封装为工具
将外部端点转换为可调用的工具。
将 REST API 封装为工具 是 CoddyKit 上的免费 MCP Academy 课时。 这是第 2 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 MCP Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 MCP Academy 课程共包含 4 节课。
将端点转换为工具
任何 REST API 都可以成为 MCP工具。每个端点都会变成一个可调用函数,模型可以调用它来获取或发送数据。🌐
从工具发起 HTTP 调用
在工具内部发出普通的 HTTP 请求,然后将响应作为模型能够读取和推理的文本返回。
优先使用异步客户端
请使用 httpx 之类的异步客户端,这样 API 调用较慢、等待网络响应时,也不会阻塞其他请求。
import httpx
async with httpx.AsyncClient() as client:
r = await client.get(url)将参数映射为工具参数
将端点查询所需的值公开为工具参数。模型传入城市或编号,您可以安全地将其放入请求中。
@mcp.tool()
async def get_weather(city: str) -> str:
...将机密保留在服务器端
将 API密钥存储在服务器环境中,绝不要将其作为工具参数。模型不应看到或发送凭据。
key = os.environ["WEATHER_API_KEY"]检查状态代码
在信任响应正文之前,请检查 HTTP状态。404 或 500 表示您应报告清晰的错误,而不是返回无用数据。
r.raise_for_status()解析并精简 JSON
大多数 API 返回 JSON。请解析它,只返回任务所需的字段,避免向模型灌入无关信息。
data = r.json()
return data["temp_c"]让每个工具只负责一项工作
将一个端点映射为一个职责明确、名称清晰的工具。职责细化的工具更容易被模型正确选择。
编写有帮助的说明
说明端点的作用以及应在何时使用它。准确的描述能让模型知道何时应该调用此工具。
处理网络故障
封装调用过程,使超时或连接中断时返回易读的错误消息,而不是导致整个服务器崩溃。
设置合理的超时时间
始终传入超时时间,避免上游服务失去响应,让工具永远等待一个不会到来的回复。
r = await client.get(url, timeout=10.0)快速检查
API 密钥应该存放在哪里?
回顾:将 REST 用作工具
您已将端点封装为 async 工具:传入参数、使用服务器端密钥、检查状态,并输出经过精简的 JSON。接下来,让我们池化连接。🎯
用 AI 导师学习 Python — 免费
在浏览器中编写并运行真实代码,获得全天候 AI 导师的即时帮助,并在网页或应用中继续学习。
- 课程
- 30
- 课程
- 120
常见问题解答
「将 REST API 封装为工具」课时是免费的吗?
是的 — 「将 REST API 封装为工具」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 MCP Academy 课程的其余内容,请升级到 CoddyKit PRO。 MCP Academy 课程共包含 4 节课。
「将 REST API 封装为工具」这节课中我会学到什么?
将外部端点转换为可调用的工具。 你通过在浏览器中直接运行的动手代码来练习 MCP Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 MCP Academy 需要有经验吗?
无需任何先前经验。CoddyKit 上的 MCP Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 2 节课,共 4 节。
「将 REST API 封装为工具」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 MCP Academy 课中编写并运行代码吗?
能。每节 MCP Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- 安全地公开 SQL 查询
- 将 REST API 封装为工具
- 在生命周期中复用连接池
- 缓存上游并限制速率