Skip to content

The open-source agent harness - the runtime layer that turns an LLM into a working agent.

AGE-1683: Add custom catalog sentinel with supported_reasoning_efforts (#143)

Bhavesh Patel27c2cd175579
diff --git a/.github/fern/openapi/openapi.json b/.github/fern/openapi/openapi.json
index 45659354d..a4dc2a388 100644
--- a/.github/fern/openapi/openapi.json
+++ b/.github/fern/openapi/openapi.json
@@ -388,6 +388,29 @@
"properties": {},
"type": "object"
},
+ "CatalogCustomModelProvider": {
+ "additionalProperties": false,
+ "properties": {
+ "supported_reasoning_efforts": {
+ "description": "Supported reasoning-effort values for this provider",
+ "items": {
+ "$ref": "#/components/schemas/ReasoningEffort"
+ },
+ "type": "array"
+ },
+ "type": {
+ "enum": [
+ "custom"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "supported_reasoning_efforts"
+ ],
+ "type": "object"
+ },
"CatalogDaytonaSandboxProvider": {
"additionalProperties": false,
"properties": {
@@ -471,46 +494,15 @@
],
"type": "object"
},
- "CatalogProvider": {
- "additionalProperties": false,
- "properties": {
- "logo": {
- "description": "URL of the provider logo asset.",
- "format": "uri",
- "type": "string"
- },
- "models": {
- "description": "Preset models for this catalog provider.",
- "items": {
- "$ref": "#/components/schemas/ModelEntry"
- },
- "minItems": 1,
- "type": "array"
- },
- "name": {
- "$ref": "#/components/schemas/ResourceName"
+ "CatalogModelProvider": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/CatalogWellKnownModelProvider"
},
- "type": {
- "description": "Well-known provider type (catalog excludes `custom`).",
- "enum": [
- "openai",
- "anthropic",
- "google-gemini",
- "fireworks",
- "zai",
- "moonshot",
- "alibaba",
- "together"
- ],
- "type": "string"
+ {
+ "$ref": "#/components/schemas/CatalogCustomModelProvider"
}
- },
- "required": [
- "type",
- "name",
- "models"
- ],
- "type": "object"
+ ]
},
"CatalogSkill": {
"additionalProperties": false,
@@ -554,6 +546,44 @@
],
"type": "object"
},
+ "CatalogWellKnownModelProvider": {
+ "additionalProperties": false,
+ "properties": {
+ "logo": {
+ "description": "URL of the provider logo asset",
+ "format": "uri",
+ "type": "string"
+ },
+ "models": {
+ "description": "Preset models",
+ "items": {
+ "$ref": "#/components/schemas/ModelEntry"
+ },
+ "type": "array"
+ },
+ "type": {
+ "$ref": "#/components/schemas/CatalogWellKnownModelProviderType"
+ }
+ },
+ "required": [
+ "type",
+ "models"
+ ],
+ "type": "object"
+ },
+ "CatalogWellKnownModelProviderType": {
+ "enum": [
+ "openai",
+ "anthropic",
+ "google-gemini",
+ "fireworks",
+ "zai",
+ "moonshot",
+ "alibaba",
+ "together"
+ ],
+ "type": "string"
+ },
"ChatCompletionChunkDeltaToolCall": {
"properties": {
"function": {
@@ -1119,7 +1149,7 @@
"properties": {
"data": {
"items": {
- "$ref": "#/components/schemas/CatalogProvider"
+ "$ref": "#/components/schemas/CatalogModelProvider"
},
"type": "array"
}
@@ -6406,7 +6436,7 @@
},
"/api/v1/settings/model-providers/catalog": {
"get": {
- "description": "Provider and model presets shipped with the server (model-catalog.yaml). Discovery-only: an entry becomes a PUT /settings/model-providers body once the catalog-only `logo` and `name` are dropped and `auth` is added. Custom providers are not listed here.",
+ "description": "Provider and model presets shipped with the server (model-catalog.yaml). Discovery-only: an entry becomes a PUT /settings/model-providers body once the catalog-only `logo` and `name` are dropped and `auth` is added. Includes a `custom` sentinel with `supported_reasoning_efforts` for the custom-provider form (not configurable from catalog).",
"responses": {
"200": {
"content": {
diff --git a/docs/openapi.json b/docs/openapi.json
index 59b48eb5a..413b14456 100644
--- a/docs/openapi.json
+++ b/docs/openapi.json
@@ -388,6 +388,30 @@
"properties": {},
"type": "object"
},
+ "CatalogCustomModelProvider": {
+ "additionalProperties": false,
+ "properties": {
+ "supported_reasoning_efforts": {
+ "description": "Supported reasoning-effort values for this provider.",
+ "items": {
+ "$ref": "#/components/schemas/ReasoningEffort"
+ },
+ "type": "array"
+ },
+ "type": {
+ "description": "Custom provider type (catalog includes `custom`).",
+ "enum": [
+ "custom"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "supported_reasoning_efforts"
+ ],
+ "type": "object"
+ },
"CatalogDaytonaSandboxProvider": {
"additionalProperties": false,
"properties": {
@@ -471,46 +495,15 @@
],
"type": "object"
},
- "CatalogProvider": {
- "additionalProperties": false,
- "properties": {
- "logo": {
- "description": "URL of the provider logo asset.",
- "format": "uri",
- "type": "string"
- },
- "models": {
- "description": "Preset models for this catalog provider.",
- "items": {
- "$ref": "#/components/schemas/ModelEntry"
- },
- "minItems": 1,
- "type": "array"
- },
- "name": {
- "$ref": "#/components/schemas/ResourceName"
+ "CatalogModelProvider": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/CatalogWellKnownModelProvider"
},
- "type": {
- "description": "Well-known provider type (catalog excludes `custom`).",
- "enum": [
- "openai",
- "anthropic",
- "google-gemini",
- "fireworks",
- "zai",
- "moonshot",
- "alibaba",
- "together"
- ],
- "type": "string"
+ {
+ "$ref": "#/components/schemas/CatalogCustomModelProvider"
}
- },
- "required": [
- "type",
- "name",
- "models"
- ],
- "type": "object"
+ ]
},
"CatalogSkill": {
"additionalProperties": false,
@@ -554,6 +547,42 @@
],
"type": "object"
},
+ "CatalogWellKnownModelProvider": {
+ "additionalProperties": false,
+ "properties": {
+ "logo": {
+ "description": "URL of the provider logo asset.",
+ "format": "uri",
+ "type": "string"
+ },
+ "models": {
+ "description": "Preset models; empty on the `custom` sentinel.",
+ "items": {
+ "$ref": "#/components/schemas/ModelEntry"
+ },
+ "type": "array"
+ },
+ "type": {
+ "description": "Well-known provider type (catalog excludes `custom`).",
+ "enum": [
+ "openai",
+ "anthropic",
+ "google-gemini",
+ "fireworks",
+ "zai",
+ "moonshot",
+ "alibaba",
+ "together"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "models"
+ ],
+ "type": "object"
+ },
"ChatCompletionChunkDeltaToolCall": {
"properties": {
"function": {
@@ -1119,7 +1148,7 @@
"properties": {
"data": {
"items": {
- "$ref": "#/components/schemas/CatalogProvider"
+ "$ref": "#/components/schemas/CatalogModelProvider"
},
"type": "array"
}
@@ -6363,7 +6392,7 @@
},
"/api/v1/settings/model-providers/catalog": {
"get": {
- "description": "Provider and model presets shipped with the server (model-catalog.yaml). Discovery-only: an entry becomes a PUT /settings/model-providers body once the catalog-only `logo` and `name` are dropped and `auth` is added. Custom providers are not listed here.",
+ "description": "Provider and model presets shipped with the server (model-catalog.yaml). Discovery-only: an entry becomes a PUT /settings/model-providers body once the catalog-only `logo` and `name` are dropped and `auth` is added. Includes a `custom` sentinel with `supported_reasoning_efforts` for the custom-provider form (not configurable from catalog).",
"responses": {
"200": {
"content": {
@@ -6708,8 +6737,7 @@
"security": [
{
"BearerAuth": []
- },
- {}
+ }
],
"webhooks": {}
}
diff --git a/packages/frontend/src/modelProviderCatalog.ts b/packages/frontend/src/modelProviderCatalog.ts
index 0b43789d3..f0061d7cc 100644
--- a/packages/frontend/src/modelProviderCatalog.ts
+++ b/packages/frontend/src/modelProviderCatalog.ts
@@ -23,11 +23,6 @@ export type UiModelEntry = ModelEntry & {
export type UiModelProvider = ModelProviderBase<UiModelEntry>;
export type UiModelProviderCatalogEntry = ModelProviderCatalogEntry<UiModelEntry>;
-const DEFAULT_MODEL_PROPERTIES: TrueForgeApi.ModelProperties = {
- contextLength: 128_000,
- maxOutputTokens: 16_384,
-};
-
export function toUiModelEntry(model: TrueForgeApi.ModelEntry): UiModelEntry {
return {
id: model.modelId,
@@ -40,7 +35,7 @@ export function toHarnessModelEntry(model: UiModelEntry): TrueForgeApi.ModelEntr
return {
modelId: model.id,
name: model.name,
- properties: model.properties ?? DEFAULT_MODEL_PROPERTIES,
+ properties: model.properties ?? {},
};
}
@@ -56,17 +51,26 @@ export function toUiModelProvider(provider: TrueForgeApi.ModelProvider): UiModel
};
}
-export function toUiCatalogEntry(provider: TrueForgeApi.CatalogProvider): UiModelProviderCatalogEntry {
+export function toUiCatalogModelProviderEntry(
+ provider: TrueForgeApi.CatalogModelProvider,
+): UiModelProviderCatalogEntry {
+ if (provider.type === 'custom') {
+ return {
+ type: provider.type,
+ name: provider.type,
+ supportedReasoningEfforts: provider.supportedReasoningEfforts,
+ models: [],
+ };
+ }
return {
type: provider.type,
- name: provider.name,
+ name: provider.type,
...(provider.logo === undefined ? {} : { logo: provider.logo }),
models: provider.models.map(toUiModelEntry),
};
}
-/** The catalog lists every type but `custom`, which only exists as tenant configuration. */
-const PROVIDER_TYPES: readonly string[] = [...Object.values(TrueForgeApi.CatalogProviderType), 'custom'];
+const PROVIDER_TYPES: readonly string[] = [...Object.values(TrueForgeApi.CatalogWellKnownModelProviderType), 'custom'];
function isProviderType(type: string): type is TrueForgeApi.ModelProvider['type'] {
return PROVIDER_TYPES.includes(type);
@@ -144,7 +148,7 @@ export function createModelProviderCatalog(): ModelCatalogServer<
return {
getModelProviderCatalog: async () => {
const body = await client.settings.modelProviders.catalog();
- return body.data.map(toUiCatalogEntry);
+ return body.data.map(toUiCatalogModelProviderEntry);
},
listModelProviders: async () => {
const body = await client.settings.modelProviders.list();
diff --git a/packages/frontend/tests/modelProviderCatalog.test.ts b/packages/frontend/tests/modelProviderCatalog.test.ts
index 7fb7686c0..580a48568 100644
--- a/packages/frontend/tests/modelProviderCatalog.test.ts
+++ b/packages/frontend/tests/modelProviderCatalog.test.ts
@@ -4,7 +4,7 @@ import { TrueForgeApi } from 'trueforge-sdk';
import {
toHarnessModelEntry,
toHarnessModelProvider,
- toUiCatalogEntry,
+ toUiCatalogModelProviderEntry,
toUiModelEntry,
toUiModelProvider,
} from '../src/modelProviderCatalog';
@@ -29,14 +29,11 @@ describe('modelProviderCatalog mappers', () => {
assert.deepEqual(toHarnessModelEntry(toUiModelEntry(harness)), harness);
});
- it('fills default properties when the UI custom form omits them', () => {
+ it('uses empty properties when the UI custom form omits them', () => {
assert.deepEqual(toHarnessModelEntry({ id: 'llama3', name: 'llama3' }), {
modelId: 'llama3',
name: 'llama3',
- properties: {
- contextLength: 128_000,
- maxOutputTokens: 16_384,
- },
+ properties: {},
});
});
@@ -87,11 +84,10 @@ describe('modelProviderCatalog mappers', () => {
);
});
- it('maps catalog presets without inventing custom providers', () => {
+ it('maps catalog presets and names them after their type', () => {
assert.deepEqual(
- toUiCatalogEntry({
+ toUiCatalogModelProviderEntry({
type: 'anthropic',
- name: 'anthropic',
models: [
{
modelId: 'claude-sonnet-4-6',
@@ -159,7 +155,7 @@ describe('modelProviderCatalog mappers', () => {
{
modelId: 'llama3',
name: 'llama3',
- properties: { contextLength: 128_000, maxOutputTokens: 16_384 },
+ properties: {},
},
],
},
@@ -182,7 +178,7 @@ describe('modelProviderCatalog mappers', () => {
// Catalog presets are copied straight into this form, so a type the API accepts but this mapper
// does not is a preset the user cannot save.
it('builds a body for every provider type the API accepts', () => {
- const types = [...Object.values(TrueForgeApi.CatalogProviderType), 'custom'];
+ const types = [...Object.values(TrueForgeApi.CatalogWellKnownModelProviderType), 'custom'];
for (const type of types) {
const body = toHarnessModelProvider({
type,
diff --git a/packages/sdk/.fern/metadata.json b/packages/sdk/.fern/metadata.json
index 3b9073251..1af572d6e 100644
--- a/packages/sdk/.fern/metadata.json
+++ b/packages/sdk/.fern/metadata.json
@@ -28,7 +28,7 @@
"streamType": "web",
"useDefaultRequestParameterValues": true
},
- "originGitCommit": "a8d2e1b8839a98ec2ab7b243964412484747cad2",
+ "originGitCommit": "18ec0e4a4e67a22a5a72579a893cd0b9eef06533",
"originGitCommitIsDirty": true,
"invokedBy": "ci",
"requestedVersion": "0.0.0",
diff --git a/packages/sdk/pnpm-lock.yaml b/packages/sdk/pnpm-lock.yaml
index 1e59d4181..acb2abc49 100644
--- a/packages/sdk/pnpm-lock.yaml
+++ b/packages/sdk/pnpm-lock.yaml
@@ -851,8 +851,8 @@ packages:
resolution: {integrity: sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==}
- resolution: {integrity: sha512-x/M6q3w4Ybp91CNaS4S69UnliqR3BzRpOT6LWbksjth0S/+jhfaPJsWjt/TewpT8j9eLIojUf5jr29WextHroA==}
+ resolution: {integrity: sha512-ZZ61DsRsOnakl74HAmp3oSN4aXUmEWXf+i/yv0h7tIBfICc3VdrFErQKUUKPgu3AMsTUMbcongALEN4l6GSUrQ==}
hasBin: true
peerDependencies:
browserslist: '>= 4.21.0'
@@ -1321,7 +1321,7 @@ snapshots:
caniuse-lite: 1.0.30001809
electron-to-chromium: 1.5.403
node-releases: 2.0.53
- update-browserslist-db: 1.3.0([email protected])
+ update-browserslist-db: 1.3.1([email protected])
@@ -1660,7 +1660,7 @@ snapshots:
dependencies:
browserslist: 4.28.8
escalade: 3.2.0
diff --git a/packages/sdk/reference.md b/packages/sdk/reference.md
index c792c263c..831956ca6 100644
--- a/packages/sdk/reference.md
+++ b/packages/sdk/reference.md
@@ -2244,7 +2244,7 @@ await client.settings.modelProviders.upsert({
<dl>
<dd>
-Provider and model presets shipped with the server (model-catalog.yaml). Discovery-only: an entry becomes a PUT /settings/model-providers body once the catalog-only `logo` and `name` are dropped and `auth` is added. Custom providers are not listed here.
+Provider and model presets shipped with the server (model-catalog.yaml). Discovery-only: an entry becomes a PUT /settings/model-providers body once the catalog-only `logo` and `name` are dropped and `auth` is added. Includes a `custom` sentinel with `supported_reasoning_efforts` for the custom-provider form (not configurable from catalog).
</dd>
</dl>
</dd>
diff --git a/packages/sdk/src/api/resources/settings/resources/modelProviders/client/Client.ts b/packages/sdk/src/api/resources/settings/resources/modelProviders/client/Client.ts
index 4bb2e0fe8..4b059c24c 100644
--- a/packages/sdk/src/api/resources/settings/resources/modelProviders/client/Client.ts
+++ b/packages/sdk/src/api/resources/settings/resources/modelProviders/client/Client.ts
@@ -230,7 +230,7 @@ export class ModelProvidersClient {
}
/**
- * Provider and model presets shipped with the server (model-catalog.yaml). Discovery-only: an entry becomes a PUT /settings/model-providers body once the catalog-only `logo` and `name` are dropped and `auth` is added. Custom providers are not listed here.
+ * Provider and model presets shipped with the server (model-catalog.yaml). Discovery-only: an entry becomes a PUT /settings/model-providers body once the catalog-only `logo` and `name` are dropped and `auth` is added. Includes a `custom` sentinel with `supported_reasoning_efforts` for the custom-provider form (not configurable from catalog).
*
* @param {ModelProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
*
diff --git a/packages/sdk/src/api/types/CatalogCustomModelProvider.ts b/packages/sdk/src/api/types/CatalogCustomModelProvider.ts
new file mode 100644
index 000000000..40d74883d
--- /dev/null
+++ b/packages/sdk/src/api/types/CatalogCustomModelProvider.ts
@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../index.js";
+
+export interface CatalogCustomModelProvider {
+ /** Supported reasoning-effort values for this provider */
+ supportedReasoningEfforts: TrueForge.ReasoningEffort[];
+ type: "custom";
+}
diff --git a/packages/sdk/src/api/types/CatalogModelProvider.ts b/packages/sdk/src/api/types/CatalogModelProvider.ts
new file mode 100644
index 000000000..62c1d67a7
--- /dev/null
+++ b/packages/sdk/src/api/types/CatalogModelProvider.ts
@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../index.js";
+
+export type CatalogModelProvider = TrueForge.CatalogWellKnownModelProvider | TrueForge.CatalogCustomModelProvider;
diff --git a/packages/sdk/src/api/types/CatalogProvider.ts b/packages/sdk/src/api/types/CatalogProvider.ts
deleted file mode 100644
index d419d6015..000000000
--- a/packages/sdk/src/api/types/CatalogProvider.ts
+++ /dev/null
@@ -1,13 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-
-import type * as TrueForge from "../index.js";
-
-export interface CatalogProvider {
- /** URL of the provider logo asset. */
- logo?: string;
- /** Preset models for this catalog provider. */
- models: TrueForge.ModelEntry[];
- name: TrueForge.ResourceName;
- /** Well-known provider type (catalog excludes `custom`). */
- type: TrueForge.CatalogProviderType;
-}
diff --git a/packages/sdk/src/api/types/CatalogWellKnownModelProvider.ts b/packages/sdk/src/api/types/CatalogWellKnownModelProvider.ts
new file mode 100644
index 000000000..915d30b95
--- /dev/null
+++ b/packages/sdk/src/api/types/CatalogWellKnownModelProvider.ts
@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../index.js";
+
+export interface CatalogWellKnownModelProvider {
+ /** URL of the provider logo asset */
+ logo?: string;
+ /** Preset models */
+ models: TrueForge.ModelEntry[];
+ type: TrueForge.CatalogWellKnownModelProviderType;
+}
diff --git a/packages/sdk/src/api/types/CatalogProviderType.ts b/packages/sdk/src/api/types/CatalogWellKnownModelProviderType.ts
similarity index 59%
rename from packages/sdk/src/api/types/CatalogProviderType.ts
rename to packages/sdk/src/api/types/CatalogWellKnownModelProviderType.ts
index a03c1cb4a..902d076af 100644
--- a/packages/sdk/src/api/types/CatalogProviderType.ts
+++ b/packages/sdk/src/api/types/CatalogWellKnownModelProviderType.ts
@@ -1,7 +1,6 @@
// This file was auto-generated by Fern from our API Definition.
-/** Well-known provider type (catalog excludes `custom`). */
-export const CatalogProviderType = {
+export const CatalogWellKnownModelProviderType = {
Openai: "openai",
Anthropic: "anthropic",
GoogleGemini: "google-gemini",
@@ -11,4 +10,5 @@ export const CatalogProviderType = {
Alibaba: "alibaba",
Together: "together",
} as const;
-export type CatalogProviderType = (typeof CatalogProviderType)[keyof typeof CatalogProviderType];
+export type CatalogWellKnownModelProviderType =
+ (typeof CatalogWellKnownModelProviderType)[keyof typeof CatalogWellKnownModelProviderType];
diff --git a/packages/sdk/src/api/types/GetModelProviderCatalogResponse.ts b/packages/sdk/src/api/types/GetModelProviderCatalogResponse.ts
index 2d899c350..7137ea46a 100644
--- a/packages/sdk/src/api/types/GetModelProviderCatalogResponse.ts
+++ b/packages/sdk/src/api/types/GetModelProviderCatalogResponse.ts
@@ -3,5 +3,5 @@
import type * as TrueForge from "../index.js";
export interface GetModelProviderCatalogResponse {
- data: TrueForge.CatalogProvider[];
+ data: TrueForge.CatalogModelProvider[];
}
diff --git a/packages/sdk/src/api/types/index.ts b/packages/sdk/src/api/types/index.ts
index 248a80668..5aa608164 100644
--- a/packages/sdk/src/api/types/index.ts
+++ b/packages/sdk/src/api/types/index.ts
@@ -14,12 +14,14 @@ export * from "./AskUserQuestionsConfig.js";
export * from "./BaseMcpAuthRequiredEvent.js";
export * from "./BaseThreadDoneEvent.js";
export * from "./CancelSessionResponse.js";
+export * from "./CatalogCustomModelProvider.js";
export * from "./CatalogDaytonaSandboxProvider.js";
export * from "./CatalogMcpServer.js";
export * from "./CatalogMcpServerAuth.js";
-export * from "./CatalogProvider.js";
-export * from "./CatalogProviderType.js";
+export * from "./CatalogModelProvider.js";
export * from "./CatalogSkill.js";
+export * from "./CatalogWellKnownModelProvider.js";
+export * from "./CatalogWellKnownModelProviderType.js";
export * from "./ChatCompletionChunkDeltaToolCall.js";
export * from "./ChatCompletionChunkDeltaToolCallFunction.js";
export * from "./ChatCompletionContentPartRefusal.js";
diff --git a/packages/sdk/src/serialization/types/CatalogCustomModelProvider.ts b/packages/sdk/src/serialization/types/CatalogCustomModelProvider.ts
new file mode 100644
index 000000000..b48fab99b
--- /dev/null
+++ b/packages/sdk/src/serialization/types/CatalogCustomModelProvider.ts
@@ -0,0 +1,24 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+import { ReasoningEffort } from "./ReasoningEffort.js";
+
+export const CatalogCustomModelProvider: core.serialization.ObjectSchema<
+ serializers.CatalogCustomModelProvider.Raw,
+ TrueForge.CatalogCustomModelProvider
+> = core.serialization.object({
+ supportedReasoningEfforts: core.serialization.property(
+ "supported_reasoning_efforts",
+ core.serialization.list(ReasoningEffort),
+ ),
+ type: core.serialization.stringLiteral("custom"),
+});
+
+export declare namespace CatalogCustomModelProvider {
+ export interface Raw {
+ supported_reasoning_efforts: ReasoningEffort.Raw[];
+ type: "custom";
+ }
+}
diff --git a/packages/sdk/src/serialization/types/CatalogModelProvider.ts b/packages/sdk/src/serialization/types/CatalogModelProvider.ts
new file mode 100644
index 000000000..716b35e18
--- /dev/null
+++ b/packages/sdk/src/serialization/types/CatalogModelProvider.ts
@@ -0,0 +1,16 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../api/index.js";
+import * as core from "../../core/index.js";
+import type * as serializers from "../index.js";
+import { CatalogCustomModelProvider } from "./CatalogCustomModelProvider.js";
+import { CatalogWellKnownModelProvider } from "./CatalogWellKnownModelProvider.js";
+
+export const CatalogModelProvider: core.serialization.Schema<
+ serializers.CatalogModelProvider.Raw,
+ TrueForge.CatalogModelProvider
+> = core.serialization.undiscriminatedUnion([CatalogWellKnownModelProvider, CatalogCustomModelProvider]);
+
+export declare namespace CatalogModelProvider {
+ export type Raw = CatalogWellKnownModelProvider.Raw | CatalogCustomModelProvider.Raw;
+}
diff --git a/packages/sdk/src/serialization/types/CatalogProvider.ts b/packages/sdk/src/serialization/types/CatalogWellKnownModelProvider.ts
similarity index 54%
rename from packages/sdk/src/serialization/types/CatalogProvider.ts
rename to packages/sdk/src/serialization/types/CatalogWellKnownModelProvider.ts
index 40015fe3e..ba3cfc822 100644
--- a/packages/sdk/src/serialization/types/CatalogProvider.ts
+++ b/packages/sdk/src/serialization/types/CatalogWellKnownModelProvider.ts
@@ -3,25 +3,22 @@
import type * as TrueForge from "../../api/index.js";
import * as core from "../../core/index.js";
import type * as serializers from "../index.js";
-import { CatalogProviderType } from "./CatalogProviderType.js";
+import { CatalogWellKnownModelProviderType } from "./CatalogWellKnownModelProviderType.js";
import { ModelEntry } from "./ModelEntry.js";
-import { ResourceName } from "./ResourceName.js";
-export const CatalogProvider: core.serialization.ObjectSchema<
- serializers.CatalogProvider.Raw,
- TrueForge.CatalogProvider
+export const CatalogWellKnownModelProvider: core.serialization.ObjectSchema<
+ serializers.CatalogWellKnownModelProvider.Raw,
+ TrueForge.CatalogWellKnownModelProvider
> = core.serialization.object({
logo: core.serialization.string().optional(),
models: core.serialization.list(ModelEntry),
- name: ResourceName,
- type: CatalogProviderType,
+ type: CatalogWellKnownModelProviderType,
});
-export declare namespace CatalogProvider {
+export declare namespace CatalogWellKnownModelProvider {
export interface Raw {
logo?: string | null;
models: ModelEntry.Raw[];
- name: ResourceName.Raw;
- type: CatalogProviderType.Raw;
+ type: CatalogWellKnownModelProviderType.Raw;
}
}
diff --git a/packages/sdk/src/serialization/types/CatalogProviderType.ts b/packages/sdk/src/serialization/types/CatalogWellKnownModelProviderType.ts
similarity index 70%
rename from packages/sdk/src/serialization/types/CatalogProviderType.ts
rename to packages/sdk/src/serialization/types/CatalogWellKnownModelProviderType.ts
index 2800fac72..aafdad798 100644
--- a/packages/sdk/src/serialization/types/CatalogProviderType.ts
+++ b/packages/sdk/src/serialization/types/CatalogWellKnownModelProviderType.ts
@@ -4,9 +4,9 @@ import type * as TrueForge from "../../api/index.js";
import * as core from "../../core/index.js";
import type * as serializers from "../index.js";
-export const CatalogProviderType: core.serialization.Schema<
- serializers.CatalogProviderType.Raw,
- TrueForge.CatalogProviderType
+export const CatalogWellKnownModelProviderType: core.serialization.Schema<
+ serializers.CatalogWellKnownModelProviderType.Raw,
+ TrueForge.CatalogWellKnownModelProviderType
> = core.serialization.enum_([
"openai",
"anthropic",
@@ -18,7 +18,7 @@ export const CatalogProviderType: core.serialization.Schema<
"together",
]);
-export declare namespace CatalogProviderType {
+export declare namespace CatalogWellKnownModelProviderType {
export type Raw =
| "openai"
| "anthropic"
diff --git a/packages/sdk/src/serialization/types/GetModelProviderCatalogResponse.ts b/packages/sdk/src/serialization/types/GetModelProviderCatalogResponse.ts
index c8d3b838a..2d5344462 100644
--- a/packages/sdk/src/serialization/types/GetModelProviderCatalogResponse.ts
+++ b/packages/sdk/src/serialization/types/GetModelProviderCatalogResponse.ts
@@ -3,17 +3,17 @@
import type * as TrueForge from "../../api/index.js";
import * as core from "../../core/index.js";
import type * as serializers from "../index.js";
-import { CatalogProvider } from "./CatalogProvider.js";
+import { CatalogModelProvider } from "./CatalogModelProvider.js";
export const GetModelProviderCatalogResponse: core.serialization.ObjectSchema<
serializers.GetModelProviderCatalogResponse.Raw,
TrueForge.GetModelProviderCatalogResponse
> = core.serialization.object({
- data: core.serialization.list(CatalogProvider),
+ data: core.serialization.list(CatalogModelProvider),
});
export declare namespace GetModelProviderCatalogResponse {
export interface Raw {
- data: CatalogProvider.Raw[];
+ data: CatalogModelProvider.Raw[];
}
}
diff --git a/packages/sdk/src/serialization/types/index.ts b/packages/sdk/src/serialization/types/index.ts
index 248a80668..5aa608164 100644
--- a/packages/sdk/src/serialization/types/index.ts
+++ b/packages/sdk/src/serialization/types/index.ts
@@ -14,12 +14,14 @@ export * from "./AskUserQuestionsConfig.js";
export * from "./BaseMcpAuthRequiredEvent.js";
export * from "./BaseThreadDoneEvent.js";
export * from "./CancelSessionResponse.js";
+export * from "./CatalogCustomModelProvider.js";
export * from "./CatalogDaytonaSandboxProvider.js";
export * from "./CatalogMcpServer.js";
export * from "./CatalogMcpServerAuth.js";
-export * from "./CatalogProvider.js";
-export * from "./CatalogProviderType.js";
+export * from "./CatalogModelProvider.js";
export * from "./CatalogSkill.js";
+export * from "./CatalogWellKnownModelProvider.js";
+export * from "./CatalogWellKnownModelProviderType.js";
export * from "./ChatCompletionChunkDeltaToolCall.js";
export * from "./ChatCompletionChunkDeltaToolCallFunction.js";
export * from "./ChatCompletionContentPartRefusal.js";
diff --git a/packages/sdk/tests/wire/settings/modelProviders.test.ts b/packages/sdk/tests/wire/settings/modelProviders.test.ts
index 923f5d221..e70e02105 100644
--- a/packages/sdk/tests/wire/settings/modelProviders.test.ts
+++ b/packages/sdk/tests/wire/settings/modelProviders.test.ts
@@ -193,14 +193,7 @@ describe("ModelProvidersClient", () => {
const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
const rawResponseBody = {
- data: [
- {
- logo: "logo",
- models: [{ model_id: "model_id", name: "name", properties: {} }],
- name: "name",
- type: "openai",
- },
- ],
+ data: [{ logo: "logo", models: [{ model_id: "model_id", name: "name", properties: {} }], type: "openai" }],
};
server
@@ -223,7 +216,6 @@ describe("ModelProvidersClient", () => {
properties: {},
},
],
- name: "name",
type: "openai",
},
],
diff --git a/packages/server/catalog/model-catalog.yaml b/packages/server/catalog/model-catalog.yaml
index d02d57c48..36ebd7513 100644
--- a/packages/server/catalog/model-catalog.yaml
+++ b/packages/server/catalog/model-catalog.yaml
@@ -3,7 +3,6 @@
# PUT /api/v1/settings/model-providers bodies. Discovery-only — never executed against.
providers:
- type: openai
- name: openai
logo: https://assets.production.truefoundry.com/openai.svg
models:
- model_id: gpt-5.4-mini
@@ -65,7 +64,6 @@ providers:
- xhigh
- max
- type: anthropic
- name: anthropic
logo: https://assets.production.truefoundry.com/anthropic.svg
models:
- model_id: claude-fable-5
@@ -128,7 +126,6 @@ providers:
- xhigh
- max
- type: google-gemini
- name: google-gemini
logo: https://assets.production.truefoundry.com/google-gemini.svg
models:
- model_id: gemini-3.1-pro-preview
@@ -151,7 +148,6 @@ providers:
- medium
- high
- type: fireworks
- name: fireworks
logo: https://assets.production.truefoundry.com/fireworks.svg
models:
- model_id: accounts/fireworks/models/deepseek-v4-pro
@@ -210,7 +206,6 @@ providers:
- xhigh
- max
- type: zai
- name: zai
logo: https://assets.production.truefoundry.com/zai.svg
models:
- model_id: glm-5-turbo
@@ -237,7 +232,6 @@ providers:
- xhigh
- max
- type: moonshot
- name: moonshot
logo: https://assets.production.truefoundry.com/moonshot.png
models:
- model_id: kimi-k2.7-code
@@ -253,7 +247,6 @@ providers:
- high
- max
- type: alibaba
- name: alibaba
logo: https://assets.production.truefoundry.com/alibaba.png
models:
- model_id: qwen3.7-flash
@@ -306,7 +299,6 @@ providers:
- xhigh
- max
- type: together
- name: together
logo: https://assets.production.truefoundry.com/togetherai.svg
models:
- model_id: deepseek-ai/DeepSeek-V4-Pro
diff --git a/packages/server/src/apis/modelProviders.ts b/packages/server/src/apis/modelProviders.ts
index 77893199d..a31c7d2fb 100644
--- a/packages/server/src/apis/modelProviders.ts
+++ b/packages/server/src/apis/modelProviders.ts
@@ -1,4 +1,5 @@
import { OpenAPIHono, type RouteHandler } from '@hono/zod-openapi';
+import { SUPPORTED_REASONING_EFFORTS } from '@truefoundry/utils-core/core';
import type { ModelCatalog } from '../catalog/ModelCatalog';
import type { IModelProviderStore } from '../db/modelProviderStore';
import type { WithTransaction } from '../db/transaction';
@@ -7,6 +8,7 @@ import {
listModelProvidersRoute,
putModelProviderRoute,
} from '../routes/modelProviderRoutes';
+import type { CatalogModelProvider } from '../schemas/modelCatalog';
import { modelProviderName } from '../schemas/modelProvider';
import { TENANT_ID } from './sessions';
@@ -18,7 +20,14 @@ export interface ModelProvidersRouterDeps<TTransaction> {
export function createModelProvidersRouter<TTransaction>(deps: ModelProvidersRouterDeps<TTransaction>) {
const catalogHandler: RouteHandler<typeof getModelProviderCatalogRoute> = c => {
- return c.json({ data: [...deps.modelCatalog.list()] }, 200);
+ const loadedProvidersCatalog = deps.modelCatalog.list();
+ // make a copy of the loaded providers catalog and add the custom provider sentinel
+ const providersCatalog: CatalogModelProvider[] = [...loadedProvidersCatalog];
+ providersCatalog.push({
+ type: 'custom',
+ supported_reasoning_efforts: [...SUPPORTED_REASONING_EFFORTS],
+ });
+ return c.json({ data: providersCatalog }, 200);
};
const listHandler: RouteHandler<typeof listModelProvidersRoute> = async c => {
diff --git a/packages/server/src/catalog/ModelCatalog.ts b/packages/server/src/catalog/ModelCatalog.ts
index b38d44b34..28af6fc21 100644
--- a/packages/server/src/catalog/ModelCatalog.ts
+++ b/packages/server/src/catalog/ModelCatalog.ts
@@ -7,14 +7,14 @@
* override: `MODEL_CATALOG_PATH` (file on disk).
*/
import configuration from '../config';
-import { ModelCatalogFileSchema, type CatalogProvider } from '../schemas/modelCatalog';
+import { ModelCatalogFileSchema, type CatalogWellKnownModelProvider } from '../schemas/modelCatalog';
import { loadYamlAtPath, parseYamlString } from './loadYaml';
import { shippedModelCatalogYaml } from './modelCatalog.gen';
export class ModelCatalog {
- private readonly providers: readonly CatalogProvider[];
+ private readonly providers: readonly CatalogWellKnownModelProvider[];
- constructor(providers: readonly CatalogProvider[]) {
+ constructor(providers: readonly CatalogWellKnownModelProvider[]) {
this.providers = providers;
}
@@ -28,7 +28,7 @@ export class ModelCatalog {
return new ModelCatalog(file.providers);
}
- list(): readonly CatalogProvider[] {
+ list(): readonly CatalogWellKnownModelProvider[] {
return this.providers;
}
}
diff --git a/packages/server/src/routes/modelProviderRoutes.ts b/packages/server/src/routes/modelProviderRoutes.ts
index 92dd65d1e..7a3801b28 100644
--- a/packages/server/src/routes/modelProviderRoutes.ts
+++ b/packages/server/src/routes/modelProviderRoutes.ts
@@ -21,7 +21,7 @@ export const getModelProviderCatalogRoute = createRoute({
description:
'Provider and model presets shipped with the server (model-catalog.yaml). Discovery-only: an entry becomes a ' +
'PUT /settings/model-providers body once the catalog-only `logo` and `name` are dropped and `auth` is added. ' +
- 'Custom providers are not listed here.',
+ 'Includes a `custom` sentinel with `supported_reasoning_efforts` for the custom-provider form (not configurable from catalog).',
'x-fern-sdk-group-name': ['settings', 'modelProviders'],
'x-fern-sdk-method-name': 'catalog',
responses: {
diff --git a/packages/server/src/schemas/common.ts b/packages/server/src/schemas/common.ts
index 50d781346..4480c6cea 100644
--- a/packages/server/src/schemas/common.ts
+++ b/packages/server/src/schemas/common.ts
@@ -33,3 +33,17 @@ export function uniqueNames(entries: { name: string }[], ctx: z.RefinementCtx):
seen.add(entry.name);
}
}
+
+/** Adds a validation issue if two entries share a type. */
+export function uniqueTypes(entries: { type: string }[], ctx: z.RefinementCtx): void {
+ const seen = new Set<string>();
+ for (const entry of entries) {
+ if (seen.has(entry.type)) {
+ ctx.addIssue({
+ code: 'custom',
+ message: `Duplicate type "${entry.type}" — types must be unique`,
+ });
+ }
+ seen.add(entry.type);
+ }
+}
diff --git a/packages/server/src/schemas/modelCatalog.ts b/packages/server/src/schemas/modelCatalog.ts
index 034880da9..5b5a9ed89 100644
--- a/packages/server/src/schemas/modelCatalog.ts
+++ b/packages/server/src/schemas/modelCatalog.ts
@@ -3,27 +3,47 @@
* configured provider manifests in modelProvider.ts.
*/
import { z } from '@hono/zod-openapi';
-import { NameSchema, uniqueNames } from './common';
-import { ModelEntrySchema, ProviderTypeSchema, refineUniqueModels } from './modelProvider';
+import { uniqueTypes } from './common';
+import { ModelEntrySchema, ModelProviderTypeSchema, ReasoningEffortSchema, refineUniqueModels } from './modelProvider';
-/** Catalog entry: no `custom` providers — those exist only as tenant configuration. */
-export const CatalogProviderSchema = z
+/**
+ * Catalog entry. Well-known types list model presets; `custom` is a sentinel that
+ * carries `supported_reasoning_efforts` for the custom-provider settings form.
+ */
+export const CatalogWellKnownModelProviderTypeSchema = ModelProviderTypeSchema.exclude(['custom']).openapi(
+ 'CatalogWellKnownModelProviderType',
+);
+
+export const CatalogWellKnownModelProviderSchema = z
+ .object({
+ type: CatalogWellKnownModelProviderTypeSchema,
+ logo: z.url().optional().describe('URL of the provider logo asset'),
+ models: z.array(ModelEntrySchema).describe('Preset models'),
+ })
+ .strict()
+ .openapi('CatalogWellKnownModelProvider');
+
+export const CatalogCustomModelProviderSchema = z
.object({
- type: ProviderTypeSchema.exclude(['custom']).describe('Well-known provider type (catalog excludes `custom`).'),
- name: NameSchema,
- logo: z.url().optional().describe('URL of the provider logo asset.'),
- models: z.array(ModelEntrySchema).min(1).describe('Preset models for this catalog provider.'),
+ type: z.literal('custom'),
+ supported_reasoning_efforts: z
+ .array(ReasoningEffortSchema)
+ .describe('Supported reasoning-effort values for this provider'),
})
.strict()
- .openapi('CatalogProvider');
+ .openapi('CatalogCustomModelProvider');
+
+export const CatalogModelProviderSchema = z
+ .union([CatalogWellKnownModelProviderSchema, CatalogCustomModelProviderSchema])
+ .openapi('CatalogModelProvider');
export const ModelCatalogFileSchema = z
.object({
- providers: z.array(CatalogProviderSchema),
+ providers: z.array(CatalogWellKnownModelProviderSchema),
})
.strict()
.superRefine((file, ctx) => {
- uniqueNames(file.providers, ctx);
+ uniqueTypes(file.providers, ctx);
for (const provider of file.providers) {
refineUniqueModels(provider.models, ctx);
}
@@ -31,9 +51,10 @@ export const ModelCatalogFileSchema = z
export const GetModelProviderCatalogResponseSchema = z
.object({
- data: z.array(CatalogProviderSchema),
+ data: z.array(CatalogModelProviderSchema),
})
.openapi('GetModelProviderCatalogResponse');
-export type CatalogProvider = z.infer<typeof CatalogProviderSchema>;
+export type CatalogWellKnownModelProvider = z.infer<typeof CatalogWellKnownModelProviderSchema>;
+export type CatalogModelProvider = z.infer<typeof CatalogModelProviderSchema>;
export type ModelCatalogFile = z.infer<typeof ModelCatalogFileSchema>;
diff --git a/packages/server/src/schemas/modelProvider.ts b/packages/server/src/schemas/modelProvider.ts
index dc2671250..9034bcd70 100644
--- a/packages/server/src/schemas/modelProvider.ts
+++ b/packages/server/src/schemas/modelProvider.ts
@@ -8,9 +8,9 @@ import { SUPPORTED_REASONING_EFFORTS, VERCEL_AI_PROVIDER_NAMES } from '@truefoun
import { NameSchema, uniqueNames, type ResourceName } from './common';
/** Every type the harness has an adapter for; a test asserts each one has a schema below. */
-export const ProviderTypeSchema = z.enum(VERCEL_AI_PROVIDER_NAMES).openapi('ProviderType');
+export const ModelProviderTypeSchema = z.enum(VERCEL_AI_PROVIDER_NAMES).openapi('ModelProviderType');
-export type ProviderType = z.infer<typeof ProviderTypeSchema>;
+export type ModelProviderType = z.infer<typeof ModelProviderTypeSchema>;
export const ReasoningEffortSchema = z.enum(SUPPORTED_REASONING_EFFORTS).openapi('ReasoningEffort');
@@ -73,7 +73,7 @@ const ModelProviderManifestBaseSchema = z
* one of each because the `(tenant_id, name)` primary key replaces the row rather than adding a
* sibling. `base_url` defaults to the adapter's endpoint and stays overridable.
*/
-function wellKnownProviderSchema<Type extends Exclude<ProviderType, 'custom'>>({
+function wellKnownProviderSchema<Type extends Exclude<ModelProviderType, 'custom'>>({
type,
base_url,
}: {
diff --git a/packages/server/tests/unit/apis/modelProviders.test.ts b/packages/server/tests/unit/apis/modelProviders.test.ts
index aee681ea7..43f3e3cb7 100644
--- a/packages/server/tests/unit/apis/modelProviders.test.ts
+++ b/packages/server/tests/unit/apis/modelProviders.test.ts
@@ -82,16 +82,18 @@ describe('settings model-providers and models routers', () => {
({ settingsRouter, modelsRouter } = await createRouters());
});
- it('GET /model-providers/catalog returns the shipped catalog verbatim', async () => {
+ it('GET /model-providers/catalog returns shipped presets plus a custom sentinel', async () => {
const response = await settingsRouter.request('/model-providers/catalog');
expect(response.status).toBe(200);
- const body = (await response.json()) as { data: { type: string; name: string }[] };
- expect(body.data.map(provider => provider.name)).toEqual(
- ModelCatalog.load()
- .list()
- .map(provider => provider.name),
- );
- expect(body.data.every(provider => provider.type !== 'custom')).toBe(true);
+ const body = (await response.json()) as {
+ data: { type: string; supported_reasoning_efforts?: string[] }[];
+ };
+ const shipped = ModelCatalog.load().list();
+ expect(body.data.slice(0, -1)).toEqual([...shipped]);
+ expect(body.data.at(-1)).toEqual({
+ type: 'custom',
+ supported_reasoning_efforts: ['none', 'minimal', 'low', 'medium', 'high', 'xhigh', 'max'],
+ });
});
it('PUT upserts a well-known provider without base_url and echoes the stored auth', async () => {
@@ -192,14 +194,15 @@ describe('well-known types are limited to one provider', () => {
describe('catalog presets are configurable', () => {
// A preset is copied into a PUT body with an api_key added, so every catalog type must parse.
+ // `custom` is appended by the catalog route, not ModelCatalog — only well-known presets appear here.
it.each(ModelCatalog.load().list())('PUT accepts the $type preset', async preset => {
const { settingsRouter } = await createRouters();
// `logo` is catalog-only metadata and a well-known provider takes its name from `type`; the rest
// copies straight into a PUT body.
- const { logo, name, ...presetFields } = preset;
+ const { logo, ...presetFields } = preset;
const body = {
...presetFields,
- auth: { api_key: `sk-${name}` },
+ auth: { api_key: `sk-${preset.type}` },
};
expect(logo === undefined || typeof logo === 'string').toBe(true);
const response = await settingsRouter.request('/model-providers', putInit(body));