typescript-sdk
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseTypescript Sdk
TypeScript SDK
Overview
概述
The TypeScript SDK provides a declarative way to define agents, sub-agents, tools, and their relationships.
TypeScript SDK 提供了一种声明式的方式来定义Agent、子Agent、工具及其相互关系。
Rules (45)
规则（45条）
Read individual rule files for detailed explanations and code examples on particular tasks or topics:
| Title | Topic | Description |
|---|---|---|
| Sub Agent Relationships Overview | typescript-sdk/agent-relationships | Transfer and delegation relationships between Sub Agents |
| When to Use Transfers vs Delegation | typescript-sdk/agent-relationships | Guidelines for choosing between transfer and delegation relationships |
| Types of Delegation Relationships | typescript-sdk/agent-relationships | Sub agent, external agent, and team agent delegation |
| Configuring StopWhen | typescript-sdk/agent-settings | Control stopping conditions to prevent infinite loops in agents |
| Sub Agent Parameters Reference | typescript-sdk/agent-settings | Complete parameter reference for subAgent() configuration |
| CLI inkeep add Command | typescript-sdk/cli-reference | Pull a template project or MCP from the Inkeep Agents Cookbook |
| CLI inkeep config Command | typescript-sdk/cli-reference | Manage Inkeep configuration values |
| CLI Configuration File Structure | typescript-sdk/cli-reference | Structure of inkeep.config.ts and configuration priority |
| CLI inkeep dev Command | typescript-sdk/cli-reference | Start the Inkeep dashboard server for visual agents orchestration |
| CLI Environment Variables | typescript-sdk/cli-reference | Environment variables respected by the CLI and SDK |
| CLI inkeep init Command | typescript-sdk/cli-reference | Initialize a new Inkeep configuration file in your project |
| CLI inkeep list-agents Command | typescript-sdk/cli-reference | List all available agents for a specific project |
| CLI inkeep profile Command | typescript-sdk/cli-reference | Manage named CLI profiles for multiple remotes, credentials, and environments |
| CLI inkeep pull Command | typescript-sdk/cli-reference | Pull project configuration from server and update local TypeScript files |
| CLI inkeep push Command | typescript-sdk/cli-reference | Push agent configurations to your server |
| CLI inkeep update Command | typescript-sdk/cli-reference | Update the Inkeep CLI to the latest version |
| Runtime Limits Configuration | typescript-sdk/configure-runtime-limits | How to configure execution limits, timeouts, and constraints |
| Runtime Configuration Variables | typescript-sdk/configure-runtime-limits | All available environment variables for configuring runtime limits |
| Context Fetchers Overview | typescript-sdk/context-fetchers | How to use context fetchers to embed real-time data in agent prompts |
| Credential Store Options | typescript-sdk/credentials/overview | Options for storing MCP server and external agent credentials |
| Data Operation Types Reference | typescript-sdk/data-operations | All data operation event types and their payloads |
| Data Operations Overview | typescript-sdk/data-operations | How to enable and use data operations for debugging and monitoring |
| External Agents Overview | typescript-sdk/external-agents | How to configure and use external agents using the A2A protocol |
| Passing Context via Headers | typescript-sdk/headers | How to pass dynamic context to agents via HTTP headers |
| Using Headers in Agents | typescript-sdk/headers | How to use header values in prompts, context fetchers, and external tools |
| Conversation Memory Overview | typescript-sdk/memory | How conversation history is managed and included in context windows |
| Model Types Reference | typescript-sdk/models | When to use each model type in the configuration hierarchy |
| Model Provider Options | typescript-sdk/models | Configuration options for different model providers |
| Supported Models Reference | typescript-sdk/models | List of supported model providers and their API keys |
| Defining Artifact Components | typescript-sdk/structured-outputs/artifact-components | How to define artifact components with preview fields for citations and sources |
| Defining Data Components | typescript-sdk/structured-outputs/data-components | How to define data components using Zod schemas |
| Status Updates Configuration | typescript-sdk/structured-outputs/status-updates | How to configure AI-powered status updates for agents |
| Function Tools Execution Environment | typescript-sdk/tools/function-tools | Sandbox providers, runtime configuration, and security guarantees |
| Function Tools Overview | typescript-sdk/tools/function-tools | Use cases and how to create function tools |
| Environment-Aware MCP Servers | typescript-sdk/tools/mcp-tools | Configure MCP tools to switch based on environment (dev vs production) |
| MCP Tool Authentication | typescript-sdk/tools/mcp-tools | Authentication methods for MCP servers including API keys, OAuth, and custom headers |
| MCP Tool Overrides | typescript-sdk/tools/mcp-tools | Customize how individual MCP tools appear to agents |
| Selecting MCP Tools | typescript-sdk/tools/mcp-tools | How to selectively enable tools from MCP servers |
| Registering MCP Servers as Tools | typescript-sdk/tools/mcp-tools | How to register and configure MCP tools for your agents |
| Tool Approvals Configuration | typescript-sdk/tools/tool-approvals | How to configure tools to require user approval before execution |
| Responding to Tool Approval Requests | typescript-sdk/tools/tool-approvals | How to approve or deny tool execution requests |
| Trigger Configuration Options | typescript-sdk/triggers | Configuration options for triggers including authentication, schemas, and transforms |
| Triggers Overview | typescript-sdk/triggers | Creating webhook endpoints to invoke agents from external services |
| Configuration Priority Hierarchy | typescript-sdk/workspace-configuration | How CLI flags, env vars, and config file values are resolved |
| Workspace Configuration File | typescript-sdk/workspace-configuration | Structure and options for inkeep.config.ts |
阅读单个规则文件可获取特定任务或主题的详细说明及代码示例：
| 标题 | 主题 | 描述 |
|---|---|---|
| 子Agent关系概述 | typescript-sdk/agent-relationships | 子Agent之间的转移与委托关系 |
| 何时使用转移 vs 委托 | typescript-sdk/agent-relationships | 选择转移或委托关系的指导原则 |
| 委托关系的类型 | typescript-sdk/agent-relationships | 子Agent、外部Agent和团队Agent委托 |
| 配置StopWhen | typescript-sdk/agent-settings | 控制停止条件以避免Agent陷入无限循环 |
| 子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-agents 命令 | typescript-sdk/cli-reference | 列出特定项目的所有可用Agent |
| 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 |
| 通过Headers传递上下文 | typescript-sdk/headers | 如何通过HTTP Headers向Agent传递动态上下文 |
| 在Agent中使用Headers | typescript-sdk/headers | 如何在提示词、上下文获取器和外部工具中使用Header值 |
| 对话记忆概述 | 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工具以根据环境（开发 vs 生产）切换 |
| MCP工具认证 | typescript-sdk/tools/mcp-tools | MCP服务器的认证方法，包括API密钥、OAuth和自定义Headers |
| 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 | 触发器的配置选项，包括认证、模式和转换 |
| 触发器概述 | typescript-sdk/triggers | 创建Webhook端点以从外部服务调用Agent |
| 配置优先级层级 | typescript-sdk/workspace-configuration | CLI标志、环境变量和配置文件值的解析方式 |
| 工作区配置文件 | typescript-sdk/workspace-configuration | inkeep.config.ts的结构和选项 |
Other Resources
其他资源
For additional information, see:
- Full Documentation: https://docs.inkeep.com/ (llms.txt and llms-full.txt available are available!)
- GitHub Repo (Open Source): https://github.com/inkeep/agents
如需更多信息，请参阅：