文档中心 / SDK 教程
SDK 教程

Python SDK 实战教程

从零到生产，系统掌握 Cody Python SDK 的全部能力。每篇独立成章，可按需阅读，也可顺序学习。

Python 3.10+ 13 篇教程 循序渐进

基础篇

第 01–03 篇 安装、核心调用方式与流式输出
01
一次性对话
安装 cody-ai、三种客户端创建方式（直接构造 / Builder / Config）、run() 方法详解、RunResult 字段读取
约 8 min
→ 02
多轮对话
session_id 机制、自动 session 创建、会话的增删查、跨轮次保持上下文的完整用法
约 6 min
→ 03
流式输出全解
stream() / run_stream() 用法、StreamChunk 12 种类型系统、工具调用事件处理、流式取消、思考模式（thinking）
约 12 min
→

工具篇

第 04–05 篇 直接调用内置工具与注册自定义工具
04
工具直接调用
tool() 方法调用 28+ 内置工具、工具过滤（include/exclude_tools）、grep/glob/exec_command 等便捷方法与 LSP 工具
约 8 min
→ 05
注册自定义工具
自定义工具函数签名、docstring 写法、Builder .tool() 注册、before_tool / after_tool 中间件链
约 10 min
→

定制篇

第 06–08 篇 改写 Prompt、Skills 系统与 MCP 集成
06
Prompt 定制与多模态
system_prompt() vs extra_system_prompt() 的区别与组合、MultimodalPrompt 发送图片、典型定制场景示例
约 8 min
→ 07
使用 Skills
Agent Skills 开放标准、四层加载优先级、list_skills() / get_skill() 查询、自定义 Skill 目录配置、编写 SKILL.md
约 8 min
→ 08
集成 MCP
stdio 与 HTTP 两种传输方式、auto_start_mcp、运行时动态添加 MCP 服务器、mcp_call() 直接调用
约 10 min
→

进阶篇

第 09–13 篇 安全、可观测性、记忆、人机协同与存储扩展
09
安全与控制
allowed_roots 多目录访问、strict_read_boundary、熔断器（token/cost/步数/死循环检测）、无状态模式
约 10 min
→ 10
事件与可观测性
EventType 全量事件类型、.on() / .on_async() 注册方式、指标收集 get_metrics()、监控工具调用链路
约 8 min
→ 11
项目记忆
四类记忆（conventions / patterns / issues / decisions）、add_memory / get_memory / clear_memory、跨会话自动注入原理
约 7 min
→ 12
人机协同
interaction_request chunk 监听、submit_interaction() 响应、question / confirm / feedback 三种场景、超时处理
约 8 min
→ 13
存储抽象
SessionStore / AuditLogger / FileHistory 三个 Protocol、自定义实现接入 PostgreSQL 等、完整错误处理体系
约 8 min
→

从第一篇开始，5 分钟内跑通你的第一个 AI 编码任务

开始第 01 篇 →