Skip to content

fix: support JSON Schema extension keywords and properly infer required fields #406

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

Merged
kmile merged 1 commit into from
Apr 4, 2025
Merged

fix: support JSON Schema extension keywords and properly infer required fields #406

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
24 changes: 24 additions & 0 deletions runtimes/runtimes/agent.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,21 @@ describe('Agent Tools', () => {
required: ['test'],
},
} as const

const SOME_TOOL_SPEC_WITH_EXTENSIONS = {
name: 'test',
description: 'test',
inputSchema: {
type: 'object',
properties: {
test: {
type: 'string',
},
},
required: ['test'],
someExtension: true,
},
} as const
const SOME_TOOL_HANDLER = async (_: { test: string }) => true

beforeEach(() => {
Expand Down Expand Up @@ -91,4 +106,13 @@ describe('Agent Tools', () => {
assert.equal(tools[0].description, SOME_TOOL_SPEC.description)
assert.equal(tools[0].inputSchema, SOME_TOOL_SPEC.inputSchema)
})

it('should support JSON Schema extension keywords', () => {
AGENT.addTool(SOME_TOOL_SPEC_WITH_EXTENSIONS, SOME_TOOL_HANDLER)
const tools = AGENT.getTools({ format: 'bedrock' })
assert.equal(
tools[0].toolSpecification.inputSchema.json['someExtension'],
SOME_TOOL_SPEC_WITH_EXTENSIONS.inputSchema.someExtension
)
})
})
2 changes: 1 addition & 1 deletion runtimes/runtimes/agent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ type Tool<T, R> = {

export const newAgent = (): Agent => {
const tools: Record<string, Tool<any, any>> = {}
const ajv = new Ajv()
const ajv = new Ajv({ strictSchema: false })

return {
addTool: <T extends InferSchema<S['inputSchema']>, S extends ToolSpec>(
Expand Down
15 changes: 12 additions & 3 deletions runtimes/server-interface/agent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ interface BaseSchema {
$id?: string
$schema?: string
definitions?: Record<string, JSONSchema>
[extensionKeywords: string]: any
}

interface StringSchema extends BaseSchema {
Expand Down Expand Up @@ -74,9 +75,17 @@ type InferArray<T extends { type: 'array'; items: any }> = T['items'] extends {
? InferSchema<T['items']>[]
: never

type InferObject<T extends { type: 'object'; properties: Record<string, any> }> = {
[K in keyof T['properties']]?: InferSchema<T['properties'][K]>
} & (T extends { required: string[] } ? { [K in T['required'][number]]: InferSchema<T['properties'][K]> } : unknown)
type InferObject<T extends { type: 'object'; properties: Record<string, any> }> = T extends {
required: readonly string[]
}
? {
[K in keyof T['properties'] as K extends T['required'][number] ? K : never]: InferSchema<T['properties'][K]>
} & {
[K in keyof T['properties'] as K extends T['required'][number] ? never : K]?: InferSchema<T['properties'][K]>
}
: {
[K in keyof T['properties']]?: InferSchema<T['properties'][K]>
}

export type InferSchema<T> = T extends { type: 'array'; items: any }
? InferArray<T>
Expand Down