Skip to content

feat: add openAiNativeToolsEnabled setting for OpenAI-Compatible provider #10887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
roomote wants to merge 1 commit into from
Closed

feat: add openAiNativeToolsEnabled setting for OpenAI-Compatible provider #10887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/types/src/provider-settings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,10 @@ const openAiSchema = baseProviderSettingsSchema.extend({
openAiStreamingEnabled: z.boolean().optional(),
openAiHostHeader: z.string().optional(), // Keep temporarily for backward compatibility during migration.
openAiHeaders: z.record(z.string(), z.string()).optional(),
// When true (default), native function calling is used. When false, tools are not passed
// to the API, allowing users with local providers that don't support native tool calling
// to use XML-style tool invocation via the system prompt instead.
openAiNativeToolsEnabled: z.boolean().optional(),
})

const ollamaSchema = baseProviderSettingsSchema.extend({
Expand Down
54 changes: 37 additions & 17 deletions src/api/providers/openai.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,11 @@ export class OpenAiHandler extends BaseProvider implements SingleCompletionHandl
const enabledR1Format = this.options.openAiR1FormatEnabled ?? false
const isAzureAiInference = this._isAzureAiInference(modelUrl)
const deepseekReasoner = modelId.includes("deepseek-reasoner") || enabledR1Format
// Default to true for backward compatibility - when false, tools are not passed to the API
const nativeToolsEnabled = this.options.openAiNativeToolsEnabled !== false
Copy link
Contributor Author

@roomote roomote bot Jan 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new openAiNativeToolsEnabled: false code path lacks test coverage. The existing tests pass because they only exercise the default (true) behavior. Consider adding a test case that verifies tools/tool_choice/parallel_tool_calls are NOT included in the API request when this setting is false. This would help prevent regressions and document the expected behavior.

Fix it with Roo Code or mention @roomote and request a fix.


if (modelId.includes("o1") || modelId.includes("o3") || modelId.includes("o4")) {
yield* this.handleO3FamilyMessage(modelId, systemPrompt, messages, metadata)
yield* this.handleO3FamilyMessage(modelId, systemPrompt, messages, metadata, nativeToolsEnabled)
return
}

Expand Down Expand Up @@ -159,9 +161,14 @@ export class OpenAiHandler extends BaseProvider implements SingleCompletionHandl
stream: true as const,
...(isGrokXAI ? {} : { stream_options: { include_usage: true } }),
...(reasoning && reasoning),
tools: this.convertToolsForOpenAI(metadata?.tools),
tool_choice: metadata?.tool_choice,
parallel_tool_calls: metadata?.parallelToolCalls ?? false,
// Only include tools if native tool calling is enabled
...(nativeToolsEnabled
? {
tools: this.convertToolsForOpenAI(metadata?.tools),
tool_choice: metadata?.tool_choice,
parallel_tool_calls: metadata?.parallelToolCalls ?? false,
}
: {}),
}

// Add max_tokens if needed
Expand Down Expand Up @@ -226,10 +233,14 @@ export class OpenAiHandler extends BaseProvider implements SingleCompletionHandl
messages: deepseekReasoner
? convertToR1Format([{ role: "user", content: systemPrompt }, ...messages])
: [systemMessage, ...convertToOpenAiMessages(messages)],
// Tools are always present (minimum ALWAYS_AVAILABLE_TOOLS)
tools: this.convertToolsForOpenAI(metadata?.tools),
tool_choice: metadata?.tool_choice,
parallel_tool_calls: metadata?.parallelToolCalls ?? false,
// Only include tools if native tool calling is enabled
...(nativeToolsEnabled
? {
tools: this.convertToolsForOpenAI(metadata?.tools),
tool_choice: metadata?.tool_choice,
parallel_tool_calls: metadata?.parallelToolCalls ?? false,
}
: {}),
}

// Add max_tokens if needed
Expand Down Expand Up @@ -324,7 +335,8 @@ export class OpenAiHandler extends BaseProvider implements SingleCompletionHandl
modelId: string,
systemPrompt: string,
messages: Anthropic.Messages.MessageParam[],
metadata?: ApiHandlerCreateMessageMetadata,
metadata: ApiHandlerCreateMessageMetadata | undefined,
nativeToolsEnabled: boolean,
): ApiStream {
const modelInfo = this.getModel().info
const methodIsAzureAiInference = this._isAzureAiInference(this.options.openAiBaseUrl)
Expand All @@ -345,10 +357,14 @@ export class OpenAiHandler extends BaseProvider implements SingleCompletionHandl
...(isGrokXAI ? {} : { stream_options: { include_usage: true } }),
reasoning_effort: modelInfo.reasoningEffort as "low" | "medium" | "high" | undefined,
temperature: undefined,
// Tools are always present (minimum ALWAYS_AVAILABLE_TOOLS)
tools: this.convertToolsForOpenAI(metadata?.tools),
tool_choice: metadata?.tool_choice,
parallel_tool_calls: metadata?.parallelToolCalls ?? false,
// Only include tools if native tool calling is enabled
...(nativeToolsEnabled
? {
tools: this.convertToolsForOpenAI(metadata?.tools),
tool_choice: metadata?.tool_choice,
parallel_tool_calls: metadata?.parallelToolCalls ?? false,
}
: {}),
}

// O3 family models do not support the deprecated max_tokens parameter
Expand Down Expand Up @@ -379,10 +395,14 @@ export class OpenAiHandler extends BaseProvider implements SingleCompletionHandl
],
reasoning_effort: modelInfo.reasoningEffort as "low" | "medium" | "high" | undefined,
temperature: undefined,
// Tools are always present (minimum ALWAYS_AVAILABLE_TOOLS)
tools: this.convertToolsForOpenAI(metadata?.tools),
tool_choice: metadata?.tool_choice,
parallel_tool_calls: metadata?.parallelToolCalls ?? false,
// Only include tools if native tool calling is enabled
...(nativeToolsEnabled
? {
tools: this.convertToolsForOpenAI(metadata?.tools),
tool_choice: metadata?.tool_choice,
parallel_tool_calls: metadata?.parallelToolCalls ?? false,
}
: {}),
}

// O3 family models do not support the deprecated max_tokens parameter
Expand Down
Loading