fix(ai-chat): sanitize tool schemas for GitHub Copilot LSP#1279
Merged
Conversation
…ma-sanitize # Conflicts: # CHANGELOG.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
GitHub Copilot tool registration fails with schema validation errors:
Copilot's LSP schema validator requires every
typeto be a single string. Our sharedChatToolSchemaBuilderemitstype: ["string", "null"]for optional fields (required by OpenAI strict mode), which Copilot rejects.Provider research
Audited every AI provider for tool schema acceptance:
type: [X, null]additionalPropertiesfalsefunction_declarationsGeminiProvider.sanitizeSchemaForGeminiThe shared schema builder cannot be changed because OpenAI strict mode requires the current format. Each strict provider sanitizes at its egress point.
Fix
ChatToolSpec+Copilot.swift— replacednormalizeForCopilot(which only added an emptyrequiredarray) withsanitizeForCopilot:typeis[X, "null"]:type: X(single string)nullfrom any companionenumarrayrequiredarray (so Copilot understands the field is optional via standard JSON Schema semantics)Plain
type: "string"properties andrequiredfields are untouched.additionalPropertiesis preserved (Copilot accepts it).Tests
6 new tests in
CopilotSchemaSanitizationTests:rewritesOptionalScalar—[X, null]becomesX, field dropped from requiredpreservesRequiredFields— non-nullable scalars stay in requiredstripsNullFromEnum— enum arrays lose null membersmixedRequiredAndOptional— selective drop, doesn't affect non-nullable siblingsrecursesIntoNested— nested object schemas also sanitizedrealBuilderOutputIsValid— feeds an actualChatToolSchemaBuilderoutput through and asserts notypearrays remain and optional fields are excluded from requiredAll pass on both arm64 and x86_64.
Test plan