Tool Context
ToolContext
dataclass
Bases: RunContextWrapper[TContext]
The context of a tool call.
ソースコード位置: src/agents/tool_context.py
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | |
run_config
class-attribute
instance-attribute
run_config: RunConfig | None = None
The active run config for this tool call, when available.
tool_name
class-attribute
instance-attribute
tool_name: str = (
_assert_must_pass_tool_name()
if tool_name is _MISSING
else cast(str, tool_name)
)
The name of the tool being invoked.
tool_arguments
class-attribute
instance-attribute
tool_arguments: str = (
_assert_must_pass_tool_arguments()
if tool_arguments is _MISSING
else cast(str, tool_arguments)
)
The raw arguments string of the tool call.
tool_call_id
class-attribute
instance-attribute
tool_call_id: str = (
_assert_must_pass_tool_call_id()
if tool_call_id is _MISSING
else cast(str, tool_call_id)
)
The ID of the tool call.
tool_call
class-attribute
instance-attribute
The tool call object associated with this invocation.
tool_namespace
class-attribute
instance-attribute
tool_namespace: str | None = (
tool_namespace
if isinstance(tool_namespace, str)
else get_tool_call_namespace(tool_call)
)
The Responses API namespace for this tool call, when present.
agent
class-attribute
instance-attribute
agent: AgentBase[Any] | None = agent
The active agent for this tool call, when available.
qualified_tool_name
property
Return the tool name qualified by namespace when available.
context
instance-attribute
The context object (or None), passed by you to Runner.run()
usage
class-attribute
instance-attribute
The usage of the agent run so far. For streamed responses, the usage will be stale until the last chunk of the stream is processed.
tool_input
class-attribute
instance-attribute
Structured input for the current agent tool run, when available.
__init__
__init__(
context: TContext,
usage: Usage | object = _MISSING,
tool_name: str | object = _MISSING,
tool_call_id: str | object = _MISSING,
tool_arguments: str | object = _MISSING,
tool_call: ResponseFunctionToolCall | None = None,
*,
tool_namespace: str | None = None,
agent: AgentBase[Any] | None = None,
run_config: RunConfig | dict[str, Any] | None = None,
turn_input: list[TResponseInputItem] | None = None,
_approvals: dict[
str | HostedMCPApprovalKey, _ApprovalRecord
]
| None = None,
tool_input: Any | None = None,
) -> None
Preserve the v0.7 positional constructor while accepting new context fields.
ソースコード位置: src/agents/tool_context.py
approve_tool
approve_tool(
approval_item: ToolApprovalItem,
always_approve: bool = False,
) -> None
Approve this context's call or route a surfaced nested approval to its owner.
ソースコード位置: src/agents/tool_context.py
reject_tool
reject_tool(
approval_item: ToolApprovalItem,
always_reject: bool = False,
rejection_message: str | None = None,
) -> None
Reject this context's call or route a surfaced nested rejection to its owner.
ソースコード位置: src/agents/tool_context.py
from_agent_context
classmethod
from_agent_context(
context: RunContextWrapper[TContext],
tool_call_id: str,
tool_call: ResponseFunctionToolCall | None = None,
agent: AgentBase[Any] | None = None,
*,
tool_name: str | None = None,
tool_arguments: str | None = None,
tool_namespace: str | None = None,
run_config: RunConfig | dict[str, Any] | None = None,
) -> ToolContext
Create a ToolContext from a RunContextWrapper.
ソースコード位置: src/agents/tool_context.py
is_tool_approved
Return True/False/None for the given tool call.
ソースコード位置: src/agents/run_context.py
get_rejection_message
get_rejection_message(
tool_name: str,
call_id: str,
*,
tool_namespace: str | None = None,
existing_pending: ToolApprovalItem | None = None,
tool_lookup_key: FunctionToolLookupKey | None = None,
) -> str | None
Return a stored rejection message for a tool call if one exists.
ソースコード位置: src/agents/run_context.py
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 | |
get_approval_status
get_approval_status(
tool_name: str,
call_id: str,
*,
tool_namespace: str | None = None,
existing_pending: ToolApprovalItem | None = None,
tool_lookup_key: FunctionToolLookupKey | None = None,
current_invocation: ToolApprovalItem | None = None,
) -> bool | None
Return approval status, retrying with pending item's tool name if necessary.
ソースコード位置: src/agents/run_context.py
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 | |