use crate::product::agent::features::Feature;
use crate::product::agent::features::Features;
use crate::product::agent::tools::handlers::PLAN_TOOL;
use crate::product::agent::tools::handlers::apply_patch::create_apply_patch_freeform_tool;
use crate::product::agent::tools::handlers::apply_patch::create_apply_patch_json_tool;
use crate::product::agent::tools::handlers::delegated_jobs::DEFAULT_WAIT_TIMEOUT_MS;
use crate::product::agent::tools::handlers::delegated_jobs::MAX_WAIT_TIMEOUT_MS;
use crate::product::agent::tools::handlers::delegated_jobs::MIN_WAIT_TIMEOUT_MS;
use crate::product::agent::tools::registry::ToolHandler;
use crate::product::agent::tools::registry::ToolRegistryBuilder;
use crate::product::protocol::config_types::IdentityKind;
use crate::product::protocol::config_types::WebSearchMode;
use crate::product::protocol::dynamic_tools::DynamicToolSpec;
use crate::product::protocol::models::VIEW_IMAGE_TOOL_NAME;
use crate::product::protocol::openai_models::ApplyPatchToolType;
use crate::product::protocol::openai_models::ConfigShellToolType;
use crate::product::protocol::openai_models::ModelInfo;
use crate::product::protocol::protocol::SessionSource;
use lha_llm::FunctionToolDescriptor as ResponsesApiTool;
use lha_llm::ToolDescriptor;
use serde::Deserialize;
use serde::Serialize;
use serde_json::Value as JsonValue;
use serde_json::json;
use std::collections::BTreeMap;
use std::collections::BTreeSet;
use std::collections::HashMap;
use std::sync::Arc;
pub use lha_llm::ToolInputSchema as JsonSchema;
#[cfg_attr(not(test), allow(dead_code))]
pub type AdditionalProperties = lha_llm::AdditionalProperties;
#[derive(Debug, Clone)]
pub(crate) struct ToolsConfig {
pub enforce_declared_tool_names: bool,
pub restrict_tool_specs_to_functions: bool,
pub shell_type: ConfigShellToolType,
pub apply_patch_tool_type: Option<ApplyPatchToolType>,
pub web_search_mode: Option<WebSearchMode>,
pub delegated_job_tools: bool,
pub identity_tools: bool,
pub goal_tools: bool,
pub image_generation_tools: bool,
pub memory_tools: bool,
pub request_rule_enabled: bool,
pub experimental_supported_tools: Vec<String>,
pub workflow_tools: bool,
pub workflow_allowed_tools: Option<BTreeSet<String>>,
pub identity_kind: IdentityKind,
}
pub(crate) struct ToolsConfigParams<'a> {
pub(crate) model_info: &'a ModelInfo,
pub(crate) declared_tool_contract: bool,
pub(crate) features: &'a Features,
pub(crate) web_search_mode: Option<WebSearchMode>,
pub(crate) image_generation_tools: bool,
pub(crate) memory_tools: bool,
#[allow(dead_code)]
pub(crate) session_source: SessionSource,
}
impl ToolsConfig {
pub fn new(params: &ToolsConfigParams) -> Self {
let ToolsConfigParams {
model_info,
declared_tool_contract,
features,
web_search_mode,
image_generation_tools,
memory_tools,
session_source: _,
} = params;
let include_apply_patch_tool = features.enabled(Feature::ApplyPatchFreeform);
let include_delegated_job_tools = features.enabled(Feature::AgentJobs);
let include_identity_tools = features.enabled(Feature::Identities);
let include_goal_tools = features.enabled(Feature::Goals);
let request_rule_enabled = features.enabled(Feature::RequestRule);
let shell_type = if !features.enabled(Feature::ShellTool) {
ConfigShellToolType::Disabled
} else if features.enabled(Feature::UnifiedExec) {
if crate::product::utils_pty::conpty_supported() {
ConfigShellToolType::UnifiedExec
} else {
ConfigShellToolType::ShellCommand
}
} else {
model_info.shell_type
};
let apply_patch_tool_type = match model_info.apply_patch_tool_type {
Some(ApplyPatchToolType::Freeform) => Some(ApplyPatchToolType::Freeform),
Some(ApplyPatchToolType::Function) => Some(ApplyPatchToolType::Function),
None => {
if include_apply_patch_tool {
Some(ApplyPatchToolType::Freeform)
} else {
None
}
}
};
Self {
enforce_declared_tool_names: *declared_tool_contract,
restrict_tool_specs_to_functions: *declared_tool_contract,
shell_type,
apply_patch_tool_type,
web_search_mode: *web_search_mode,
delegated_job_tools: include_delegated_job_tools,
identity_tools: include_identity_tools,
goal_tools: include_goal_tools,
image_generation_tools: *image_generation_tools,
memory_tools: *memory_tools,
request_rule_enabled,
experimental_supported_tools: model_info.experimental_supported_tools.clone(),
workflow_tools: false,
workflow_allowed_tools: None,
identity_kind: IdentityKind::Nobody,
}
}
pub fn with_workflow_tools(mut self, allowed_tools: Option<BTreeSet<String>>) -> Self {
self.workflow_tools = true;
self.workflow_allowed_tools = allowed_tools;
self
}
pub fn with_identity_kind(mut self, identity_kind: IdentityKind) -> Self {
self.identity_kind = identity_kind;
self
}
}
fn tool_is_exposed_for_runtime(config: &ToolsConfig, spec: &ToolDescriptor) -> bool {
let allowed_by_runtime =
!config.restrict_tool_specs_to_functions || matches!(spec, ToolDescriptor::Function(_));
allowed_by_runtime && tool_name_is_allowed_for_runtime(config, spec.name())
}
fn tool_name_is_allowed_for_runtime(config: &ToolsConfig, name: &str) -> bool {
let allowed_by_workflow = config
.workflow_allowed_tools
.as_ref()
.is_none_or(|allowed| allowed.contains(name));
allowed_by_workflow && tool_name_is_allowed_by_identity(config, name)
}
fn tool_name_is_allowed_by_identity(config: &ToolsConfig, name: &str) -> bool {
if matches!(name, "get_goal" | "create_goal" | "update_goal")
&& config.identity_kind != IdentityKind::Programmer
{
return false;
}
match config.identity_kind {
IdentityKind::Explorer => matches!(
name,
"read_file"
| "list_dir"
| "grep_files"
| "memories__list"
| "memories__read"
| "memories__search"
),
IdentityKind::Reviewer => matches!(
name,
"read_file"
| "list_dir"
| "grep_files"
| "exec_command"
| "shell"
| "local_shell"
| "shell_command"
| "container.exec"
| "spawn_agent"
| "wait"
| "close_agent"
| "memories__list"
| "memories__read"
| "memories__search"
),
IdentityKind::Nobody | IdentityKind::Planner | IdentityKind::Programmer => true,
}
}
fn maybe_push_spec(builder: &mut ToolRegistryBuilder, config: &ToolsConfig, spec: ToolDescriptor) {
if tool_is_exposed_for_runtime(config, &spec) {
builder.push_spec(spec);
}
}
fn maybe_push_spec_and_register_handler<H>(
builder: &mut ToolRegistryBuilder,
config: &ToolsConfig,
spec: ToolDescriptor,
name: impl Into<String>,
handler: Arc<H>,
) where
H: ToolHandler + 'static,
{
if tool_is_exposed_for_runtime(config, &spec) {
builder.push_spec(spec);
builder.register_handler(name, handler);
}
}
fn maybe_push_spec_with_parallel_support_and_register_handler<H>(
builder: &mut ToolRegistryBuilder,
config: &ToolsConfig,
spec: ToolDescriptor,
parallel: bool,
name: impl Into<String>,
handler: Arc<H>,
) where
H: ToolHandler + 'static,
{
if tool_is_exposed_for_runtime(config, &spec) {
builder.push_spec_with_parallel_support(spec, parallel);
builder.register_handler(name, handler);
}
}
fn maybe_register_handler<H>(
builder: &mut ToolRegistryBuilder,
config: &ToolsConfig,
name: &'static str,
handler: Arc<H>,
) where
H: ToolHandler + 'static,
{
if tool_name_is_allowed_for_runtime(config, name) {
builder.register_handler(name, handler);
}
}
fn create_approval_parameters(include_prefix_rule: bool) -> BTreeMap<String, JsonSchema> {
let mut properties = BTreeMap::from([
(
"sandbox_permissions".to_string(),
JsonSchema::String {
description: Some(
"Sandbox permissions for the command. Set to \"require_escalated\" to request running without sandbox restrictions; defaults to \"use_default\"."
.to_string(),
),
enum_values: None,
},
),
(
"justification".to_string(),
JsonSchema::String {
description: Some(
r#"Only set if sandbox_permissions is \"require_escalated\".
Request approval from the user to run this command outside the sandbox.
Phrased as a simple question that summarizes the purpose of the
command as it relates to the task at hand - e.g. 'Do you want to
fetch and pull the latest version of this git branch?'"#
.to_string(),
),
enum_values: None,
},
),
]);
if include_prefix_rule {
properties.insert(
"prefix_rule".to_string(),
JsonSchema::Array {
items: Box::new(JsonSchema::String { description: None, enum_values: None }),
description: Some(
r#"Only specify when sandbox_permissions is `require_escalated`.
Suggest a prefix command pattern that will allow you to fulfill similar requests from the user in the future.
Should be a short but reasonable prefix, e.g. [\"git\", \"pull\"] or [\"uv\", \"run\"] or [\"pytest\"]."#.to_string(),
),
});
}
properties
}
fn create_exec_command_tool(include_prefix_rule: bool) -> ToolDescriptor {
let mut properties = BTreeMap::from([
(
"cmd".to_string(),
JsonSchema::String {
description: Some("Shell command to execute.".to_string()),
enum_values: None,
},
),
(
"workdir".to_string(),
JsonSchema::String {
description: Some(
"Optional working directory to run the command in; defaults to the turn cwd."
.to_string(),
),
enum_values: None,
},
),
(
"shell".to_string(),
JsonSchema::String {
description: Some("Shell binary to launch. Defaults to the user's default shell.".to_string()),
enum_values: None,
},
),
(
"login".to_string(),
JsonSchema::Boolean {
description: Some(
"Whether to run the shell with -l/-i semantics. Defaults to true.".to_string(),
),
},
),
(
"tty".to_string(),
JsonSchema::Boolean {
description: Some(
"Whether to allocate a TTY for the command. Defaults to false (plain pipes); set to true to open a PTY and access TTY process."
.to_string(),
),
}
),
(
"yield_time_ms".to_string(),
JsonSchema::Number {
description: Some(
"How long to wait (in milliseconds) for output before yielding.".to_string(),
),
},
),
(
"max_output_tokens".to_string(),
JsonSchema::Number {
description: Some(
"Maximum number of tokens to return. Excess output will be truncated."
.to_string(),
),
},
),
]);
properties.extend(create_approval_parameters(include_prefix_rule));
ToolDescriptor::Function(ResponsesApiTool {
name: "exec_command".to_string(),
description:
"Runs a command in a PTY, returning output or a session ID for ongoing interaction."
.to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["cmd".to_string()]),
additional_properties: Some(false.into()),
},
})
}
fn create_write_stdin_tool() -> ToolDescriptor {
let properties = BTreeMap::from([
(
"session_id".to_string(),
JsonSchema::Number {
description: Some("Identifier of the running unified exec session.".to_string()),
},
),
(
"chars".to_string(),
JsonSchema::String {
description: Some(
"Bytes to write to stdin. Pass an empty string to poll process output without writing to stdin; use this for long-running commands."
.to_string(),
),
enum_values: None,
},
),
(
"yield_time_ms".to_string(),
JsonSchema::Number {
description: Some(
"How long to wait (in milliseconds) for output before yielding.".to_string(),
),
},
),
(
"max_output_tokens".to_string(),
JsonSchema::Number {
description: Some(
"Maximum number of tokens to return. Excess output will be truncated."
.to_string(),
),
},
),
]);
ToolDescriptor::Function(ResponsesApiTool {
name: "write_stdin".to_string(),
description: "Writes characters to an existing unified exec session and returns recent output. Calling with empty `chars` intentionally polls process output; it is not a no-op or accidental tool call.".to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["session_id".to_string()]),
additional_properties: Some(false.into()),
},
})
}
fn create_shell_tool(include_prefix_rule: bool) -> ToolDescriptor {
let mut properties = BTreeMap::from([
(
"command".to_string(),
JsonSchema::Array {
items: Box::new(JsonSchema::String {
description: None,
enum_values: None,
}),
description: Some("The command to execute".to_string()),
},
),
(
"workdir".to_string(),
JsonSchema::String {
description: Some("The working directory to execute the command in".to_string()),
enum_values: None,
},
),
(
"timeout_ms".to_string(),
JsonSchema::Number {
description: Some("The timeout for the command in milliseconds".to_string()),
},
),
]);
properties.extend(create_approval_parameters(include_prefix_rule));
let description = if cfg!(windows) {
r#"Runs a Powershell command (Windows) and returns its output. Arguments to `shell` will be passed to CreateProcessW(). Most commands should be prefixed with ["powershell.exe", "-Command"].
Examples of valid command strings:
- ls -a (show hidden): ["powershell.exe", "-Command", "Get-ChildItem -Force"]
- recursive find by name: ["powershell.exe", "-Command", "Get-ChildItem -Recurse -Filter *.py"]
- recursive grep: ["powershell.exe", "-Command", "Get-ChildItem -Path C:\\myrepo -Recurse | Select-String -Pattern 'TODO' -CaseSensitive"]
- ps aux | grep python: ["powershell.exe", "-Command", "Get-Process | Where-Object { $_.ProcessName -like '*python*' }"]
- setting an env var: ["powershell.exe", "-Command", "$env:FOO='bar'; echo $env:FOO"]
- running an inline Python script: ["powershell.exe", "-Command", "@'\\nprint('Hello, world!')\\n'@ | python -"]"#
} else {
r#"Runs a shell command and returns its output.
- The arguments to `shell` will be passed to execvp(). Most terminal commands should be prefixed with ["bash", "-lc"].
- Always set the `workdir` param when using the shell function. Do not use `cd` unless absolutely necessary."#
}.to_string();
ToolDescriptor::Function(ResponsesApiTool {
name: "shell".to_string(),
description,
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["command".to_string()]),
additional_properties: Some(false.into()),
},
})
}
fn create_local_shell_tool(include_prefix_rule: bool) -> ToolDescriptor {
let ToolDescriptor::Function(mut tool) = create_shell_tool(include_prefix_rule) else {
unreachable!("shell tool must be a function descriptor");
};
tool.name = "local_shell".to_string();
tool.description = "Execute a local shell command.".to_string();
ToolDescriptor::Function(tool)
}
fn create_shell_command_tool(include_prefix_rule: bool) -> ToolDescriptor {
let mut properties = BTreeMap::from([
(
"command".to_string(),
JsonSchema::String {
description: Some(
"The shell script to execute in the user's default shell".to_string(),
),
enum_values: None,
},
),
(
"workdir".to_string(),
JsonSchema::String {
description: Some("The working directory to execute the command in".to_string()),
enum_values: None,
},
),
(
"login".to_string(),
JsonSchema::Boolean {
description: Some(
"Whether to run the shell with login shell semantics. Defaults to true."
.to_string(),
),
},
),
(
"timeout_ms".to_string(),
JsonSchema::Number {
description: Some("The timeout for the command in milliseconds".to_string()),
},
),
]);
properties.extend(create_approval_parameters(include_prefix_rule));
let description = if cfg!(windows) {
r#"Runs a Powershell command (Windows) and returns its output.
Examples of valid command strings:
- ls -a (show hidden): "Get-ChildItem -Force"
- recursive find by name: "Get-ChildItem -Recurse -Filter *.py"
- recursive grep: "Get-ChildItem -Path C:\\myrepo -Recurse | Select-String -Pattern 'TODO' -CaseSensitive"
- ps aux | grep python: "Get-Process | Where-Object { $_.ProcessName -like '*python*' }"
- setting an env var: "$env:FOO='bar'; echo $env:FOO"
- running an inline Python script: "@'\\nprint('Hello, world!')\\n'@ | python -"#
} else {
r#"Runs a shell command and returns its output.
- Always set the `workdir` param when using the shell_command function. Do not use `cd` unless absolutely necessary."#
}.to_string();
ToolDescriptor::Function(ResponsesApiTool {
name: "shell_command".to_string(),
description,
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["command".to_string()]),
additional_properties: Some(false.into()),
},
})
}
fn create_view_image_tool() -> ToolDescriptor {
let properties = BTreeMap::from([(
"path".to_string(),
JsonSchema::String {
description: Some("Local filesystem path to an image file".to_string()),
enum_values: None,
},
)]);
ToolDescriptor::Function(ResponsesApiTool {
name: VIEW_IMAGE_TOOL_NAME.to_string(),
description: "View a local image from the filesystem (only use if given a full filepath by the user, and the image isn't already attached to the thread context within <image ...> tags)."
.to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["path".to_string()]),
additional_properties: Some(false.into()),
},
})
}
fn create_imagegen_tool() -> ToolDescriptor {
let properties = BTreeMap::from([
(
"prompt".to_string(),
JsonSchema::String {
description: Some("Rewritten prompt for image generation or editing.".to_string()),
enum_values: None,
},
),
(
"action".to_string(),
JsonSchema::String {
description: Some(
"Use generate for new images and edit when modifying image context from the conversation."
.to_string(),
),
enum_values: Some(vec!["generate".to_string(), "edit".to_string()]),
},
),
]);
ToolDescriptor::Function(ResponsesApiTool {
name: "imagegen".to_string(),
description: include_str!("handlers/imagegen_description.md").to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["prompt".to_string(), "action".to_string()]),
additional_properties: Some(false.into()),
},
})
}
fn create_spawn_agent_tool(_config: &ToolsConfig) -> ToolDescriptor {
let properties = BTreeMap::from([
(
"message".to_string(),
JsonSchema::String {
description: Some("Plain-text task for the isolated exploration job.".to_string()),
enum_values: None,
},
),
(
"agent_type".to_string(),
JsonSchema::String {
description: Some("Delegated job type. Only `explorer` is supported.".to_string()),
enum_values: None,
},
),
(
"max_runtime_seconds".to_string(),
JsonSchema::Number {
description: Some(
"Optional maximum runtime in seconds for the delegated job, capped by agents.job_max_runtime_seconds.".to_string(),
),
},
),
]);
ToolDescriptor::Function(ResponsesApiTool {
name: "spawn_agent".to_string(),
description:
"Start an isolated one-shot exploration job. Use this for specific codebase questions when the final result is useful but the exploration process should stay out of the main context."
.to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["message".to_string()]),
additional_properties: Some(false.into()),
},
})
}
fn create_goal_tools() -> Vec<ToolDescriptor> {
let objective_schema = JsonSchema::String {
description: Some("The goal objective.".to_string()),
enum_values: None,
};
let status_schema = JsonSchema::String {
description: Some("One of: complete, blocked.".to_string()),
enum_values: None,
};
vec![
ToolDescriptor::Function(ResponsesApiTool {
name: "get_goal".to_string(),
description: "Get the current long-running programmer goal for this thread."
.to_string(),
strict: false,
parameters: JsonSchema::Object {
properties: BTreeMap::new(),
required: Some(Vec::new()),
additional_properties: Some(false.into()),
},
}),
ToolDescriptor::Function(ResponsesApiTool {
name: "create_goal".to_string(),
description: "Create a long-running programmer goal when no unfinished goal exists."
.to_string(),
strict: false,
parameters: JsonSchema::Object {
properties: BTreeMap::from([("objective".to_string(), objective_schema)]),
required: Some(vec!["objective".to_string()]),
additional_properties: Some(false.into()),
},
}),
ToolDescriptor::Function(ResponsesApiTool {
name: "update_goal".to_string(),
description: "Mark the current programmer goal complete or blocked.".to_string(),
strict: false,
parameters: JsonSchema::Object {
properties: BTreeMap::from([("status".to_string(), status_schema)]),
required: Some(vec!["status".to_string()]),
additional_properties: Some(false.into()),
},
}),
]
}
fn create_wait_tool() -> ToolDescriptor {
let mut properties = BTreeMap::new();
properties.insert(
"ids".to_string(),
JsonSchema::Array {
items: Box::new(JsonSchema::String { description: None, enum_values: None }),
description: Some(
"Delegated job ids to wait on. Pass multiple ids to wait for all requested jobs or until timeout."
.to_string(),
),
},
);
properties.insert(
"timeout_ms".to_string(),
JsonSchema::Number {
description: Some(format!(
"Optional timeout in milliseconds. Defaults to {DEFAULT_WAIT_TIMEOUT_MS}, min {MIN_WAIT_TIMEOUT_MS}, max {MAX_WAIT_TIMEOUT_MS}. Prefer longer waits (minutes) to avoid busy polling."
)),
},
);
ToolDescriptor::Function(ResponsesApiTool {
name: "wait".to_string(),
description: "Wait for delegated jobs to reach a final status, or until timeout. Completed statuses include the final result."
.to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["ids".to_string()]),
additional_properties: Some(false.into()),
},
})
}
fn create_request_user_input_tool() -> ToolDescriptor {
let mut option_props = BTreeMap::new();
option_props.insert(
"label".to_string(),
JsonSchema::String {
description: Some("User-facing label (1-5 words).".to_string()),
enum_values: None,
},
);
option_props.insert(
"description".to_string(),
JsonSchema::String {
description: Some(
"One short sentence explaining impact/tradeoff if selected.".to_string(),
),
enum_values: None,
},
);
let options_schema = JsonSchema::Array {
description: Some(
"Provide 2-3 mutually exclusive choices. Put the recommended option first and suffix its label with \"(Recommended)\". Do not include an \"Other\" option in this list; the client will add a free-form \"Other\" option automatically."
.to_string(),
),
items: Box::new(JsonSchema::Object {
properties: option_props,
required: Some(vec!["label".to_string(), "description".to_string()]),
additional_properties: Some(false.into()),
}),
};
let mut question_props = BTreeMap::new();
question_props.insert(
"id".to_string(),
JsonSchema::String {
description: Some("Stable identifier for mapping answers (snake_case).".to_string()),
enum_values: None,
},
);
question_props.insert(
"header".to_string(),
JsonSchema::String {
description: Some(
"Short header label shown in the UI (12 or fewer chars).".to_string(),
),
enum_values: None,
},
);
question_props.insert(
"question".to_string(),
JsonSchema::String {
description: Some("Single-sentence prompt shown to the user.".to_string()),
enum_values: None,
},
);
question_props.insert("options".to_string(), options_schema);
let questions_schema = JsonSchema::Array {
description: Some("Questions to show the user. Prefer 1 and do not exceed 3".to_string()),
items: Box::new(JsonSchema::Object {
properties: question_props,
required: Some(vec![
"id".to_string(),
"header".to_string(),
"question".to_string(),
"options".to_string(),
]),
additional_properties: Some(false.into()),
}),
};
let mut properties = BTreeMap::new();
properties.insert("questions".to_string(), questions_schema);
ToolDescriptor::Function(ResponsesApiTool {
name: "request_user_input".to_string(),
description:
"Request user input for one to three short questions and wait for the response."
.to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["questions".to_string()]),
additional_properties: Some(false.into()),
},
})
}
fn create_close_agent_tool() -> ToolDescriptor {
let mut properties = BTreeMap::new();
properties.insert(
"id".to_string(),
JsonSchema::String {
description: Some("Delegated job id to cancel (from spawn_agent).".to_string()),
enum_values: None,
},
);
ToolDescriptor::Function(ResponsesApiTool {
name: "close_agent".to_string(),
description: "Cancel a delegated job and return its last known status.".to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["id".to_string()]),
additional_properties: Some(false.into()),
},
})
}
fn create_test_sync_tool() -> ToolDescriptor {
let barrier_properties = BTreeMap::from([
(
"id".to_string(),
JsonSchema::String {
description: Some(
"Identifier shared by concurrent calls that should rendezvous".to_string(),
),
enum_values: None,
},
),
(
"participants".to_string(),
JsonSchema::Number {
description: Some(
"Number of tool calls that must arrive before the barrier opens".to_string(),
),
},
),
(
"timeout_ms".to_string(),
JsonSchema::Number {
description: Some(
"Maximum time in milliseconds to wait at the barrier".to_string(),
),
},
),
]);
let properties = BTreeMap::from([
(
"sleep_before_ms".to_string(),
JsonSchema::Number {
description: Some(
"Optional delay in milliseconds before any other action".to_string(),
),
},
),
(
"sleep_after_ms".to_string(),
JsonSchema::Number {
description: Some(
"Optional delay in milliseconds after completing the barrier".to_string(),
),
},
),
(
"barrier".to_string(),
JsonSchema::Object {
properties: barrier_properties,
required: Some(vec!["id".to_string(), "participants".to_string()]),
additional_properties: Some(false.into()),
},
),
]);
ToolDescriptor::Function(ResponsesApiTool {
name: "test_sync_tool".to_string(),
description: "Internal synchronization helper used by LHA integration tests.".to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: None,
additional_properties: Some(false.into()),
},
})
}
fn create_grep_files_tool() -> ToolDescriptor {
let properties = BTreeMap::from([
(
"pattern".to_string(),
JsonSchema::String {
description: Some("Regular expression pattern to search for.".to_string()),
enum_values: None,
},
),
(
"include".to_string(),
JsonSchema::String {
description: Some(
"Optional glob that limits which files are searched (e.g. \"*.rs\" or \
\"*.{ts,tsx}\")."
.to_string(),
),
enum_values: None,
},
),
(
"path".to_string(),
JsonSchema::String {
description: Some(
"Directory or file path to search. Defaults to the session's working directory."
.to_string(),
),
enum_values: None,
},
),
(
"limit".to_string(),
JsonSchema::Number {
description: Some(
"Maximum number of file paths to return (defaults to 100).".to_string(),
),
},
),
]);
ToolDescriptor::Function(ResponsesApiTool {
name: "grep_files".to_string(),
description: "Finds files whose contents match the pattern and lists them by modification \
time."
.to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["pattern".to_string()]),
additional_properties: Some(false.into()),
},
})
}
fn create_read_file_tool() -> ToolDescriptor {
let indentation_properties = BTreeMap::from([
(
"anchor_line".to_string(),
JsonSchema::Number {
description: Some(
"Anchor line to center the indentation lookup on (defaults to offset)."
.to_string(),
),
},
),
(
"max_levels".to_string(),
JsonSchema::Number {
description: Some(
"How many parent indentation levels (smaller indents) to include.".to_string(),
),
},
),
(
"include_siblings".to_string(),
JsonSchema::Boolean {
description: Some(
"When true, include additional blocks that share the anchor indentation."
.to_string(),
),
},
),
(
"include_header".to_string(),
JsonSchema::Boolean {
description: Some(
"Include doc comments or attributes directly above the selected block."
.to_string(),
),
},
),
(
"max_lines".to_string(),
JsonSchema::Number {
description: Some(
"Hard cap on the number of lines returned when using indentation mode."
.to_string(),
),
},
),
]);
let properties = BTreeMap::from([
(
"file_path".to_string(),
JsonSchema::String {
description: Some("Absolute path to the file".to_string()),
enum_values: None,
},
),
(
"offset".to_string(),
JsonSchema::Number {
description: Some(
"The line number to start reading from. Must be 1 or greater.".to_string(),
),
},
),
(
"limit".to_string(),
JsonSchema::Number {
description: Some("The maximum number of lines to return.".to_string()),
},
),
(
"mode".to_string(),
JsonSchema::String {
description: Some(
"Optional mode selector: \"slice\" for simple ranges (default) or \"indentation\" \
to expand around an anchor line."
.to_string(),
),
enum_values: None,
},
),
(
"indentation".to_string(),
JsonSchema::Object {
properties: indentation_properties,
required: None,
additional_properties: Some(false.into()),
},
),
]);
ToolDescriptor::Function(ResponsesApiTool {
name: "read_file".to_string(),
description:
"Reads a local file with 1-indexed line numbers, supporting slice and indentation-aware block modes."
.to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["file_path".to_string()]),
additional_properties: Some(false.into()),
},
})
}
fn create_list_dir_tool() -> ToolDescriptor {
let properties = BTreeMap::from([
(
"dir_path".to_string(),
JsonSchema::String {
description: Some("Absolute path to the directory to list.".to_string()),
enum_values: None,
},
),
(
"offset".to_string(),
JsonSchema::Number {
description: Some(
"The entry number to start listing from. Must be 1 or greater.".to_string(),
),
},
),
(
"limit".to_string(),
JsonSchema::Number {
description: Some("The maximum number of entries to return.".to_string()),
},
),
(
"depth".to_string(),
JsonSchema::Number {
description: Some(
"The maximum directory depth to traverse. Must be 1 or greater.".to_string(),
),
},
),
]);
ToolDescriptor::Function(ResponsesApiTool {
name: "list_dir".to_string(),
description:
"Lists entries in a local directory with 1-indexed entry numbers and simple type labels."
.to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["dir_path".to_string()]),
additional_properties: Some(false.into()),
},
})
}
fn create_memory_tools() -> Vec<ToolDescriptor> {
vec![
ToolDescriptor::Function(ResponsesApiTool {
name: "memories__list".to_string(),
description: "List files and directories under the local LHA memory folder.".to_string(),
strict: false,
parameters: JsonSchema::Object {
properties: BTreeMap::from([
(
"path".to_string(),
JsonSchema::String {
description: Some(
"Relative directory under the memory root; defaults to root."
.to_string(),
),
enum_values: None,
},
),
(
"cursor".to_string(),
JsonSchema::Number {
description: Some("Pagination cursor returned by the previous call.".to_string()),
},
),
(
"limit".to_string(),
JsonSchema::Number {
description: Some("Maximum number of entries to return.".to_string()),
},
),
]),
required: None,
additional_properties: Some(false.into()),
},
}),
ToolDescriptor::Function(ResponsesApiTool {
name: "memories__read".to_string(),
description: "Read a file under the local LHA memory folder by relative path."
.to_string(),
strict: false,
parameters: JsonSchema::Object {
properties: BTreeMap::from([
(
"path".to_string(),
JsonSchema::String {
description: Some("Relative file path under the memory root.".to_string()),
enum_values: None,
},
),
(
"offset".to_string(),
JsonSchema::Number {
description: Some("1-indexed starting line; defaults to 1.".to_string()),
},
),
(
"limit".to_string(),
JsonSchema::Number {
description: Some("Maximum number of lines to return.".to_string()),
},
),
]),
required: Some(vec!["path".to_string()]),
additional_properties: Some(false.into()),
},
}),
ToolDescriptor::Function(ResponsesApiTool {
name: "memories__search".to_string(),
description: "Search text files under the local LHA memory folder.".to_string(),
strict: false,
parameters: JsonSchema::Object {
properties: BTreeMap::from([
(
"query".to_string(),
JsonSchema::String {
description: Some("Case-insensitive substring to search for.".to_string()),
enum_values: None,
},
),
(
"path".to_string(),
JsonSchema::String {
description: Some(
"Relative file or directory under the memory root; defaults to root."
.to_string(),
),
enum_values: None,
},
),
(
"cursor".to_string(),
JsonSchema::Number {
description: Some("Pagination cursor returned by the previous call.".to_string()),
},
),
(
"limit".to_string(),
JsonSchema::Number {
description: Some("Maximum number of matches to return.".to_string()),
},
),
]),
required: Some(vec!["query".to_string()]),
additional_properties: Some(false.into()),
},
}),
ToolDescriptor::Function(ResponsesApiTool {
name: "memories__add_ad_hoc_note".to_string(),
description:
"Add a small ad-hoc memory note when the user explicitly asks to remember something."
.to_string(),
strict: false,
parameters: JsonSchema::Object {
properties: BTreeMap::from([
(
"content".to_string(),
JsonSchema::String {
description: Some("Markdown note content to add.".to_string()),
enum_values: None,
},
),
(
"slug".to_string(),
JsonSchema::String {
description: Some("Short filename slug; sanitized to lowercase ASCII.".to_string()),
enum_values: None,
},
),
]),
required: Some(vec!["content".to_string()]),
additional_properties: Some(false.into()),
},
}),
]
}
fn create_list_mcp_resources_tool() -> ToolDescriptor {
let properties = BTreeMap::from([
(
"server".to_string(),
JsonSchema::String {
description: Some(
"Optional MCP server name. When omitted, lists resources from every configured server."
.to_string(),
),
enum_values: None,
},
),
(
"cursor".to_string(),
JsonSchema::String {
description: Some(
"Opaque cursor returned by a previous list_mcp_resources call for the same server."
.to_string(),
),
enum_values: None,
},
),
]);
ToolDescriptor::Function(ResponsesApiTool {
name: "list_mcp_resources".to_string(),
description: "Lists resources provided by MCP servers. Resources allow servers to share data that provides context to language models, such as files, database schemas, or application-specific information. Prefer resources over web search when possible.".to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: None,
additional_properties: Some(false.into()),
},
})
}
fn create_list_mcp_resource_templates_tool() -> ToolDescriptor {
let properties = BTreeMap::from([
(
"server".to_string(),
JsonSchema::String {
description: Some(
"Optional MCP server name. When omitted, lists resource templates from all configured servers."
.to_string(),
),
enum_values: None,
},
),
(
"cursor".to_string(),
JsonSchema::String {
description: Some(
"Opaque cursor returned by a previous list_mcp_resource_templates call for the same server."
.to_string(),
),
enum_values: None,
},
),
]);
ToolDescriptor::Function(ResponsesApiTool {
name: "list_mcp_resource_templates".to_string(),
description: "Lists resource templates provided by MCP servers. Parameterized resource templates allow servers to share data that takes parameters and provides context to language models, such as files, database schemas, or application-specific information. Prefer resource templates over web search when possible.".to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: None,
additional_properties: Some(false.into()),
},
})
}
fn create_read_mcp_resource_tool() -> ToolDescriptor {
let properties = BTreeMap::from([
(
"server".to_string(),
JsonSchema::String {
description: Some(
"MCP server name exactly as configured. Must match the 'server' field returned by list_mcp_resources."
.to_string(),
),
enum_values: None,
},
),
(
"uri".to_string(),
JsonSchema::String {
description: Some(
"Resource URI to read. Must be one of the URIs returned by list_mcp_resources."
.to_string(),
),
enum_values: None,
},
),
]);
ToolDescriptor::Function(ResponsesApiTool {
name: "read_mcp_resource".to_string(),
description:
"Read a specific resource from an MCP server given the server name and resource URI."
.to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: Some(vec!["server".to_string(), "uri".to_string()]),
additional_properties: Some(false.into()),
},
})
}
#[derive(Serialize, Deserialize)]
pub(crate) struct ApplyPatchToolArgs {
pub(crate) input: String,
}
#[allow(dead_code)]
pub fn create_tools_json_for_responses_api(
tools: &[ToolDescriptor],
) -> crate::product::agent::error::Result<Vec<serde_json::Value>> {
tools
.iter()
.map(serde_json::to_value)
.collect::<std::result::Result<Vec<_>, _>>()
.map_err(Into::into)
}
#[allow(dead_code)]
pub fn create_tools_json_for_messages_api(
tools: &[ToolDescriptor],
) -> crate::product::agent::error::Result<Vec<serde_json::Value>> {
let mut tools_json = Vec::new();
for tool in tools {
match tool {
ToolDescriptor::Function(tool) if tool.name != "local_shell" => {
tools_json.push(json!({
"name": tool.name,
"description": tool.description,
"input_schema": tool.parameters,
}))
}
ToolDescriptor::Function(_)
| ToolDescriptor::WebSearch { .. }
| ToolDescriptor::Freeform(_) => {
return Err(
crate::product::agent::error::CodexErr::UnsupportedOperation(format!(
"Messages API only supports function tools; unsupported tool: {}",
tool.name()
)),
);
}
}
}
Ok(tools_json)
}
#[allow(dead_code)]
pub(crate) fn create_tools_json_for_chat_completions_api(
tools: &[ToolDescriptor],
) -> crate::product::agent::error::Result<Vec<serde_json::Value>> {
let responses_api_tools_json = create_tools_json_for_responses_api(tools)?;
Ok(responses_api_tools_json
.into_iter()
.filter_map(|mut tool| {
if tool.get("type") != Some(&JsonValue::String("function".to_string())) {
return None;
}
tool.as_object_mut().map(|map| {
let name = map
.get("name")
.and_then(JsonValue::as_str)
.unwrap_or_default()
.to_string();
map.remove("type");
json!({
"type": "function",
"name": name,
"function": map,
})
})
})
.collect())
}
pub(crate) fn mcp_tool_to_openai_tool(
fully_qualified_name: String,
tool: crate::product::mcp_types::Tool,
) -> Result<ResponsesApiTool, serde_json::Error> {
let crate::product::mcp_types::Tool {
description,
mut input_schema,
..
} = tool;
if input_schema.properties.is_none() {
input_schema.properties = Some(serde_json::Value::Object(serde_json::Map::new()));
}
let mut serialized_input_schema = serde_json::to_value(input_schema)?;
sanitize_json_schema(&mut serialized_input_schema);
let input_schema = serde_json::from_value::<JsonSchema>(serialized_input_schema)?;
Ok(ResponsesApiTool {
name: fully_qualified_name,
description: description.unwrap_or_default(),
strict: false,
parameters: input_schema,
})
}
fn dynamic_tool_to_openai_tool(
tool: &DynamicToolSpec,
) -> Result<ResponsesApiTool, serde_json::Error> {
let input_schema = parse_tool_input_schema(&tool.input_schema)?;
Ok(ResponsesApiTool {
name: tool.name.clone(),
description: tool.description.clone(),
strict: false,
parameters: input_schema,
})
}
pub fn parse_tool_input_schema(input_schema: &JsonValue) -> Result<JsonSchema, serde_json::Error> {
let mut input_schema = input_schema.clone();
sanitize_json_schema(&mut input_schema);
serde_json::from_value::<JsonSchema>(input_schema)
}
fn sanitize_json_schema(value: &mut JsonValue) {
match value {
JsonValue::Bool(_) => {
*value = json!({ "type": "string" });
}
JsonValue::Array(arr) => {
for v in arr.iter_mut() {
sanitize_json_schema(v);
}
}
JsonValue::Object(map) => {
if let Some(props) = map.get_mut("properties")
&& let Some(props_map) = props.as_object_mut()
{
for (_k, v) in props_map.iter_mut() {
sanitize_json_schema(v);
}
}
if let Some(items) = map.get_mut("items") {
sanitize_json_schema(items);
}
for combiner in ["oneOf", "anyOf", "allOf", "prefixItems"] {
if let Some(v) = map.get_mut(combiner) {
sanitize_json_schema(v);
}
}
let mut ty = map.get("type").and_then(|v| v.as_str()).map(str::to_string);
if ty.is_none()
&& let Some(JsonValue::Array(types)) = map.get("type")
{
for t in types {
if let Some(tt) = t.as_str()
&& matches!(
tt,
"object" | "array" | "string" | "number" | "integer" | "boolean"
)
{
ty = Some(tt.to_string());
break;
}
}
}
if ty.is_none() {
if map.contains_key("properties")
|| map.contains_key("required")
|| map.contains_key("additionalProperties")
{
ty = Some("object".to_string());
} else if map.contains_key("items") || map.contains_key("prefixItems") {
ty = Some("array".to_string());
} else if map.contains_key("enum")
|| map.contains_key("const")
|| map.contains_key("format")
{
ty = Some("string".to_string());
} else if map.contains_key("minimum")
|| map.contains_key("maximum")
|| map.contains_key("exclusiveMinimum")
|| map.contains_key("exclusiveMaximum")
|| map.contains_key("multipleOf")
{
ty = Some("number".to_string());
}
}
let ty = ty.unwrap_or_else(|| "string".to_string());
map.insert("type".to_string(), JsonValue::String(ty.to_string()));
if ty == "object" {
if !map.contains_key("properties") {
map.insert(
"properties".to_string(),
JsonValue::Object(serde_json::Map::new()),
);
}
if let Some(ap) = map.get_mut("additionalProperties") {
let is_bool = matches!(ap, JsonValue::Bool(_));
if !is_bool {
sanitize_json_schema(ap);
}
}
}
if ty == "array" && !map.contains_key("items") {
map.insert("items".to_string(), json!({ "type": "string" }));
}
}
_ => {}
}
}
pub(crate) fn build_specs(
config: &ToolsConfig,
mcp_tools: Option<HashMap<String, crate::product::mcp_types::Tool>>,
dynamic_tools: &[DynamicToolSpec],
) -> ToolRegistryBuilder {
use crate::product::agent::tools::handlers::ApplyPatchHandler;
use crate::product::agent::tools::handlers::DelegatedJobHandler;
use crate::product::agent::tools::handlers::DynamicToolHandler;
use crate::product::agent::tools::handlers::GoalHandler;
use crate::product::agent::tools::handlers::GrepFilesHandler;
use crate::product::agent::tools::handlers::ImagegenHandler;
use crate::product::agent::tools::handlers::ListDirHandler;
use crate::product::agent::tools::handlers::McpHandler;
use crate::product::agent::tools::handlers::McpResourceHandler;
use crate::product::agent::tools::handlers::MemoriesHandler;
use crate::product::agent::tools::handlers::PlanHandler;
use crate::product::agent::tools::handlers::ReadFileHandler;
use crate::product::agent::tools::handlers::RequestUserInputHandler;
use crate::product::agent::tools::handlers::ShellCommandHandler;
use crate::product::agent::tools::handlers::ShellHandler;
use crate::product::agent::tools::handlers::TestSyncHandler;
use crate::product::agent::tools::handlers::UnifiedExecHandler;
use crate::product::agent::tools::handlers::ViewImageHandler;
use crate::product::agent::tools::handlers::WorkflowHandler;
let mut builder = ToolRegistryBuilder::new();
let shell_handler = Arc::new(ShellHandler);
let unified_exec_handler = Arc::new(UnifiedExecHandler);
let plan_handler = Arc::new(PlanHandler);
let apply_patch_handler = Arc::new(ApplyPatchHandler);
let dynamic_tool_handler = Arc::new(DynamicToolHandler);
let view_image_handler = Arc::new(ViewImageHandler);
let mcp_handler = Arc::new(McpHandler);
let mcp_resource_handler = Arc::new(McpResourceHandler);
let shell_command_handler = Arc::new(ShellCommandHandler);
let request_user_input_handler = Arc::new(RequestUserInputHandler);
let workflow_handler = Arc::new(WorkflowHandler);
let goal_handler = Arc::new(GoalHandler);
let memories_handler = Arc::new(MemoriesHandler);
let imagegen_handler = Arc::new(ImagegenHandler);
match &config.shell_type {
ConfigShellToolType::Default => {
maybe_push_spec(
&mut builder,
config,
create_shell_tool(config.request_rule_enabled),
);
}
ConfigShellToolType::Local => {
maybe_push_spec(
&mut builder,
config,
create_local_shell_tool(config.request_rule_enabled),
);
}
ConfigShellToolType::UnifiedExec => {
maybe_push_spec_and_register_handler(
&mut builder,
config,
create_exec_command_tool(config.request_rule_enabled),
"exec_command",
unified_exec_handler.clone(),
);
maybe_push_spec_and_register_handler(
&mut builder,
config,
create_write_stdin_tool(),
"write_stdin",
unified_exec_handler,
);
}
ConfigShellToolType::Disabled => {
}
ConfigShellToolType::ShellCommand => {
maybe_push_spec(
&mut builder,
config,
create_shell_command_tool(config.request_rule_enabled),
);
}
}
if config.enforce_declared_tool_names {
match config.shell_type {
ConfigShellToolType::Default => {
let shell_spec = create_shell_tool(config.request_rule_enabled);
if tool_is_exposed_for_runtime(config, &shell_spec) {
builder.register_handler("shell", shell_handler);
}
}
ConfigShellToolType::Local => {
let local_shell_spec = create_local_shell_tool(config.request_rule_enabled);
if tool_is_exposed_for_runtime(config, &local_shell_spec) {
builder.register_handler("local_shell", shell_handler);
}
}
ConfigShellToolType::UnifiedExec | ConfigShellToolType::Disabled => {}
ConfigShellToolType::ShellCommand => {
let shell_command_spec = create_shell_command_tool(config.request_rule_enabled);
if tool_is_exposed_for_runtime(config, &shell_command_spec) {
builder.register_handler("shell_command", shell_command_handler);
}
}
}
} else if config.shell_type != ConfigShellToolType::Disabled {
maybe_register_handler(&mut builder, config, "shell", shell_handler.clone());
maybe_register_handler(
&mut builder,
config,
"container.exec",
shell_handler.clone(),
);
maybe_register_handler(&mut builder, config, "local_shell", shell_handler);
maybe_register_handler(&mut builder, config, "shell_command", shell_command_handler);
}
maybe_push_spec_with_parallel_support_and_register_handler(
&mut builder,
config,
create_list_mcp_resources_tool(),
true,
"list_mcp_resources",
mcp_resource_handler.clone(),
);
maybe_push_spec_with_parallel_support_and_register_handler(
&mut builder,
config,
create_list_mcp_resource_templates_tool(),
true,
"list_mcp_resource_templates",
mcp_resource_handler.clone(),
);
maybe_push_spec_with_parallel_support_and_register_handler(
&mut builder,
config,
create_read_mcp_resource_tool(),
true,
"read_mcp_resource",
mcp_resource_handler,
);
maybe_push_spec_and_register_handler(
&mut builder,
config,
PLAN_TOOL.clone(),
"update_plan",
plan_handler,
);
if config.identity_tools {
maybe_push_spec_and_register_handler(
&mut builder,
config,
create_request_user_input_tool(),
"request_user_input",
request_user_input_handler,
);
}
if config.workflow_tools {
maybe_push_spec_and_register_handler(
&mut builder,
config,
crate::product::agent::tools::handlers::WORKFLOW_SUBMIT_ARTIFACT_TOOL.clone(),
"workflow_submit_artifact",
workflow_handler,
);
}
if config.goal_tools {
for spec in create_goal_tools() {
let name = spec.name().to_string();
maybe_push_spec_and_register_handler(
&mut builder,
config,
spec,
name,
goal_handler.clone(),
);
}
}
if config.memory_tools {
for spec in create_memory_tools() {
let name = spec.name().to_string();
maybe_push_spec_and_register_handler(
&mut builder,
config,
spec,
name,
memories_handler.clone(),
);
}
}
if config.image_generation_tools {
maybe_push_spec_and_register_handler(
&mut builder,
config,
create_imagegen_tool(),
"imagegen",
imagegen_handler,
);
}
if let Some(apply_patch_tool_type) = &config.apply_patch_tool_type {
match apply_patch_tool_type {
ApplyPatchToolType::Freeform => {
maybe_push_spec_and_register_handler(
&mut builder,
config,
create_apply_patch_freeform_tool(),
"apply_patch",
apply_patch_handler,
);
}
ApplyPatchToolType::Function => {
maybe_push_spec_and_register_handler(
&mut builder,
config,
create_apply_patch_json_tool(),
"apply_patch",
apply_patch_handler,
);
}
}
}
if config
.experimental_supported_tools
.contains(&"grep_files".to_string())
{
let grep_files_handler = Arc::new(GrepFilesHandler);
maybe_push_spec_with_parallel_support_and_register_handler(
&mut builder,
config,
create_grep_files_tool(),
true,
"grep_files",
grep_files_handler,
);
}
if config
.experimental_supported_tools
.contains(&"read_file".to_string())
{
let read_file_handler = Arc::new(ReadFileHandler);
maybe_push_spec_with_parallel_support_and_register_handler(
&mut builder,
config,
create_read_file_tool(),
true,
"read_file",
read_file_handler,
);
}
if config
.experimental_supported_tools
.iter()
.any(|tool| tool == "list_dir")
{
let list_dir_handler = Arc::new(ListDirHandler);
maybe_push_spec_with_parallel_support_and_register_handler(
&mut builder,
config,
create_list_dir_tool(),
true,
"list_dir",
list_dir_handler,
);
}
if config
.experimental_supported_tools
.contains(&"test_sync_tool".to_string())
{
let test_sync_handler = Arc::new(TestSyncHandler);
maybe_push_spec_with_parallel_support_and_register_handler(
&mut builder,
config,
create_test_sync_tool(),
true,
"test_sync_tool",
test_sync_handler,
);
}
match config.web_search_mode {
Some(WebSearchMode::Cached) => {
maybe_push_spec(
&mut builder,
config,
ToolDescriptor::WebSearch {
external_web_access: Some(false),
},
);
}
Some(WebSearchMode::Live) => {
maybe_push_spec(
&mut builder,
config,
ToolDescriptor::WebSearch {
external_web_access: Some(true),
},
);
}
Some(WebSearchMode::Disabled) | None => {}
}
maybe_push_spec_with_parallel_support_and_register_handler(
&mut builder,
config,
create_view_image_tool(),
true,
"view_image",
view_image_handler,
);
if config.delegated_job_tools {
let delegated_job_handler = Arc::new(DelegatedJobHandler);
maybe_push_spec_and_register_handler(
&mut builder,
config,
create_spawn_agent_tool(config),
"spawn_agent",
delegated_job_handler.clone(),
);
maybe_push_spec_and_register_handler(
&mut builder,
config,
create_wait_tool(),
"wait",
delegated_job_handler.clone(),
);
maybe_push_spec_and_register_handler(
&mut builder,
config,
create_close_agent_tool(),
"close_agent",
delegated_job_handler,
);
}
if let Some(mcp_tools) = mcp_tools {
let mut entries: Vec<(String, crate::product::mcp_types::Tool)> =
mcp_tools.into_iter().collect();
entries.sort_by(|a, b| a.0.cmp(&b.0));
for (name, tool) in entries.into_iter() {
match mcp_tool_to_openai_tool(name.clone(), tool.clone()) {
Ok(converted_tool) => {
maybe_push_spec_and_register_handler(
&mut builder,
config,
ToolDescriptor::Function(converted_tool),
name,
mcp_handler.clone(),
);
}
Err(e) => {
tracing::error!("Failed to convert {name:?} MCP tool to OpenAI tool: {e:?}");
}
}
}
}
if !dynamic_tools.is_empty() {
for tool in dynamic_tools {
match dynamic_tool_to_openai_tool(tool) {
Ok(converted_tool) => {
maybe_push_spec_and_register_handler(
&mut builder,
config,
ToolDescriptor::Function(converted_tool),
tool.name.clone(),
dynamic_tool_handler.clone(),
);
}
Err(e) => {
tracing::error!(
"Failed to convert dynamic tool {:?} to OpenAI tool: {e:?}",
tool.name
);
}
}
}
}
builder
}
#[cfg(test)]
mod tests {
use crate::product::agent::config::test_config;
use crate::product::agent::models_manager::manager::ModelsManager;
use crate::product::agent::tools::registry::ConfiguredToolSpec;
use crate::product::mcp_types::ToolInputSchema;
use lha_llm::FreeformToolDescriptor;
use pretty_assertions::assert_eq;
use super::*;
fn tool_name(tool: &ToolDescriptor) -> &str {
match tool {
ToolDescriptor::Function(ResponsesApiTool { name, .. }) => name,
ToolDescriptor::WebSearch { .. } => "web_search",
ToolDescriptor::Freeform(FreeformToolDescriptor { name, .. }) => name,
}
}
fn assert_contains_tool_names(tools: &[ConfiguredToolSpec], expected_subset: &[&str]) {
use std::collections::HashSet;
let mut names = HashSet::new();
let mut duplicates = Vec::new();
for name in tools.iter().map(|t| tool_name(&t.spec)) {
if !names.insert(name) {
duplicates.push(name);
}
}
assert!(
duplicates.is_empty(),
"duplicate tool entries detected: {duplicates:?}"
);
for expected in expected_subset {
assert!(
names.contains(expected),
"expected tool {expected} to be present; had: {names:?}"
);
}
}
fn shell_tool_name(config: &ToolsConfig) -> Option<&'static str> {
match config.shell_type {
ConfigShellToolType::Default => Some("shell"),
ConfigShellToolType::Local => Some("local_shell"),
ConfigShellToolType::UnifiedExec => None,
ConfigShellToolType::Disabled => None,
ConfigShellToolType::ShellCommand => Some("shell_command"),
}
}
fn find_tool<'a>(
tools: &'a [ConfiguredToolSpec],
expected_name: &str,
) -> &'a ConfiguredToolSpec {
tools
.iter()
.find(|tool| tool_name(&tool.spec) == expected_name)
.unwrap_or_else(|| panic!("expected tool {expected_name}"))
}
fn strip_descriptions_schema(schema: &mut JsonSchema) {
match schema {
JsonSchema::Boolean { description }
| JsonSchema::String {
description,
enum_values: _,
}
| JsonSchema::Number { description } => {
*description = None;
}
JsonSchema::Array { items, description } => {
strip_descriptions_schema(items);
*description = None;
}
JsonSchema::Object {
properties,
required: _,
additional_properties,
} => {
for v in properties.values_mut() {
strip_descriptions_schema(v);
}
if let Some(AdditionalProperties::Schema(s)) = additional_properties {
strip_descriptions_schema(s);
}
}
}
}
fn strip_descriptions_tool(spec: &mut ToolDescriptor) {
match spec {
ToolDescriptor::Function(ResponsesApiTool { parameters, .. }) => {
strip_descriptions_schema(parameters);
}
ToolDescriptor::Freeform(_) | ToolDescriptor::WebSearch { .. } => {}
}
}
#[test]
fn test_full_toolset_specs_for_gpt5_codex_unified_exec_web_search() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
features.enable(Feature::Identities);
let config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Live),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(&config, None, &[]).build();
use std::collections::BTreeMap;
use std::collections::HashSet;
let mut actual: BTreeMap<String, ToolDescriptor> = BTreeMap::from([]);
let mut duplicate_names = Vec::new();
for t in &tools {
let name = tool_name(&t.spec).to_string();
if actual.insert(name.clone(), t.spec.clone()).is_some() {
duplicate_names.push(name);
}
}
assert!(
duplicate_names.is_empty(),
"duplicate tool entries detected: {duplicate_names:?}"
);
let mut expected: BTreeMap<String, ToolDescriptor> = BTreeMap::from([]);
for spec in [
create_exec_command_tool(true),
create_write_stdin_tool(),
create_list_mcp_resources_tool(),
create_list_mcp_resource_templates_tool(),
create_read_mcp_resource_tool(),
PLAN_TOOL.clone(),
create_request_user_input_tool(),
create_apply_patch_freeform_tool(),
ToolDescriptor::WebSearch {
external_web_access: Some(true),
},
create_view_image_tool(),
] {
expected.insert(tool_name(&spec).to_string(), spec);
}
for (name, spec) in [
("spawn_agent", create_spawn_agent_tool(&config)),
("wait", create_wait_tool()),
("close_agent", create_close_agent_tool()),
] {
expected.insert(name.to_string(), spec);
}
let actual_names: HashSet<_> = actual.keys().cloned().collect();
let expected_names: HashSet<_> = expected.keys().cloned().collect();
assert_eq!(actual_names, expected_names, "tool name set mismatch");
for name in expected.keys() {
let mut a = actual.get(name).expect("present").clone();
let mut e = expected.get(name).expect("present").clone();
strip_descriptions_tool(&mut a);
strip_descriptions_tool(&mut e);
assert_eq!(a, e, "spec mismatch for {name}");
}
}
#[test]
fn test_build_specs_delegated_job_tools_enabled() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.enable(Feature::AgentJobs);
features.enable(Feature::Identities);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Cached),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(&tools_config, None, &[]).build();
assert_contains_tool_names(&tools, &["spawn_agent", "wait", "close_agent"]);
}
#[test]
fn explorer_only_exposes_read_only_navigation_tools() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("test-gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.enable(Feature::ApplyPatchFreeform);
features.enable(Feature::AgentJobs);
features.enable(Feature::Identities);
features.enable(Feature::UnifiedExec);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Live),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
})
.with_identity_kind(IdentityKind::Explorer);
let (tools, registry) = build_specs(&tools_config, Some(HashMap::new()), &[]).build();
let tool_names = tools
.iter()
.map(|tool| tool.spec.name())
.collect::<Vec<_>>();
assert_eq!(tool_names, vec!["grep_files", "read_file", "list_dir"]);
assert!(registry.handler("grep_files").is_some());
assert!(registry.handler("read_file").is_some());
assert!(registry.handler("list_dir").is_some());
assert!(registry.handler("spawn_agent").is_none());
assert!(registry.handler("exec_command").is_none());
assert!(registry.handler("write_stdin").is_none());
assert!(registry.handler("shell").is_none());
assert!(registry.handler("container.exec").is_none());
assert!(registry.handler("local_shell").is_none());
assert!(registry.handler("shell_command").is_none());
assert!(registry.handler("apply_patch").is_none());
}
#[test]
fn reviewer_exposes_read_only_navigation_and_inspection_command_tools() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("test-gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.enable(Feature::ApplyPatchFreeform);
features.enable(Feature::AgentJobs);
features.enable(Feature::Identities);
features.enable(Feature::UnifiedExec);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Live),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
})
.with_identity_kind(IdentityKind::Reviewer);
let (tools, registry) = build_specs(&tools_config, Some(HashMap::new()), &[]).build();
let tool_names = tools
.iter()
.map(|tool| tool.spec.name())
.collect::<Vec<_>>();
assert_eq!(
tool_names,
vec![
"exec_command",
"grep_files",
"read_file",
"list_dir",
"spawn_agent",
"wait",
"close_agent"
]
);
assert!(registry.handler("exec_command").is_some());
assert!(registry.handler("grep_files").is_some());
assert!(registry.handler("read_file").is_some());
assert!(registry.handler("list_dir").is_some());
assert!(registry.handler("spawn_agent").is_some());
assert!(registry.handler("wait").is_some());
assert!(registry.handler("close_agent").is_some());
assert!(registry.handler("write_stdin").is_none());
assert!(registry.handler("apply_patch").is_none());
assert!(registry.handler("container.exec").is_some());
assert!(registry.handler("shell").is_some());
assert!(registry.handler("local_shell").is_some());
assert!(registry.handler("shell_command").is_some());
}
#[test]
fn messages_build_specs_only_exposes_function_tools() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
features.enable(Feature::AgentJobs);
features.enable(Feature::Identities);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: true,
features: &features,
web_search_mode: Some(WebSearchMode::Live),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(&tools_config, Some(HashMap::new()), &[]).build();
assert!(
tools
.iter()
.all(|tool| matches!(tool.spec, ToolDescriptor::Function(_))),
"messages wire API should only expose function tools"
);
assert!(!tools.iter().any(|tool| tool.spec.name() == "web_search"));
assert!(!tools.iter().any(|tool| tool.spec.name() == "local_shell"));
assert!(!tools.iter().any(|tool| tool.spec.name() == "apply_patch"));
}
#[test]
fn messages_build_specs_filters_local_shell_and_freeform_apply_patch_handlers() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("codex-mini-latest", &config);
let mut features = Features::with_defaults();
features.enable(Feature::ApplyPatchFreeform);
features.enable(Feature::Identities);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: true,
features: &features,
web_search_mode: Some(WebSearchMode::Live),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, registry) = build_specs(&tools_config, Some(HashMap::new()), &[]).build();
assert!(
tools
.iter()
.all(|tool| matches!(tool.spec, ToolDescriptor::Function(_)))
);
assert!(!tools.iter().any(|tool| tool.spec.name() == "apply_patch"));
assert!(!tools.iter().any(|tool| tool.spec.name() == "local_shell"));
assert!(registry.handler("apply_patch").is_none());
assert!(registry.handler("local_shell").is_none());
assert!(registry.handler("shell").is_none());
assert!(registry.handler("container.exec").is_none());
}
#[test]
fn messages_build_specs_keeps_unified_exec_handlers() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("codex-mini-latest", &config);
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
features.enable(Feature::Identities);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: true,
features: &features,
web_search_mode: Some(WebSearchMode::Live),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, registry) = build_specs(&tools_config, Some(HashMap::new()), &[]).build();
assert!(tools.iter().any(|tool| tool.spec.name() == "exec_command"));
assert!(tools.iter().any(|tool| tool.spec.name() == "write_stdin"));
assert!(registry.handler("exec_command").is_some());
assert!(registry.handler("write_stdin").is_some());
}
#[test]
fn write_stdin_tool_documents_empty_chars_polling() {
let ToolDescriptor::Function(tool) = create_write_stdin_tool() else {
panic!("write_stdin should be a function tool");
};
let tool_description = tool.description.to_ascii_lowercase();
assert!(tool_description.contains("empty"));
assert!(tool_description.contains("poll"));
assert!(tool_description.contains("not a no-op"));
let JsonSchema::Object { properties, .. } = tool.parameters else {
panic!("write_stdin should use an object schema");
};
let chars_schema = properties
.get("chars")
.expect("write_stdin should expose chars");
let JsonSchema::String {
description: Some(chars_description),
enum_values: _,
} = chars_schema
else {
panic!("chars should be a documented string parameter");
};
let chars_description = chars_description.to_ascii_lowercase();
assert!(chars_description.contains("empty"));
assert!(chars_description.contains("poll"));
assert!(chars_description.contains("output"));
}
#[test]
fn request_user_input_requires_identities_feature() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.disable(Feature::Identities);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Cached),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(&tools_config, None, &[]).build();
assert!(
!tools.iter().any(|t| t.spec.name() == "request_user_input"),
"request_user_input should be disabled when identities feature is off"
);
features.enable(Feature::Identities);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Cached),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(&tools_config, None, &[]).build();
assert_contains_tool_names(&tools, &["request_user_input"]);
}
#[test]
fn plan_run_tools_are_absent() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.enable(Feature::Goals);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Cached),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
})
.with_identity_kind(IdentityKind::Programmer);
let (tools, registry) = build_specs(&tools_config, None, &[]).build();
for name in ["get_plan_run", "update_plan_run"] {
assert!(!tools.iter().any(|tool| tool.spec.name() == name));
assert!(registry.handler(name).is_none());
}
}
fn assert_model_tools(
model_slug: &str,
features: &Features,
web_search_mode: Option<WebSearchMode>,
expected_tools: &[&str],
) {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline(model_slug, &config);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features,
web_search_mode,
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(&tools_config, Some(HashMap::new()), &[]).build();
let mut expected_tool_names = expected_tools.to_vec();
if features.enabled(Feature::AgentJobs) {
expected_tool_names.extend(["spawn_agent", "wait", "close_agent"]);
}
let tool_names = tools.iter().map(|t| t.spec.name()).collect::<Vec<_>>();
assert_eq!(&tool_names, &expected_tool_names,);
}
fn assert_default_model_tools(
model_slug: &str,
features: &Features,
web_search_mode: Option<WebSearchMode>,
default_shell_tool: &'static str,
remaining_tools: &[&str],
) {
let expected_tools = if cfg!(windows) {
std::iter::once(default_shell_tool)
.chain(remaining_tools.iter().copied())
.collect::<Vec<_>>()
} else {
std::iter::once("exec_command")
.chain(std::iter::once("write_stdin"))
.chain(remaining_tools.iter().copied())
.collect::<Vec<_>>()
};
assert_model_tools(model_slug, features, web_search_mode, &expected_tools);
}
#[test]
fn memory_tools_are_hidden_unless_enabled_by_runtime_config() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let mut features = Features::with_defaults();
let hidden_when_feature_disabled = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: None,
image_generation_tools: false,
memory_tools: features.enabled(Feature::MemoryTool),
session_source: SessionSource::Cli,
});
let (tools, registry) =
build_specs(&hidden_when_feature_disabled, Some(HashMap::new()), &[]).build();
assert!(
!tools
.iter()
.any(|tool| tool.spec.name().starts_with("memories__"))
);
assert!(registry.handler("memories__list").is_none());
features.enable(Feature::MemoryTool);
let hidden_when_dedicated_tools_false = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: None,
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, registry) = build_specs(
&hidden_when_dedicated_tools_false,
Some(HashMap::new()),
&[],
)
.build();
assert!(
!tools
.iter()
.any(|tool| tool.spec.name().starts_with("memories__"))
);
assert!(registry.handler("memories__list").is_none());
}
#[test]
fn memory_tools_are_registered_when_enabled() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.enable(Feature::MemoryTool);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: None,
image_generation_tools: false,
memory_tools: true,
session_source: SessionSource::Cli,
});
let (tools, registry) = build_specs(&tools_config, Some(HashMap::new()), &[]).build();
let tool_names = tools
.iter()
.map(|tool| tool.spec.name())
.collect::<Vec<_>>();
assert!(tool_names.contains(&"memories__list"));
assert!(tool_names.contains(&"memories__read"));
assert!(tool_names.contains(&"memories__search"));
assert!(tool_names.contains(&"memories__add_ad_hoc_note"));
assert!(registry.handler("memories__list").is_some());
assert!(registry.handler("memories__add_ad_hoc_note").is_some());
}
#[test]
fn imagegen_tool_schema_and_handler_are_registered_when_enabled() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let features = Features::with_defaults();
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: None,
image_generation_tools: true,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, registry) = build_specs(&tools_config, Some(HashMap::new()), &[]).build();
let tool = find_tool(&tools, "imagegen");
let ToolDescriptor::Function(ResponsesApiTool {
name, parameters, ..
}) = &tool.spec
else {
panic!("expected imagegen function tool");
};
assert_eq!(name, "imagegen");
let JsonSchema::Object {
properties,
required,
additional_properties,
} = parameters
else {
panic!("expected imagegen object schema");
};
assert_eq!(
required.as_deref(),
Some(&["prompt".to_string(), "action".to_string()][..])
);
assert_eq!(additional_properties, &Some(false.into()));
assert!(matches!(
properties.get("prompt"),
Some(JsonSchema::String {
enum_values: None,
..
})
));
assert_eq!(
properties.get("action"),
Some(&JsonSchema::String {
description: Some(
"Use generate for new images and edit when modifying image context from the conversation."
.to_string()
),
enum_values: Some(vec!["generate".to_string(), "edit".to_string()]),
})
);
assert!(registry.handler("imagegen").is_some());
}
#[test]
fn web_search_mode_cached_sets_external_web_access_false() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let features = Features::with_defaults();
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Cached),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(&tools_config, None, &[]).build();
let tool = find_tool(&tools, "web_search");
assert_eq!(
tool.spec,
ToolDescriptor::WebSearch {
external_web_access: Some(false),
}
);
}
#[test]
fn web_search_mode_live_sets_external_web_access_true() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let features = Features::with_defaults();
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Live),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(&tools_config, None, &[]).build();
let tool = find_tool(&tools, "web_search");
assert_eq!(
tool.spec,
ToolDescriptor::WebSearch {
external_web_access: Some(true),
}
);
}
#[test]
fn test_build_specs_gpt5_codex_default() {
let mut features = Features::with_defaults();
features.enable(Feature::Identities);
assert_default_model_tools(
"gpt-5-codex",
&features,
Some(WebSearchMode::Cached),
"shell_command",
&[
"list_mcp_resources",
"list_mcp_resource_templates",
"read_mcp_resource",
"update_plan",
"request_user_input",
"apply_patch",
"web_search",
"view_image",
],
);
}
#[test]
fn test_build_specs_gpt51_codex_default() {
let mut features = Features::with_defaults();
features.enable(Feature::Identities);
assert_default_model_tools(
"gpt-5.1-codex",
&features,
Some(WebSearchMode::Cached),
"shell_command",
&[
"list_mcp_resources",
"list_mcp_resource_templates",
"read_mcp_resource",
"update_plan",
"request_user_input",
"apply_patch",
"web_search",
"view_image",
],
);
}
#[test]
fn test_build_specs_gpt5_codex_unified_exec_web_search() {
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
features.enable(Feature::Identities);
assert_model_tools(
"gpt-5-codex",
&features,
Some(WebSearchMode::Live),
&[
"exec_command",
"write_stdin",
"list_mcp_resources",
"list_mcp_resource_templates",
"read_mcp_resource",
"update_plan",
"request_user_input",
"apply_patch",
"web_search",
"view_image",
],
);
}
#[test]
fn test_build_specs_gpt51_codex_unified_exec_web_search() {
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
features.enable(Feature::Identities);
assert_model_tools(
"gpt-5.1-codex",
&features,
Some(WebSearchMode::Live),
&[
"exec_command",
"write_stdin",
"list_mcp_resources",
"list_mcp_resource_templates",
"read_mcp_resource",
"update_plan",
"request_user_input",
"apply_patch",
"web_search",
"view_image",
],
);
}
#[test]
fn test_codex_mini_defaults() {
let mut features = Features::with_defaults();
features.enable(Feature::Identities);
assert_default_model_tools(
"codex-mini-latest",
&features,
Some(WebSearchMode::Cached),
"local_shell",
&[
"list_mcp_resources",
"list_mcp_resource_templates",
"read_mcp_resource",
"update_plan",
"request_user_input",
"web_search",
"view_image",
],
);
}
#[test]
fn test_codex_5_1_mini_defaults() {
let mut features = Features::with_defaults();
features.enable(Feature::Identities);
assert_default_model_tools(
"gpt-5.1-codex-mini",
&features,
Some(WebSearchMode::Cached),
"shell_command",
&[
"list_mcp_resources",
"list_mcp_resource_templates",
"read_mcp_resource",
"update_plan",
"request_user_input",
"apply_patch",
"web_search",
"view_image",
],
);
}
#[test]
fn test_gpt_5_defaults() {
let mut features = Features::with_defaults();
features.enable(Feature::Identities);
assert_default_model_tools(
"gpt-5",
&features,
Some(WebSearchMode::Cached),
"shell",
&[
"list_mcp_resources",
"list_mcp_resource_templates",
"read_mcp_resource",
"update_plan",
"request_user_input",
"web_search",
"view_image",
],
);
}
#[test]
fn test_gpt_5_1_defaults() {
let mut features = Features::with_defaults();
features.enable(Feature::Identities);
assert_default_model_tools(
"gpt-5.1",
&features,
Some(WebSearchMode::Cached),
"shell_command",
&[
"list_mcp_resources",
"list_mcp_resource_templates",
"read_mcp_resource",
"update_plan",
"request_user_input",
"apply_patch",
"web_search",
"view_image",
],
);
}
#[test]
fn test_exp_5_1_defaults() {
let mut features = Features::with_defaults();
features.enable(Feature::Identities);
assert_model_tools(
"exp-5.1",
&features,
Some(WebSearchMode::Cached),
&[
"exec_command",
"write_stdin",
"list_mcp_resources",
"list_mcp_resource_templates",
"read_mcp_resource",
"update_plan",
"request_user_input",
"apply_patch",
"web_search",
"view_image",
],
);
}
#[test]
fn test_codex_mini_unified_exec_web_search() {
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
features.enable(Feature::Identities);
assert_model_tools(
"codex-mini-latest",
&features,
Some(WebSearchMode::Live),
&[
"exec_command",
"write_stdin",
"list_mcp_resources",
"list_mcp_resource_templates",
"read_mcp_resource",
"update_plan",
"request_user_input",
"web_search",
"view_image",
],
);
}
#[test]
fn test_build_specs_default_shell_present() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("o3", &config);
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Live),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(&tools_config, Some(HashMap::new()), &[]).build();
let mut subset = vec!["exec_command", "write_stdin", "update_plan"];
if let Some(shell_tool) = shell_tool_name(&tools_config) {
subset.push(shell_tool);
}
assert_contains_tool_names(&tools, &subset);
}
#[test]
#[ignore]
fn test_parallel_support_flags() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Cached),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(&tools_config, None, &[]).build();
assert!(!find_tool(&tools, "exec_command").supports_parallel_tool_calls);
assert!(!find_tool(&tools, "write_stdin").supports_parallel_tool_calls);
assert!(find_tool(&tools, "grep_files").supports_parallel_tool_calls);
assert!(find_tool(&tools, "list_dir").supports_parallel_tool_calls);
assert!(find_tool(&tools, "read_file").supports_parallel_tool_calls);
}
#[test]
fn test_test_model_info_includes_sync_tool() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("test-gpt-5-codex", &config);
let features = Features::with_defaults();
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Cached),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(&tools_config, None, &[]).build();
assert!(
tools
.iter()
.any(|tool| tool_name(&tool.spec) == "test_sync_tool")
);
assert!(
tools
.iter()
.any(|tool| tool_name(&tool.spec) == "read_file")
);
assert!(
tools
.iter()
.any(|tool| tool_name(&tool.spec) == "grep_files")
);
assert!(tools.iter().any(|tool| tool_name(&tool.spec) == "list_dir"));
}
#[test]
fn test_build_specs_mcp_tools_converted() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("o3", &config);
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Live),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(
&tools_config,
Some(HashMap::from([(
"test_server/do_something_cool".to_string(),
crate::product::mcp_types::Tool {
name: "do_something_cool".to_string(),
input_schema: ToolInputSchema {
properties: Some(serde_json::json!({
"string_argument": {
"type": "string",
},
"number_argument": {
"type": "number",
},
"object_argument": {
"type": "object",
"properties": {
"string_property": { "type": "string" },
"number_property": { "type": "number" },
},
"required": [
"string_property",
"number_property",
],
"additionalProperties": Some(false),
},
})),
required: None,
r#type: "object".to_string(),
},
output_schema: None,
title: None,
annotations: None,
description: Some("Do something cool".to_string()),
},
)])),
&[],
)
.build();
let tool = find_tool(&tools, "test_server/do_something_cool");
assert_eq!(
&tool.spec,
&ToolDescriptor::Function(ResponsesApiTool {
name: "test_server/do_something_cool".to_string(),
parameters: JsonSchema::Object {
properties: BTreeMap::from([
(
"string_argument".to_string(),
JsonSchema::String {
description: None,
enum_values: None
}
),
(
"number_argument".to_string(),
JsonSchema::Number { description: None }
),
(
"object_argument".to_string(),
JsonSchema::Object {
properties: BTreeMap::from([
(
"string_property".to_string(),
JsonSchema::String {
description: None,
enum_values: None
}
),
(
"number_property".to_string(),
JsonSchema::Number { description: None }
),
]),
required: Some(vec![
"string_property".to_string(),
"number_property".to_string(),
]),
additional_properties: Some(false.into()),
},
),
]),
required: None,
additional_properties: None,
},
description: "Do something cool".to_string(),
strict: false,
})
);
}
#[test]
fn test_build_specs_mcp_tools_sorted_by_name() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("o3", &config);
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Cached),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let tools_map: HashMap<String, crate::product::mcp_types::Tool> = HashMap::from([
(
"test_server/do".to_string(),
crate::product::mcp_types::Tool {
name: "a".to_string(),
input_schema: ToolInputSchema {
properties: Some(serde_json::json!({})),
required: None,
r#type: "object".to_string(),
},
output_schema: None,
title: None,
annotations: None,
description: Some("a".to_string()),
},
),
(
"test_server/something".to_string(),
crate::product::mcp_types::Tool {
name: "b".to_string(),
input_schema: ToolInputSchema {
properties: Some(serde_json::json!({})),
required: None,
r#type: "object".to_string(),
},
output_schema: None,
title: None,
annotations: None,
description: Some("b".to_string()),
},
),
(
"test_server/cool".to_string(),
crate::product::mcp_types::Tool {
name: "c".to_string(),
input_schema: ToolInputSchema {
properties: Some(serde_json::json!({})),
required: None,
r#type: "object".to_string(),
},
output_schema: None,
title: None,
annotations: None,
description: Some("c".to_string()),
},
),
]);
let (tools, _) = build_specs(&tools_config, Some(tools_map), &[]).build();
let mcp_names: Vec<_> = tools
.iter()
.map(|t| tool_name(&t.spec).to_string())
.filter(|n| n.starts_with("test_server/"))
.collect();
let expected = vec![
"test_server/cool".to_string(),
"test_server/do".to_string(),
"test_server/something".to_string(),
];
assert_eq!(mcp_names, expected);
}
#[test]
fn test_mcp_tool_property_missing_type_defaults_to_string() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Cached),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(
&tools_config,
Some(HashMap::from([(
"dash/search".to_string(),
crate::product::mcp_types::Tool {
name: "search".to_string(),
input_schema: ToolInputSchema {
properties: Some(serde_json::json!({
"query": {
"description": "search query"
}
})),
required: None,
r#type: "object".to_string(),
},
output_schema: None,
title: None,
annotations: None,
description: Some("Search docs".to_string()),
},
)])),
&[],
)
.build();
let tool = find_tool(&tools, "dash/search");
assert_eq!(
tool.spec,
ToolDescriptor::Function(ResponsesApiTool {
name: "dash/search".to_string(),
parameters: JsonSchema::Object {
properties: BTreeMap::from([(
"query".to_string(),
JsonSchema::String {
description: Some("search query".to_string()),
enum_values: None,
}
)]),
required: None,
additional_properties: None,
},
description: "Search docs".to_string(),
strict: false,
})
);
}
#[test]
fn test_mcp_tool_integer_normalized_to_number() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Cached),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(
&tools_config,
Some(HashMap::from([(
"dash/paginate".to_string(),
crate::product::mcp_types::Tool {
name: "paginate".to_string(),
input_schema: ToolInputSchema {
properties: Some(serde_json::json!({
"page": { "type": "integer" }
})),
required: None,
r#type: "object".to_string(),
},
output_schema: None,
title: None,
annotations: None,
description: Some("Pagination".to_string()),
},
)])),
&[],
)
.build();
let tool = find_tool(&tools, "dash/paginate");
assert_eq!(
tool.spec,
ToolDescriptor::Function(ResponsesApiTool {
name: "dash/paginate".to_string(),
parameters: JsonSchema::Object {
properties: BTreeMap::from([(
"page".to_string(),
JsonSchema::Number { description: None }
)]),
required: None,
additional_properties: None,
},
description: "Pagination".to_string(),
strict: false,
})
);
}
#[test]
fn test_mcp_tool_array_without_items_gets_default_string_items() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
features.enable(Feature::ApplyPatchFreeform);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Cached),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(
&tools_config,
Some(HashMap::from([(
"dash/tags".to_string(),
crate::product::mcp_types::Tool {
name: "tags".to_string(),
input_schema: ToolInputSchema {
properties: Some(serde_json::json!({
"tags": { "type": "array" }
})),
required: None,
r#type: "object".to_string(),
},
output_schema: None,
title: None,
annotations: None,
description: Some("Tags".to_string()),
},
)])),
&[],
)
.build();
let tool = find_tool(&tools, "dash/tags");
assert_eq!(
tool.spec,
ToolDescriptor::Function(ResponsesApiTool {
name: "dash/tags".to_string(),
parameters: JsonSchema::Object {
properties: BTreeMap::from([(
"tags".to_string(),
JsonSchema::Array {
items: Box::new(JsonSchema::String {
description: None,
enum_values: None
}),
description: None
}
)]),
required: None,
additional_properties: None,
},
description: "Tags".to_string(),
strict: false,
})
);
}
#[test]
fn test_mcp_tool_anyof_defaults_to_string() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Cached),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(
&tools_config,
Some(HashMap::from([(
"dash/value".to_string(),
crate::product::mcp_types::Tool {
name: "value".to_string(),
input_schema: ToolInputSchema {
properties: Some(serde_json::json!({
"value": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }
})),
required: None,
r#type: "object".to_string(),
},
output_schema: None,
title: None,
annotations: None,
description: Some("AnyOf Value".to_string()),
},
)])),
&[],
)
.build();
let tool = find_tool(&tools, "dash/value");
assert_eq!(
tool.spec,
ToolDescriptor::Function(ResponsesApiTool {
name: "dash/value".to_string(),
parameters: JsonSchema::Object {
properties: BTreeMap::from([(
"value".to_string(),
JsonSchema::String {
description: None,
enum_values: None
}
)]),
required: None,
additional_properties: None,
},
description: "AnyOf Value".to_string(),
strict: false,
})
);
}
#[test]
fn test_shell_tool() {
let tool = super::create_shell_tool(true);
let ToolDescriptor::Function(ResponsesApiTool {
description, name, ..
}) = &tool
else {
panic!("expected function tool");
};
assert_eq!(name, "shell");
let expected = if cfg!(windows) {
r#"Runs a Powershell command (Windows) and returns its output. Arguments to `shell` will be passed to CreateProcessW(). Most commands should be prefixed with ["powershell.exe", "-Command"].
Examples of valid command strings:
- ls -a (show hidden): ["powershell.exe", "-Command", "Get-ChildItem -Force"]
- recursive find by name: ["powershell.exe", "-Command", "Get-ChildItem -Recurse -Filter *.py"]
- recursive grep: ["powershell.exe", "-Command", "Get-ChildItem -Path C:\\myrepo -Recurse | Select-String -Pattern 'TODO' -CaseSensitive"]
- ps aux | grep python: ["powershell.exe", "-Command", "Get-Process | Where-Object { $_.ProcessName -like '*python*' }"]
- setting an env var: ["powershell.exe", "-Command", "$env:FOO='bar'; echo $env:FOO"]
- running an inline Python script: ["powershell.exe", "-Command", "@'\\nprint('Hello, world!')\\n'@ | python -"]"#
} else {
r#"Runs a shell command and returns its output.
- The arguments to `shell` will be passed to execvp(). Most terminal commands should be prefixed with ["bash", "-lc"].
- Always set the `workdir` param when using the shell function. Do not use `cd` unless absolutely necessary."#
}.to_string();
assert_eq!(description, &expected);
}
#[test]
fn test_shell_command_tool() {
let tool = super::create_shell_command_tool(true);
let ToolDescriptor::Function(ResponsesApiTool {
description, name, ..
}) = &tool
else {
panic!("expected function tool");
};
assert_eq!(name, "shell_command");
let expected = if cfg!(windows) {
r#"Runs a Powershell command (Windows) and returns its output.
Examples of valid command strings:
- ls -a (show hidden): "Get-ChildItem -Force"
- recursive find by name: "Get-ChildItem -Recurse -Filter *.py"
- recursive grep: "Get-ChildItem -Path C:\\myrepo -Recurse | Select-String -Pattern 'TODO' -CaseSensitive"
- ps aux | grep python: "Get-Process | Where-Object { $_.ProcessName -like '*python*' }"
- setting an env var: "$env:FOO='bar'; echo $env:FOO"
- running an inline Python script: "@'\\nprint('Hello, world!')\\n'@ | python -"#.to_string()
} else {
r#"Runs a shell command and returns its output.
- Always set the `workdir` param when using the shell_command function. Do not use `cd` unless absolutely necessary."#.to_string()
};
assert_eq!(description, &expected);
}
#[test]
fn test_get_openai_tools_mcp_tools_with_additional_properties_schema() {
let config = test_config();
let model_info = ModelsManager::construct_model_info_offline("gpt-5-codex", &config);
let mut features = Features::with_defaults();
features.enable(Feature::UnifiedExec);
let tools_config = ToolsConfig::new(&ToolsConfigParams {
model_info: &model_info,
declared_tool_contract: false,
features: &features,
web_search_mode: Some(WebSearchMode::Cached),
image_generation_tools: false,
memory_tools: false,
session_source: SessionSource::Cli,
});
let (tools, _) = build_specs(
&tools_config,
Some(HashMap::from([(
"test_server/do_something_cool".to_string(),
crate::product::mcp_types::Tool {
name: "do_something_cool".to_string(),
input_schema: ToolInputSchema {
properties: Some(serde_json::json!({
"string_argument": {
"type": "string",
},
"number_argument": {
"type": "number",
},
"object_argument": {
"type": "object",
"properties": {
"string_property": { "type": "string" },
"number_property": { "type": "number" },
},
"required": [
"string_property",
"number_property",
],
"additionalProperties": {
"type": "object",
"properties": {
"addtl_prop": { "type": "string" },
},
"required": [
"addtl_prop",
],
"additionalProperties": false,
},
},
})),
required: None,
r#type: "object".to_string(),
},
output_schema: None,
title: None,
annotations: None,
description: Some("Do something cool".to_string()),
},
)])),
&[],
)
.build();
let tool = find_tool(&tools, "test_server/do_something_cool");
assert_eq!(
tool.spec,
ToolDescriptor::Function(ResponsesApiTool {
name: "test_server/do_something_cool".to_string(),
parameters: JsonSchema::Object {
properties: BTreeMap::from([
(
"string_argument".to_string(),
JsonSchema::String {
description: None,
enum_values: None
}
),
(
"number_argument".to_string(),
JsonSchema::Number { description: None }
),
(
"object_argument".to_string(),
JsonSchema::Object {
properties: BTreeMap::from([
(
"string_property".to_string(),
JsonSchema::String {
description: None,
enum_values: None
}
),
(
"number_property".to_string(),
JsonSchema::Number { description: None }
),
]),
required: Some(vec![
"string_property".to_string(),
"number_property".to_string(),
]),
additional_properties: Some(
JsonSchema::Object {
properties: BTreeMap::from([(
"addtl_prop".to_string(),
JsonSchema::String {
description: None,
enum_values: None
}
),]),
required: Some(vec!["addtl_prop".to_string(),]),
additional_properties: Some(false.into()),
}
.into()
),
},
),
]),
required: None,
additional_properties: None,
},
description: "Do something cool".to_string(),
strict: false,
})
);
}
#[test]
fn chat_tools_include_top_level_name() {
let properties = BTreeMap::from([(
"foo".to_string(),
JsonSchema::String {
description: None,
enum_values: None,
},
)]);
let tools = vec![ToolDescriptor::Function(ResponsesApiTool {
name: "demo".to_string(),
description: "A demo tool".to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: None,
additional_properties: None,
},
})];
let responses_json = create_tools_json_for_responses_api(&tools).unwrap();
assert_eq!(
responses_json,
vec![json!({
"type": "function",
"name": "demo",
"description": "A demo tool",
"strict": false,
"parameters": {
"type": "object",
"properties": {
"foo": { "type": "string" }
},
},
})]
);
let tools_json = create_tools_json_for_chat_completions_api(&tools).unwrap();
assert_eq!(
tools_json,
vec![json!({
"type": "function",
"name": "demo",
"function": {
"name": "demo",
"description": "A demo tool",
"strict": false,
"parameters": {
"type": "object",
"properties": {
"foo": { "type": "string" }
},
},
}
})]
);
}
#[test]
fn messages_tools_support_function_tools() {
let properties = BTreeMap::from([(
"foo".to_string(),
JsonSchema::String {
description: None,
enum_values: None,
},
)]);
let tools = vec![ToolDescriptor::Function(ResponsesApiTool {
name: "demo".to_string(),
description: "A demo tool".to_string(),
strict: false,
parameters: JsonSchema::Object {
properties,
required: None,
additional_properties: None,
},
})];
let tools_json = create_tools_json_for_messages_api(&tools).unwrap();
assert_eq!(tools_json.len(), 1);
assert_eq!(tools_json[0]["name"], "demo");
assert_eq!(tools_json[0]["description"], "A demo tool");
assert!(tools_json[0].get("input_schema").is_some());
}
#[test]
fn messages_tools_reject_local_shell() {
let tools = vec![create_local_shell_tool(true)];
let err =
create_tools_json_for_messages_api(&tools).expect_err("should reject local shell");
assert_eq!(
err.to_string(),
"unsupported operation: Messages API only supports function tools; unsupported tool: local_shell"
);
}
#[test]
fn messages_tools_reject_web_search() {
let tools = vec![ToolDescriptor::WebSearch {
external_web_access: Some(true),
}];
let err = create_tools_json_for_messages_api(&tools).expect_err("should reject web search");
assert_eq!(
err.to_string(),
"unsupported operation: Messages API only supports function tools; unsupported tool: web_search"
);
}
#[test]
fn messages_tools_reject_freeform_tool() {
let tools = vec![create_apply_patch_freeform_tool()];
let err =
create_tools_json_for_messages_api(&tools).expect_err("should reject freeform tools");
assert_eq!(
err.to_string(),
"unsupported operation: Messages API only supports function tools; unsupported tool: apply_patch"
);
}
}