typescript-sdk

TypeScript SDK

概述

TypeScript SDK 提供了一种声明式方式，用于定义 Agent、子 Agent、工具及其关系。

规则（49）

请阅读各个规则文件，了解特定任务或主题的详细说明和代码示例：

标题	主题	描述
Sub Agent 关系概览	typescript-sdk/agent-relationships	Sub Agent 之间的转移和委派关系
何时使用转移与委派	typescript-sdk/agent-relationships	选择转移或委派关系的指南
委派关系类型	typescript-sdk/agent-relationships	Sub Agent、外部 Agent 和团队 Agent 委派
配置 StopWhen	typescript-sdk/agent-settings	控制停止条件，避免 Agent 陷入无限循环
Sub Agent 参数参考	typescript-sdk/agent-settings	subAgent() 配置的完整参数参考
CLI inkeep add 命令	typescript-sdk/cli-reference	从 Inkeep Agents Cookbook 拉取模板项目或 MCP
CLI inkeep config 命令	typescript-sdk/cli-reference	管理 Inkeep 配置值
CLI 配置文件结构	typescript-sdk/cli-reference	inkeep.config.ts 的结构和配置优先级
CLI inkeep dev 命令	typescript-sdk/cli-reference	启动 Inkeep 仪表板服务，以可视化方式编排 Agent
CLI 环境变量	typescript-sdk/cli-reference	CLI 和 SDK 支持的环境变量
CLI inkeep init 命令	typescript-sdk/cli-reference	在项目中初始化新的 Inkeep 配置文件
CLI inkeep list-agent 命令	typescript-sdk/cli-reference	列出特定项目中所有可用的 Agent
CLI inkeep login 命令	typescript-sdk/cli-reference	使用设备代码流程向部署进行身份验证
CLI inkeep logout 命令	typescript-sdk/cli-reference	清除某个配置文件中存储的凭据
CLI inkeep profile 命令	typescript-sdk/cli-reference	管理命名的 CLI 配置文件，以支持多个远程服务、凭据和环境
CLI inkeep pull 命令	typescript-sdk/cli-reference	从服务端拉取项目配置并更新本地 TypeScript 文件
CLI inkeep push 命令	typescript-sdk/cli-reference	将 Agent 配置推送到服务端
CLI inkeep update 命令	typescript-sdk/cli-reference	将 Inkeep CLI 更新到最新版本
运行时限制配置	typescript-sdk/configure-runtime-limits	如何配置执行限制、超时和约束
运行时配置变量	typescript-sdk/configure-runtime-limits	配置运行时限制的所有可用环境变量
上下文获取器概览	typescript-sdk/context-fetchers	如何使用上下文获取器，在 Agent 提示词中嵌入实时数据
凭据存储选项	typescript-sdk/credentials/overview	存储 MCP 服务和外部 Agent 凭据的选项
数据操作类型参考	typescript-sdk/data-operations	所有数据操作事件类型及其负载
数据操作概览	typescript-sdk/data-operations	如何启用和使用数据操作进行调试和监控
外部 Agent 概览	typescript-sdk/external-agents	如何使用 A2A 协议配置和使用外部 Agent
通过标头传递上下文	typescript-sdk/headers	如何通过 HTTP 标头向 Agent 传递动态上下文
在 Agent 中使用标头	typescript-sdk/headers	如何在提示词、上下文获取器和外部工具中使用标头值
对话记忆概览	typescript-sdk/memory	如何管理对话历史并将其纳入上下文窗口
模型类型参考	typescript-sdk/models	配置层级中每种模型类型的适用场景
模型提供商选项	typescript-sdk/models	不同模型提供商的配置选项
支持的模型参考	typescript-sdk/models	支持的模型提供商及其 API 密钥列表
定义工件组件	typescript-sdk/structured-outputs/artifact-components	如何定义包含引用和来源预览字段的工件组件
定义数据组件	typescript-sdk/structured-outputs/data-components	如何使用 Zod 架构定义数据组件
状态更新配置	typescript-sdk/structured-outputs/status-updates	如何为 Agent 配置 AI 驱动的状态更新
函数工具执行环境	typescript-sdk/tools/function-tools	沙盒提供商、运行时配置和安全保障
函数工具概览	typescript-sdk/tools/function-tools	使用场景以及如何创建函数工具
适应环境的 MCP 服务	typescript-sdk/tools/mcp-tools	配置 MCP 工具，根据环境（开发或生产）切换
MCP 工具身份验证	typescript-sdk/tools/mcp-tools	MCP 服务的身份验证方法，包括 API 密钥、OAuth 和自定义标头
MCP 工具覆盖项	typescript-sdk/tools/mcp-tools	自定义各个 MCP 工具对 Agent 的呈现方式
选择 MCP 工具	typescript-sdk/tools/mcp-tools	如何选择性启用 MCP 服务中的工具
将 MCP 服务注册为工具	typescript-sdk/tools/mcp-tools	如何为 Agent 注册和配置 MCP 工具
工具审批配置	typescript-sdk/tools/tool-approvals	如何配置工具，使其在执行前需要用户审批
响应工具审批请求	typescript-sdk/tools/tool-approvals	如何批准或拒绝工具执行请求
触发器配置选项	typescript-sdk/triggers/overview	触发器的配置选项，包括身份验证、架构和转换
触发器概览	typescript-sdk/triggers/overview	创建 Webhook 端点，以便从外部服务调用 Agent
触发器配置选项	typescript-sdk/triggers/webhooks	触发器的配置选项，包括身份验证、架构和转换
触发器概览	typescript-sdk/triggers/webhooks	创建 Webhook 端点，以便从外部服务调用 Agent
配置优先级层级	typescript-sdk/workspace-configuration	如何解析 CLI 标志、环境变量和配置文件值
工作区配置文件	typescript-sdk/workspace-configuration	inkeep.config.ts 的结构和选项

其他资源

如需了解更多信息，请参阅：

• 完整文档：https://docs.inkeep.com/（提供 llms.txt 和 llms-full.txt！）
• GitHub 仓库（开源）：https://github.com/inkeep/agents