Skip to content

Expose avatar handle constraints in tool schemas #14

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
chasehuh merged 1 commit into from
Jul 6, 2026
Merged

Expose avatar handle constraints in tool schemas #14

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
38 changes: 27 additions & 11 deletions src/lib/tool-registry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,26 @@ type StaticToolDefinition = {

const booleanProperty = { type: "boolean" };
const stringProperty = { type: "string" };
const avatarHandlePattern =
"^@?(?![._])(?!.*[._]$)(?!.*[._]{2})[A-Za-z0-9._]{2,30}$";
const avatarHandleProperty = {
...stringProperty,
minLength: 2,
maxLength: 31,
pattern: avatarHandlePattern,
description:
"Public avatar handle, with optional leading @. Sume normalizes handles to lowercase. Use letters, numbers, dot, or underscore; do not start/end with dot or underscore; do not use consecutive dots/underscores.",
};
const avatarCreateHandleProperty = {
...avatarHandleProperty,
description:
`${avatarHandleProperty.description} User-created Avatar handles cannot use the reserved sume_ prefix.`,
};
const avatarCreateHandleAliasProperty = {
...avatarCreateHandleProperty,
description:
"Alias for avatar_handle with the same constraints: optional leading @, lowercase normalization, letters/numbers/dot/underscore, no first/last/consecutive dot or underscore, and no reserved sume_ prefix for user-created Avatars.",
};
const agentOutputProperties = {
agent: {
...booleanProperty,
Expand Down Expand Up @@ -178,9 +198,7 @@ const mcpAvatarCreateBaseProperties = {
"Optional exact Avatar model-run id. Omit to use the primary Avatar 1.0 generate route.",
},
avatar_handle: {
...stringProperty,
minLength: 1,
description: "Desired canonical public avatar handle, without @.",
...avatarCreateHandleProperty,
},
...mcpAvatarCommunicationProperties,
};
Expand Down Expand Up @@ -1023,12 +1041,10 @@ const staticToolDefinitions: Record<string, StaticToolDefinition> = {
description: "Avatar request type.",
},
avatar_handle: {
...stringProperty,
description: "Desired canonical public avatar handle, without @.",
...avatarCreateHandleProperty,
},
handle: {
...stringProperty,
description: "Alias for avatar_handle.",
...avatarCreateHandleAliasProperty,
},
prompt: {
...stringProperty,
Expand Down Expand Up @@ -1354,8 +1370,8 @@ const staticToolDefinitions: Record<string, StaticToolDefinition> = {
description: "Optional product/reference image URL for the public API request.",
},
avatar_handle: {
...stringProperty,
description: "Ready avatar handle to use in the video.",
...avatarHandleProperty,
description: `${avatarHandleProperty.description} Ready avatar handle to use in the video.`,
},
scene_prompt: {
...stringProperty,
Expand Down Expand Up @@ -1397,8 +1413,8 @@ const staticToolDefinitions: Record<string, StaticToolDefinition> = {
"Optional public HTTPS product/reference image URL.",
},
avatar_handle: {
...stringProperty,
description: "Ready avatar handle, with or without @.",
...avatarHandleProperty,
description: `${avatarHandleProperty.description} Ready avatar handle for the video.`,
},
scene_prompt: {
...stringProperty,
Expand Down
26 changes: 23 additions & 3 deletions test/cli.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import { describe, expect, it } from "vitest";

const tsx = "node_modules/.bin/tsx";
const execFileAsync = promisify(execFile);
const avatarHandlePattern =
"^@?(?![._])(?!.*[._]$)(?!.*[._]{2})[A-Za-z0-9._]{2,30}$";

type ApiRequest = {
body: unknown;
Expand Down Expand Up @@ -660,8 +662,20 @@ describe("CLI", () => {
"sume/avatar/v1",
]),
}),
avatar_handle: expect.objectContaining({ type: "string" }),
handle: expect.objectContaining({ type: "string" }),
avatar_handle: expect.objectContaining({
type: "string",
minLength: 2,
maxLength: 31,
pattern: avatarHandlePattern,
description: expect.stringContaining("reserved sume_ prefix"),
}),
handle: expect.objectContaining({
type: "string",
minLength: 2,
maxLength: 31,
pattern: avatarHandlePattern,
description: expect.stringContaining("Alias for avatar_handle"),
}),
image_url: expect.objectContaining({ type: "string" }),
},
},
Expand Down Expand Up @@ -883,7 +897,13 @@ describe("CLI", () => {
"sume/avatar/v1",
]),
}),
avatar_handle: expect.objectContaining({ type: "string" }),
avatar_handle: expect.objectContaining({
type: "string",
minLength: 2,
maxLength: 31,
pattern: avatarHandlePattern,
description: expect.stringContaining("optional leading @"),
}),
handle: expect.objectContaining({ type: "string" }),
image_url: expect.objectContaining({ type: "string" }),
type: expect.objectContaining({
Expand Down
Loading