feat(agent-kit): render per-variant output instructions for discriminated oneOf

buildOutputFormatInstruction now detects discriminated union schemas
(oneOf with shared const/ property) and renders separate YAML
example blocks per variant, so agents see exactly which fields belong
to which outcome instead of a flat merge.

Non-discriminated oneOf/anyOf schemas fall back to the existing flat
merge behavior.

Refs #502
This commit is contained in:
2026-05-25 06:54:09 +00:00
parent 827ff13c4a
commit dfb6fda06d
2 changed files with 158 additions and 4 deletions
@@ -87,7 +87,7 @@ describe("buildOutputFormatInstruction", () => {
expect(result).toContain("beta: <number>");
});
test("lists union of fields from a oneOf schema", () => {
test("lists union of fields from a oneOf schema (no discriminant — flat merge)", () => {
const schema = {
oneOf: [
{
@@ -101,12 +101,71 @@ describe("buildOutputFormatInstruction", () => {
],
};
const result = buildOutputFormatInstruction(schema);
// No discriminant detected → falls back to flat merge
expect(result).toContain("`foo`");
expect(result).toContain("`bar`");
expect(result).toContain("foo: <string>");
expect(result).toContain("bar: true # true | false");
});
test("renders per-variant instructions for discriminated oneOf", () => {
const schema = {
oneOf: [
{
type: "object",
properties: {
$status: { const: "ready" },
plan: { type: "string" },
},
required: ["$status", "plan"],
},
{
type: "object",
properties: {
$status: { const: "insufficient_info" },
},
required: ["$status"],
},
],
};
const result = buildOutputFormatInstruction(schema);
expect(result).toContain("Choose ONE of the following variants");
expect(result).toContain("When `$status: ready`");
expect(result).toContain("When `$status: insufficient_info`");
expect(result).toContain("plan: <string>");
// The insufficient_info variant should NOT mention plan
const insufficientBlock = result.split("When `$status: insufficient_info`")[1];
expect(insufficientBlock).not.toContain("plan:");
});
test("renders per-variant for single-enum discriminant", () => {
const schema = {
oneOf: [
{
type: "object",
properties: {
$status: { type: "string", enum: ["approved"] },
branch: { type: "string" },
},
required: ["$status"],
},
{
type: "object",
properties: {
$status: { type: "string", enum: ["rejected"] },
comments: { type: "string" },
},
required: ["$status"],
},
],
};
const result = buildOutputFormatInstruction(schema);
expect(result).toContain("When `$status: approved`");
expect(result).toContain("When `$status: rejected`");
expect(result).toContain("branch: <string>");
expect(result).toContain("comments: <string>");
});
test("falls back gracefully for a non-object schema with no properties", () => {
const result = buildOutputFormatInstruction({ type: "string" });
expect(result).toContain("schema fields will be extracted automatically");
@@ -166,14 +166,109 @@ function buildFieldList(properties: SchemaProperty[]): string {
.join("\n");
}
/**
* Detect the discriminant property name from a oneOf schema.
* Returns the property name if all variants share a const/single-enum string property, else null.
*/
function detectDiscriminant(variants: JSONSchema[]): string | null {
// Find property names that appear in ALL variants with const or single-enum
const candidateNames = new Set<string>();
for (const variant of variants) {
const props = variant.properties as Record<string, JSONSchema> | null | undefined;
if (typeof props !== "object" || props === null) return null;
for (const [name, propSchema] of Object.entries(props)) {
const isConst =
propSchema.const !== undefined ||
(Array.isArray(propSchema.enum) && propSchema.enum.length === 1);
if (isConst) candidateNames.add(name);
}
}
// Check which candidate appears in ALL variants
for (const name of candidateNames) {
const allHaveIt = variants.every((v) => {
const props = v.properties as Record<string, JSONSchema> | null | undefined;
if (typeof props !== "object" || props === null) return false;
const propSchema = props[name];
if (!propSchema) return false;
return (
propSchema.const !== undefined ||
(Array.isArray(propSchema.enum) && propSchema.enum.length === 1)
);
});
if (allHaveIt) return name;
}
return null;
}
function getConstValue(propSchema: JSONSchema): string {
if (propSchema.const !== undefined) return String(propSchema.const);
if (Array.isArray(propSchema.enum) && propSchema.enum.length === 1)
return String(propSchema.enum[0]);
return "<unknown>";
}
function buildVariantBlock(variant: JSONSchema, discriminant: string): string {
const props = extractSchemaProperties(variant);
const value = getConstValue(
((variant.properties as Record<string, JSONSchema>) ?? {})[discriminant] ?? {},
);
const yamlExample = buildYamlExampleBlock(props);
const fieldList = buildFieldList(props);
return `### When \`${discriminant}: ${value}\`
\`\`\`
${yamlExample}
\`\`\`
Fields:
${fieldList}`;
}
/**
* Build a concise output format instruction block for an agent role.
*
* The instruction describes the expected frontmatter markdown format and lists
* the meta fields derived from the JSON Schema. It is prepended to the agent's
* system prompt so the deliverable format is the first thing the agent sees.
* For discriminated union schemas (oneOf with a shared const/$status field),
* renders per-variant instructions so the agent knows exactly which fields
* belong to which outcome.
*
* For flat object schemas, renders a single YAML example block.
*/
export function buildOutputFormatInstruction(schema: JSONSchema): string {
// Check for discriminated union (oneOf with shared discriminant)
const unionKey = Array.isArray(schema.oneOf)
? "oneOf"
: Array.isArray(schema.anyOf)
? "anyOf"
: null;
if (unionKey !== null) {
const variants = schema[unionKey] as JSONSchema[];
const discriminant = detectDiscriminant(variants);
if (discriminant !== null && variants.length > 1) {
const variantBlocks = variants.map((v) => buildVariantBlock(v, discriminant)).join("\n\n");
return `## Deliverable Format
Your response MUST begin with a YAML frontmatter block followed by your markdown work.
Choose ONE of the following variants based on your outcome:
${variantBlocks}
The frontmatter is the **primary deliverable** — the engine reads it directly.
Output ONLY the fields listed for your chosen variant. Do not add extra fields that are not specified in the schema.
Focus exclusively on YOUR role's deliverable. Do not perform actions outside your role's scope.`;
}
}
// Flat object schema fallback
const properties = extractSchemaProperties(schema);
const yamlExample = buildYamlExampleBlock(properties);
const fieldList = buildFieldList(properties);