mirror of
https://github.com/pchuan98/codex.git
synced 2026-07-01 00:31:56 +08:00
Matthew ZengandGitHub
8ce48f9968
## Summary - Tighten `tool_suggest` guidance so it prefers explicit plugin install requests, while still allowing a connector install when the relevant plugin is already installed and a needed connector from that plugin is missing. - Tell the model not to call `tool_suggest` in parallel with other tools. ## Testing - `cargo test -p codex-tools tool_suggest` - `cargo test -p codex-core tool_suggest`
206 lines
9.7 KiB
Rust
206 lines
9.7 KiB
Rust
use super::*;
|
|
use crate::JsonSchema;
|
|
use codex_app_server_protocol::AppInfo;
|
|
use pretty_assertions::assert_eq;
|
|
use serde_json::json;
|
|
use std::collections::BTreeMap;
|
|
|
|
#[test]
|
|
fn create_tool_search_tool_deduplicates_and_renders_enabled_sources() {
|
|
assert_eq!(
|
|
create_tool_search_tool(
|
|
&[
|
|
ToolSearchSourceInfo {
|
|
name: "Google Drive".to_string(),
|
|
description: Some(
|
|
"Use Google Drive as the single entrypoint for Drive, Docs, Sheets, and Slides work."
|
|
.to_string(),
|
|
),
|
|
},
|
|
ToolSearchSourceInfo {
|
|
name: "Google Drive".to_string(),
|
|
description: None,
|
|
},
|
|
ToolSearchSourceInfo {
|
|
name: "docs".to_string(),
|
|
description: None,
|
|
},
|
|
],
|
|
/*default_limit*/ 8,
|
|
),
|
|
ToolSpec::ToolSearch {
|
|
execution: "client".to_string(),
|
|
description: "# Tool discovery\n\nSearches over deferred tool metadata with BM25 and exposes matching tools for the next model call.\n\nYou have access to tools from the following sources:\n- Google Drive: Use Google Drive as the single entrypoint for Drive, Docs, Sheets, and Slides work.\n- docs\nSome of the tools may not have been provided to you upfront, and you should use this tool (`tool_search`) to search for the required tools. For MCP tool discovery, always use `tool_search` instead of `list_mcp_resources` or `list_mcp_resource_templates`.".to_string(),
|
|
parameters: JsonSchema::object(BTreeMap::from([
|
|
(
|
|
"limit".to_string(),
|
|
JsonSchema::number(Some(
|
|
"Maximum number of tools to return (defaults to 8)."
|
|
.to_string(),
|
|
),),
|
|
),
|
|
(
|
|
"query".to_string(),
|
|
JsonSchema::string(Some("Search query for deferred tools.".to_string()),),
|
|
),
|
|
]), Some(vec!["query".to_string()]), Some(false.into())),
|
|
}
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn create_tool_suggest_tool_uses_plugin_summary_fallback() {
|
|
let expected_description = concat!(
|
|
"# Tool suggestion discovery\n\n",
|
|
"Use this tool only to ask the user to install one known plugin or connector from the list below. The list contains known candidates that are not currently installed.\n\n",
|
|
"Use this ONLY when all of the following are true:\n",
|
|
"- The user explicitly wants a specific plugin or connector that is not already available in the current context or active `tools` list.\n",
|
|
"- `tool_search` is not available, or it has already been called and did not find or make the requested tool callable.\n",
|
|
"- The tool is one of the known installable plugins or connectors listed below. Only ask to install tools from this list.\n\n",
|
|
"Do not use tool suggestion for adjacent capabilities, broad recommendations, or tools that merely seem useful. The user's intent must clearly match one listed tool.\n\n",
|
|
"Known plugins/connectors available to install:\n",
|
|
"- GitHub (id: `github`, type: plugin, action: install): skills; MCP servers: github-mcp; app connectors: github-app\n",
|
|
"- Slack (id: `slack@openai-curated`, type: connector, action: install): No description provided.\n\n",
|
|
"Workflow:\n\n",
|
|
"1. Check the current context and active `tools` list first. If `tool_search` is available, call `tool_search` before calling `tool_suggest`. Do not use tool suggestion if the needed tool is already available, found through `tool_search`, or callable after discovery.\n",
|
|
"2. Match the user's explicit request against the known plugin/connector list above. Only proceed when one listed plugin or connector exactly fits.\n",
|
|
"3. If we found both connectors and plugins to suggest, use plugins first, only use connectors if the corresponding plugin is installed but the connector is not.\n",
|
|
"4. If one tool clearly fits, call `tool_suggest` with:\n",
|
|
" - `tool_type`: `connector` or `plugin`\n",
|
|
" - `action_type`: `install`\n",
|
|
" - `tool_id`: exact id from the known plugin/connector list above\n",
|
|
" - `suggest_reason`: concise one-line user-facing reason this tool can help with the current request\n",
|
|
"5. After the suggestion flow completes:\n",
|
|
" - if the user finished the install flow, continue by searching again or using the newly available tool\n",
|
|
" - if the user did not finish, continue without that tool, and don't suggest that tool again unless the user explicitly asks for it.\n\n",
|
|
"IMPORTANT: DO NOT call this tool in parallel with other tools.",
|
|
);
|
|
|
|
assert_eq!(
|
|
create_tool_suggest_tool(&[
|
|
ToolSuggestEntry {
|
|
id: "slack@openai-curated".to_string(),
|
|
name: "Slack".to_string(),
|
|
description: None,
|
|
tool_type: DiscoverableToolType::Connector,
|
|
has_skills: false,
|
|
mcp_server_names: Vec::new(),
|
|
app_connector_ids: Vec::new(),
|
|
},
|
|
ToolSuggestEntry {
|
|
id: "github".to_string(),
|
|
name: "GitHub".to_string(),
|
|
description: None,
|
|
tool_type: DiscoverableToolType::Plugin,
|
|
has_skills: true,
|
|
mcp_server_names: vec!["github-mcp".to_string()],
|
|
app_connector_ids: vec!["github-app".to_string()],
|
|
},
|
|
]),
|
|
ToolSpec::Function(ResponsesApiTool {
|
|
name: "tool_suggest".to_string(),
|
|
description: expected_description.to_string(),
|
|
strict: false,
|
|
defer_loading: None,
|
|
parameters: JsonSchema::object(BTreeMap::from([
|
|
(
|
|
"action_type".to_string(),
|
|
JsonSchema::string(Some(
|
|
"Suggested action for the tool. Use \"install\"."
|
|
.to_string(),
|
|
),),
|
|
),
|
|
(
|
|
"suggest_reason".to_string(),
|
|
JsonSchema::string(Some(
|
|
"Concise one-line user-facing reason why this tool can help with the current request."
|
|
.to_string(),
|
|
),),
|
|
),
|
|
(
|
|
"tool_id".to_string(),
|
|
JsonSchema::string(Some(
|
|
"Connector or plugin id to suggest."
|
|
.to_string(),
|
|
),),
|
|
),
|
|
(
|
|
"tool_type".to_string(),
|
|
JsonSchema::string(Some(
|
|
"Type of discoverable tool to suggest. Use \"connector\" or \"plugin\"."
|
|
.to_string(),
|
|
),),
|
|
),
|
|
]), Some(vec![
|
|
"tool_type".to_string(),
|
|
"action_type".to_string(),
|
|
"tool_id".to_string(),
|
|
"suggest_reason".to_string(),
|
|
]), Some(false.into())),
|
|
output_schema: None,
|
|
})
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn discoverable_tool_enums_use_expected_wire_names() {
|
|
assert_eq!(
|
|
json!({
|
|
"tool_type": DiscoverableToolType::Connector,
|
|
"action_type": DiscoverableToolAction::Install,
|
|
}),
|
|
json!({
|
|
"tool_type": "connector",
|
|
"action_type": "install",
|
|
})
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn filter_tool_suggest_discoverable_tools_for_codex_tui_omits_plugins() {
|
|
let discoverable_tools = vec![
|
|
DiscoverableTool::Connector(Box::new(AppInfo {
|
|
id: "connector_google_calendar".to_string(),
|
|
name: "Google Calendar".to_string(),
|
|
description: Some("Plan events and schedules.".to_string()),
|
|
logo_url: None,
|
|
logo_url_dark: None,
|
|
distribution_channel: None,
|
|
branding: None,
|
|
app_metadata: None,
|
|
labels: None,
|
|
install_url: Some("https://example.test/google-calendar".to_string()),
|
|
is_accessible: false,
|
|
is_enabled: true,
|
|
plugin_display_names: Vec::new(),
|
|
})),
|
|
DiscoverableTool::Plugin(Box::new(DiscoverablePluginInfo {
|
|
id: "slack@openai-curated".to_string(),
|
|
name: "Slack".to_string(),
|
|
description: Some("Search Slack messages".to_string()),
|
|
has_skills: true,
|
|
mcp_server_names: vec!["slack".to_string()],
|
|
app_connector_ids: vec!["connector_slack".to_string()],
|
|
})),
|
|
];
|
|
|
|
assert_eq!(
|
|
filter_tool_suggest_discoverable_tools_for_client(discoverable_tools, Some("codex-tui"),),
|
|
vec![DiscoverableTool::Connector(Box::new(AppInfo {
|
|
id: "connector_google_calendar".to_string(),
|
|
name: "Google Calendar".to_string(),
|
|
description: Some("Plan events and schedules.".to_string()),
|
|
logo_url: None,
|
|
logo_url_dark: None,
|
|
distribution_channel: None,
|
|
branding: None,
|
|
app_metadata: None,
|
|
labels: None,
|
|
install_url: Some("https://example.test/google-calendar".to_string()),
|
|
is_accessible: false,
|
|
is_enabled: true,
|
|
plugin_display_names: Vec::new(),
|
|
}))]
|
|
);
|
|
}
|