feat: support additional schemas via additionalSchemas parameter #166
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| import { describe, it, expect, vi } from "vitest"; | ||
| import type { ToolResult } from "../../src/utils/response-formatter.js"; | ||
| import type { SchemaEntry } from "../../src/data/schemas/index.js"; | ||
| import { registerSchemaTool } from "../../src/tools/harness-schema.js"; | ||
|
|
||
| function entry(schema: Record<string, any>): SchemaEntry { | ||
| return { schema, description: "test", group: "test" }; | ||
| } | ||
|
|
||
| function makeMcpServer() { | ||
| const tools = new Map<string, { handler: (...args: unknown[]) => Promise<ToolResult> }>(); | ||
| return { | ||
| registerTool: vi.fn((name: string, _schema: unknown, handler: (...args: unknown[]) => Promise<ToolResult>) => { | ||
| tools.set(name, { handler }); | ||
| }), | ||
| async call(name: string, args: Record<string, unknown>): Promise<ToolResult> { | ||
| const tool = tools.get(name); | ||
| if (!tool) throw new Error(`Tool "${name}" not registered`); | ||
| const extra = { signal: new AbortController().signal, sendNotification: vi.fn(), _meta: {} }; | ||
| return tool.handler(args, extra) as Promise<ToolResult>; | ||
| }, | ||
| } as any; | ||
| } | ||
|
|
||
| function parseResult(result: ToolResult): unknown { | ||
| return JSON.parse(result.content[0]!.text); | ||
| } | ||
|
|
||
| describe("registerSchemaTool additionalSchemas", () => { | ||
|
Contributor
There was a problem hiding this comment. Important: these new cases only prove that the internal helper works when called directly. They do not exercise Please add at least one test or smoke check that goes through the real bootstrap and verifies the extra schema is visible from the actual exported server surface, not just from |
||
| it("accepts additionalSchemas without throwing", () => { | ||
| const server = makeMcpServer(); | ||
| expect(() => | ||
| registerSchemaTool(server, { DashboardContract: entry({ type: "object", properties: { id: { type: "string" } } }) }) | ||
| ).not.toThrow(); | ||
| }); | ||
|
|
||
| it("registers without additionalSchemas (backwards compat)", () => { | ||
| const server = makeMcpServer(); | ||
| expect(() => registerSchemaTool(server)).not.toThrow(); | ||
| }); | ||
|
|
||
| it("throws when additionalSchemas key collides with a built-in schema name", () => { | ||
| const server = makeMcpServer(); | ||
| expect(() => | ||
| registerSchemaTool(server, { pipeline: entry({ type: "object" }) }), | ||
| ).toThrow("conflicts with a built-in schema name"); | ||
| }); | ||
|
|
||
| it("handler returns fields from a Harness-layout extension schema (definitions[type][type])", async () => { | ||
| const server = makeMcpServer(); | ||
| const dashboardSchema = entry({ | ||
| definitions: { | ||
| DashboardContract: { | ||
| DashboardContract: { | ||
| type: "object", | ||
| properties: { title: { type: "string" }, widgets: { type: "array" } }, | ||
| required: ["title"], | ||
| }, | ||
| }, | ||
| }, | ||
| }); | ||
| registerSchemaTool(server, { DashboardContract: dashboardSchema }); | ||
|
|
||
| const result = await server.call("harness_schema", { resource_type: "DashboardContract" }); | ||
| const parsed = parseResult(result) as Record<string, unknown>; | ||
|
|
||
| expect(parsed.resource_type).toBe("DashboardContract"); | ||
| expect(parsed.fields).toEqual([ | ||
| { name: "title", type: "string", required: true }, | ||
| { name: "widgets", type: "array", required: false }, | ||
| ]); | ||
| }); | ||
|
|
||
| it("handler returns fields from a plain JSON Schema extension schema (root-level properties)", async () => { | ||
| const server = makeMcpServer(); | ||
| registerSchemaTool(server, { | ||
| MyExtension: entry({ | ||
| type: "object", | ||
| properties: { name: { type: "string" }, count: { type: "number" } }, | ||
| required: ["name"], | ||
| }), | ||
| }); | ||
|
|
||
| const result = await server.call("harness_schema", { resource_type: "MyExtension" }); | ||
| const parsed = parseResult(result) as Record<string, unknown>; | ||
|
|
||
| expect(parsed.resource_type).toBe("MyExtension"); | ||
| expect(parsed.fields).toEqual([ | ||
| { name: "name", type: "string", required: true }, | ||
| { name: "count", type: "number", required: false }, | ||
| ]); | ||
| }); | ||
|
|
||
| it("handler still returns built-in schema content when no additionalSchemas", async () => { | ||
| const server = makeMcpServer(); | ||
| registerSchemaTool(server); | ||
|
|
||
| const result = await server.call("harness_schema", { resource_type: "pipeline" }); | ||
| const parsed = parseResult(result) as Record<string, unknown>; | ||
|
|
||
| expect(parsed.resource_type).toBe("pipeline"); | ||
| expect(Array.isArray(parsed.fields)).toBe(true); | ||
| }); | ||
| }); | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This merge silently allows an extension schema to shadow a built-in name after only logging a warning. That means callers can replace canonical contracts like
pipelineortriggerin bothschema:///...andharness_schema(...), which is the opposite of the repo's fail-loud guidance. Duplicate keys should throw instead of overriding built-ins.