跳转到主要内容

Agent 对象

创建、列表、更新、归档,以及不带 version 参数的 GET /v1/agents/{agent_id} 会返回该结构。
字段类型说明
idstringAgent ID,前缀为 agent_
typestring固定值 "agent"
namestringAgent 名称,长度 1-256 字符
descriptionstringAgent 描述,最长 2048 字符
modelstring模型标识;请求和响应都使用 string
systemstring系统提示词,最长 100000 字符
toolsAgent tool 数组工具配置列表,最多 128 个,默认 []
mcp_serversMCP server 数组MCP server 列表,最多 20 个,默认 []
skillsSkill binding 数组Skill 绑定列表,最多 20 个,默认 []
metadataobjectMetadata 对象,默认 {}
versioninteger当前 Agent 版本号,从 1 开始
archivedboolean是否已归档
archived_atstring | nullUTC 归档时间;未归档时为 null
created_atstringUTC 创建时间
updated_atstringUTC 最后更新时间

Agent version snapshot

version 参数的 GET /v1/agents/{agent_id}GET /v1/agents/{agent_id}/versions 会返回该结构。
字段类型说明
idstringAgent ID,前缀为 agent_
typestring固定值 "agent"
namestringAgent 名称
descriptionstringAgent 描述
modelstring模型标识
systemstring系统提示词
toolsAgent tool 数组工具配置列表
mcp_serversMCP server 数组MCP server 列表
skillsSkill binding 数组Skill 绑定列表
metadataobjectMetadata 对象
versioninteger当前快照对应的版本号
archived_atstring | nullUTC 归档时间;该快照未归档时为 null
created_atstringAgent 的 UTC 创建时间
updated_atstring该快照对应的 UTC 最后更新时间

Agent tool

tools[] 通过 type 区分不同结构。
字段类型适用类型说明
typestring全部必填。可选值:agent_toolset_20260401mcp_toolsetcustom
enabled_toolsstring 数组agent_toolset_20260401内置工具白名单。非空数组表示严格白名单;省略或传 [] 时使用默认内置工具集,并继续叠加 disallowed_toolsconfigs[].enabled。取值必须使用下方列出的内置工具名
disallowed_toolsstring 数组agent_toolset_20260401要隐藏并拒绝的内置工具,取值必须使用下方列出的内置工具名。同一工具不能同时出现在 enabled_toolsdisallowed_tools
configsTool config 数组agent_toolset_20260401mcp_toolset单工具启用状态和权限规则。逐个工具的权限在这里通过 permission_policy 配置
mcp_server_namestringmcp_toolset必填。必须匹配某个 mcp_servers[].name
namestringcustom必填的自定义工具名。不能与内置工具重名,也不能以 mcp__ 开头
descriptionstringcustom必填的自定义工具描述
input_schemaobjectcustom必填的 JSON Schema 对象,input_schema.type 必须为 "object"
custom 工具不支持 permission_policy;权限需要通过 agent_toolset_20260401mcp_toolsetconfigs[].permission_policy 配置。

内置工具名

支持以下内置工具名:
工具名
Bash
DeliverArtifacts
Edit
Glob
Grep
Read
WebFetch
WebSearch
Write

Tool config

用于 tools[].configs[]
字段类型必填说明
namestring要配置的工具名。agent_toolset_20260401 使用内置工具名;mcp_toolset 使用该 MCP server 暴露的原始工具名
enabledbooleanfalse 表示隐藏并拒绝该工具;true 表示显式启用该工具
permission_policyPermission policy该工具的运行时权限行为

Permission policy

字段类型必填说明
typestring可选值:always_allowalways_askalways_deny
always_allow 表示直接执行;always_ask 表示暂停并等待 user.tool_confirmationalways_deny 表示返回被拒绝的工具结果。

MCP server

用于 mcp_servers[]
字段类型必填说明
namestringAgent 内唯一的 MCP server 名称
typestring支持值:"http"
urlstringStreamable HTTP MCP endpoint URL
MCP server 鉴权通过 Vault 配置。

Skill binding

用于 skills[]
字段类型必填说明
typestring可选值:qodercustom
skill_idstringSkill 标识
versionstring可选的非空版本字符串

相关

定义 Agent

创建可复用、可版本化的 Agent 配置。