-
Notifications
You must be signed in to change notification settings - Fork 15
refactor: clarify tool input coercion #380
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.
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
Open
posva
wants to merge
2
commits into
main
Choose a base branch
from
refactor/tool-input-positional-args
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| import { describe, expect, it } from 'vitest' | ||
| import { toolInputToCommandArgs, toolInputToRpcArgs } from '../tool-input' | ||
|
|
||
| describe('tool input positional arguments', () => { | ||
| it('passes arrays through and maps argN keys using the declared count', () => { | ||
| expect(toolInputToRpcArgs([1, 2], 2)).toEqual([1, 2]) | ||
| expect(toolInputToRpcArgs({ arg0: 'a', arg1: 'b' }, 2)).toEqual(['a', 'b']) | ||
| expect(toolInputToRpcArgs({ arg0: 'a' }, 0)).toEqual([]) | ||
| }) | ||
|
|
||
| it('collects contiguous argN keys without a declared count', () => { | ||
| expect(toolInputToRpcArgs({ arg0: 1, arg1: 2 })).toEqual([1, 2]) | ||
| }) | ||
|
|
||
| it('treats null, undefined, and empty objects as zero-argument calls', () => { | ||
| expect(toolInputToRpcArgs(undefined)).toEqual([]) | ||
| expect(toolInputToRpcArgs(null, 1)).toEqual([]) | ||
| expect(toolInputToRpcArgs({})).toEqual([]) | ||
| }) | ||
|
|
||
| it('preserves undeclared RPC input as one argument', () => { | ||
| const input = { name: 'devframe' } | ||
| expect(toolInputToRpcArgs(input)).toEqual([input]) | ||
| }) | ||
|
|
||
| it('drops undeclared command input', () => { | ||
| expect(toolInputToCommandArgs({ name: 'devframe' })).toEqual([]) | ||
| }) | ||
| }) | ||
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
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
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /** | ||
| * Convert an object-shaped tool input into positional arguments. | ||
| * | ||
| * Tool schemas expose positional parameters as `arg0`, `arg1`, and so on. | ||
| * Arrays pass through for callers that already provide positional arguments. | ||
| */ | ||
| function collectPositionalArgs(input: unknown, argumentCount: number | undefined): unknown[] | undefined { | ||
| if (Array.isArray(input)) | ||
| return input | ||
| if (input === undefined || input === null) | ||
| return [] | ||
| if (typeof input !== 'object') | ||
| return undefined | ||
|
|
||
| const record = input as Record<string, unknown> | ||
| if (argumentCount != null) | ||
| return Array.from({ length: argumentCount }, (_, index) => record[`arg${index}`]) | ||
| if ('arg0' in record) { | ||
| const positional: unknown[] = [] | ||
| while (`arg${positional.length}` in record) | ||
| positional.push(record[`arg${positional.length}`]) | ||
| return positional | ||
| } | ||
| return Object.keys(record).length === 0 ? [] : undefined | ||
| } | ||
|
|
||
| /** Convert tool input for an RPC, preserving an untyped payload as arg 0. */ | ||
| export function toolInputToRpcArgs(input: unknown, argumentCount?: number): unknown[] { | ||
| return collectPositionalArgs(input, argumentCount) ?? [input] | ||
| } | ||
|
|
||
| /** Convert tool input for a command, whose arguments must be declared. */ | ||
| export function toolInputToCommandArgs(input: unknown, argumentCount?: number): unknown[] { | ||
| return collectPositionalArgs(input, argumentCount) ?? [] | ||
| } | ||
|
|
||
| /** @deprecated Use {@link toolInputToRpcArgs} or {@link toolInputToCommandArgs}. */ | ||
| export type AgentArgsFallback = 'wrap' | 'drop' | ||
|
|
||
| /** @deprecated Use {@link toolInputToRpcArgs} or {@link toolInputToCommandArgs}. */ | ||
| export function coerceAgentPositionalArgs( | ||
| input: unknown, | ||
| schemas: readonly unknown[] | undefined, | ||
| fallback: AgentArgsFallback = 'wrap', | ||
| ): unknown[] { | ||
| const argumentCount = schemas?.length | ||
| return fallback === 'drop' | ||
| ? toolInputToCommandArgs(input, argumentCount) | ||
| : toolInputToRpcArgs(input, argumentCount) | ||
| } |
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.