Skip to content

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

Split model providers into an identity DTO and a manifest (#84)

pranjaltrvd777ebb977bbf
diff --git a/.github/fern/openapi/openapi.json b/.github/fern/openapi/openapi.json
index b2e33eea3..54327ee9c 100644
--- a/.github/fern/openapi/openapi.json
+++ b/.github/fern/openapi/openapi.json
@@ -228,13 +228,6 @@
"minItems": 1,
"type": "array"
},
- "name": {
- "default": "alibaba",
- "enum": [
- "alibaba"
- ],
- "type": "string"
- },
"type": {
"enum": [
"alibaba"
@@ -269,13 +262,6 @@
"minItems": 1,
"type": "array"
},
- "name": {
- "default": "anthropic",
- "enum": [
- "anthropic"
- ],
- "type": "string"
- },
"type": {
"enum": [
"anthropic"
@@ -1015,13 +1001,6 @@
"minItems": 1,
"type": "array"
},
- "name": {
- "default": "fireworks",
- "enum": [
- "fireworks"
- ],
- "type": "string"
- },
"type": {
"enum": [
"fireworks"
@@ -1238,13 +1217,6 @@
"minItems": 1,
"type": "array"
},
- "name": {
- "default": "google-gemini",
- "enum": [
- "google-gemini"
- ],
- "type": "string"
- },
"type": {
"enum": [
"google-gemini"
@@ -2277,13 +2249,6 @@
"minItems": 1,
"type": "array"
},
- "name": {
- "default": "moonshot",
- "enum": [
- "moonshot"
- ],
- "type": "string"
- },
"type": {
"enum": [
"moonshot"
@@ -2318,13 +2283,6 @@
"minItems": 1,
"type": "array"
},
- "name": {
- "default": "openai",
- "enum": [
- "openai"
- ],
- "type": "string"
- },
"type": {
"enum": [
"openai"
@@ -3236,13 +3194,6 @@
"minItems": 1,
"type": "array"
},
- "name": {
- "default": "together",
- "enum": [
- "together"
- ],
- "type": "string"
- },
"type": {
"enum": [
"together"
@@ -4090,13 +4041,6 @@
"minItems": 1,
"type": "array"
},
- "name": {
- "default": "zai",
- "enum": [
- "zai"
- ],
- "type": "string"
- },
"type": {
"enum": [
"zai"
@@ -6379,7 +6323,7 @@
"x-fern-sdk-method-name": "list"
},
"put": {
- "description": "Full upsert keyed by `name`: creates the provider or replaces its entire configuration (models included). Every type but `custom` is named after itself, so each is limited to one configured provider and a repeat call replaces it; only `custom` providers are named, and numbered, by the caller.",
+ "description": "Full upsert: creates the provider or replaces its entire configuration (models included). The key is the returned `name`, which every type but `custom` takes from its own `type`, so each is limited to one configured provider and a repeat call replaces it; only `custom` providers are named by the caller.",
"requestBody": {
"content": {
"application/json": {
@@ -6425,7 +6369,7 @@
},
"/api/v1/settings/model-providers/catalog": {
"get": {
- "description": "Provider and model presets shipped with the server (model-catalog.yaml). Discovery-only: copy an entry into PUT /settings/model-providers to configure it. 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. Custom providers are not listed here.",
"responses": {
"200": {
"content": {
diff --git a/packages/frontend/src/modelProviderCatalog.ts b/packages/frontend/src/modelProviderCatalog.ts
index 1be1163cc..0b43789d3 100644
--- a/packages/frontend/src/modelProviderCatalog.ts
+++ b/packages/frontend/src/modelProviderCatalog.ts
@@ -45,8 +45,8 @@ export function toHarnessModelEntry(model: UiModelEntry): TrueForgeApi.ModelEntr
}
export function toUiModelProvider(provider: TrueForgeApi.ModelProvider): UiModelProvider {
- // Every type but `custom` is named after itself, so the wire leaves `name` optional.
- const name = provider.name ?? provider.type;
+ // Only `custom` carries a name; the API names every other type after its type.
+ const name = provider.type === 'custom' ? provider.name : provider.type;
return {
id: name,
type: provider.type,
diff --git a/packages/frontend/tests/modelProviderCatalog.test.ts b/packages/frontend/tests/modelProviderCatalog.test.ts
index 2a780159b..7fb7686c0 100644
--- a/packages/frontend/tests/modelProviderCatalog.test.ts
+++ b/packages/frontend/tests/modelProviderCatalog.test.ts
@@ -40,10 +40,9 @@ describe('modelProviderCatalog mappers', () => {
});
});
- it('uses provider name as the UI id and strips auth from the list card', () => {
+ it('names a well-known provider after its type and strips auth from the list card', () => {
const harness = {
type: 'openai' as const,
- name: 'openai',
auth: { apiKey: 'sk-secret' },
models: [
{
@@ -68,6 +67,26 @@ describe('modelProviderCatalog mappers', () => {
});
});
+ // The stored name is the UI id, so getting this wrong points edits at the wrong row.
+ it('keeps a custom provider under the name it was given', () => {
+ assert.deepEqual(
+ toUiModelProvider({
+ type: 'custom' as const,
+ name: 'local-llama',
+ baseUrl: 'http://127.0.0.1:11434/v1',
+ auth: { apiKey: 'sk-local' },
+ models: [{ modelId: 'llama3', name: 'llama3', properties: {} }],
+ }),
+ {
+ id: 'local-llama',
+ type: 'custom',
+ name: 'local-llama',
+ baseUrl: 'http://127.0.0.1:11434/v1',
+ models: [{ id: 'llama3', name: 'llama3', properties: {} }],
+ },
+ );
+ });
+
it('maps catalog presets without inventing custom providers', () => {
assert.deepEqual(
toUiCatalogEntry({
diff --git a/packages/sdk/reference.md b/packages/sdk/reference.md
index cd07fcacf..54596205c 100644
--- a/packages/sdk/reference.md
+++ b/packages/sdk/reference.md
@@ -2171,7 +2171,7 @@ await client.settings.modelProviders.list();
<dl>
<dd>
-Full upsert keyed by `name`: creates the provider or replaces its entire configuration (models included). Every type but `custom` is named after itself, so each is limited to one configured provider and a repeat call replaces it; only `custom` providers are named, and numbered, by the caller.
+Full upsert: creates the provider or replaces its entire configuration (models included). The key is the returned `name`, which every type but `custom` takes from its own `type`, so each is limited to one configured provider and a repeat call replaces it; only `custom` providers are named by the caller.
</dd>
</dl>
</dd>
@@ -2244,7 +2244,7 @@ await client.settings.modelProviders.upsert({
<dl>
<dd>
-Provider and model presets shipped with the server (model-catalog.yaml). Discovery-only: copy an entry into PUT /settings/model-providers to configure it. 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. Custom providers are not listed here.
</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 b73a6362c..5b6782fa0 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
@@ -116,7 +116,7 @@ export class ModelProvidersClient {
}
/**
- * Full upsert keyed by `name`: creates the provider or replaces its entire configuration (models included). Every type but `custom` is named after itself, so each is limited to one configured provider and a repeat call replaces it; only `custom` providers are named, and numbered, by the caller.
+ * Full upsert: creates the provider or replaces its entire configuration (models included). The key is the returned `name`, which every type but `custom` takes from its own `type`, so each is limited to one configured provider and a repeat call replaces it; only `custom` providers are named by the caller.
*
* @param {TrueForge.ModelProvider} request
* @param {ModelProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -220,7 +220,7 @@ export class ModelProvidersClient {
}
/**
- * Provider and model presets shipped with the server (model-catalog.yaml). Discovery-only: copy an entry into PUT /settings/model-providers to configure it. 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. Custom providers are not listed here.
*
* @param {ModelProvidersClient.RequestOptions} requestOptions - Request-specific configuration.
*
diff --git a/packages/sdk/src/api/types/AlibabaModelProvider.ts b/packages/sdk/src/api/types/AlibabaModelProvider.ts
index d89c6b7b8..2dea98cee 100644
--- a/packages/sdk/src/api/types/AlibabaModelProvider.ts
+++ b/packages/sdk/src/api/types/AlibabaModelProvider.ts
@@ -8,6 +8,5 @@ export interface AlibabaModelProvider {
baseUrl?: string;
/** Models exposed by this provider (at least one). */
models: TrueForge.ModelEntry[];
- name?: "alibaba";
type: "alibaba";
}
diff --git a/packages/sdk/src/api/types/AnthropicModelProvider.ts b/packages/sdk/src/api/types/AnthropicModelProvider.ts
index 5a6fbb5f3..fd8a723be 100644
--- a/packages/sdk/src/api/types/AnthropicModelProvider.ts
+++ b/packages/sdk/src/api/types/AnthropicModelProvider.ts
@@ -8,6 +8,5 @@ export interface AnthropicModelProvider {
baseUrl?: string;
/** Models exposed by this provider (at least one). */
models: TrueForge.ModelEntry[];
- name?: "anthropic";
type: "anthropic";
}
diff --git a/packages/sdk/src/api/types/FireworksModelProvider.ts b/packages/sdk/src/api/types/FireworksModelProvider.ts
index 2d1fac5cb..5519c07c7 100644
--- a/packages/sdk/src/api/types/FireworksModelProvider.ts
+++ b/packages/sdk/src/api/types/FireworksModelProvider.ts
@@ -8,6 +8,5 @@ export interface FireworksModelProvider {
baseUrl?: string;
/** Models exposed by this provider (at least one). */
models: TrueForge.ModelEntry[];
- name?: "fireworks";
type: "fireworks";
}
diff --git a/packages/sdk/src/api/types/GoogleGeminiModelProvider.ts b/packages/sdk/src/api/types/GoogleGeminiModelProvider.ts
index ad6f5680a..fdbce3136 100644
--- a/packages/sdk/src/api/types/GoogleGeminiModelProvider.ts
+++ b/packages/sdk/src/api/types/GoogleGeminiModelProvider.ts
@@ -8,6 +8,5 @@ export interface GoogleGeminiModelProvider {
baseUrl?: string;
/** Models exposed by this provider (at least one). */
models: TrueForge.ModelEntry[];
- name?: "google-gemini";
type: "google-gemini";
}
diff --git a/packages/sdk/src/api/types/MoonshotModelProvider.ts b/packages/sdk/src/api/types/MoonshotModelProvider.ts
index 3e34fd362..a6d00937b 100644
--- a/packages/sdk/src/api/types/MoonshotModelProvider.ts
+++ b/packages/sdk/src/api/types/MoonshotModelProvider.ts
@@ -8,6 +8,5 @@ export interface MoonshotModelProvider {
baseUrl?: string;
/** Models exposed by this provider (at least one). */
models: TrueForge.ModelEntry[];
- name?: "moonshot";
type: "moonshot";
}
diff --git a/packages/sdk/src/api/types/OpenAiModelProvider.ts b/packages/sdk/src/api/types/OpenAiModelProvider.ts
index c2b1cafc0..b26ce0e75 100644
--- a/packages/sdk/src/api/types/OpenAiModelProvider.ts
+++ b/packages/sdk/src/api/types/OpenAiModelProvider.ts
@@ -8,6 +8,5 @@ export interface OpenAiModelProvider {
baseUrl?: string;
/** Models exposed by this provider (at least one). */
models: TrueForge.ModelEntry[];
- name?: "openai";
type: "openai";
}
diff --git a/packages/sdk/src/api/types/TogetherAiModelProvider.ts b/packages/sdk/src/api/types/TogetherAiModelProvider.ts
index a94c7f0f3..957fc632e 100644
--- a/packages/sdk/src/api/types/TogetherAiModelProvider.ts
+++ b/packages/sdk/src/api/types/TogetherAiModelProvider.ts
@@ -8,6 +8,5 @@ export interface TogetherAiModelProvider {
baseUrl?: string;
/** Models exposed by this provider (at least one). */
models: TrueForge.ModelEntry[];
- name?: "together";
type: "together";
}
diff --git a/packages/sdk/src/api/types/ZaiModelProvider.ts b/packages/sdk/src/api/types/ZaiModelProvider.ts
index c1a20ca27..ff48b99ba 100644
--- a/packages/sdk/src/api/types/ZaiModelProvider.ts
+++ b/packages/sdk/src/api/types/ZaiModelProvider.ts
@@ -8,6 +8,5 @@ export interface ZaiModelProvider {
baseUrl?: string;
/** Models exposed by this provider (at least one). */
models: TrueForge.ModelEntry[];
- name?: "zai";
type: "zai";
}
diff --git a/packages/sdk/src/serialization/types/AlibabaModelProvider.ts b/packages/sdk/src/serialization/types/AlibabaModelProvider.ts
index b418714f2..c0346bc56 100644
--- a/packages/sdk/src/serialization/types/AlibabaModelProvider.ts
+++ b/packages/sdk/src/serialization/types/AlibabaModelProvider.ts
@@ -13,7 +13,6 @@ export const AlibabaModelProvider: core.serialization.ObjectSchema<
auth: ModelProviderAuth,
baseUrl: core.serialization.property("base_url", core.serialization.string().optional()),
models: core.serialization.list(ModelEntry),
- name: core.serialization.stringLiteral("alibaba").optional(),
type: core.serialization.stringLiteral("alibaba"),
});
@@ -22,7 +21,6 @@ export declare namespace AlibabaModelProvider {
auth: ModelProviderAuth.Raw;
base_url?: string | null;
models: ModelEntry.Raw[];
- name?: "alibaba" | null;
type: "alibaba";
}
}
diff --git a/packages/sdk/src/serialization/types/AnthropicModelProvider.ts b/packages/sdk/src/serialization/types/AnthropicModelProvider.ts
index 58dab5cb5..1f8411f79 100644
--- a/packages/sdk/src/serialization/types/AnthropicModelProvider.ts
+++ b/packages/sdk/src/serialization/types/AnthropicModelProvider.ts
@@ -13,7 +13,6 @@ export const AnthropicModelProvider: core.serialization.ObjectSchema<
auth: ModelProviderAuth,
baseUrl: core.serialization.property("base_url", core.serialization.string().optional()),
models: core.serialization.list(ModelEntry),
- name: core.serialization.stringLiteral("anthropic").optional(),
type: core.serialization.stringLiteral("anthropic"),
});
@@ -22,7 +21,6 @@ export declare namespace AnthropicModelProvider {
auth: ModelProviderAuth.Raw;
base_url?: string | null;
models: ModelEntry.Raw[];
- name?: "anthropic" | null;
type: "anthropic";
}
}
diff --git a/packages/sdk/src/serialization/types/FireworksModelProvider.ts b/packages/sdk/src/serialization/types/FireworksModelProvider.ts
index e84764e65..c4d559b05 100644
--- a/packages/sdk/src/serialization/types/FireworksModelProvider.ts
+++ b/packages/sdk/src/serialization/types/FireworksModelProvider.ts
@@ -13,7 +13,6 @@ export const FireworksModelProvider: core.serialization.ObjectSchema<
auth: ModelProviderAuth,
baseUrl: core.serialization.property("base_url", core.serialization.string().optional()),
models: core.serialization.list(ModelEntry),
- name: core.serialization.stringLiteral("fireworks").optional(),
type: core.serialization.stringLiteral("fireworks"),
});
@@ -22,7 +21,6 @@ export declare namespace FireworksModelProvider {
auth: ModelProviderAuth.Raw;
base_url?: string | null;
models: ModelEntry.Raw[];
- name?: "fireworks" | null;
type: "fireworks";
}
}
diff --git a/packages/sdk/src/serialization/types/GoogleGeminiModelProvider.ts b/packages/sdk/src/serialization/types/GoogleGeminiModelProvider.ts
index 0600c127c..2f42582e8 100644
--- a/packages/sdk/src/serialization/types/GoogleGeminiModelProvider.ts
+++ b/packages/sdk/src/serialization/types/GoogleGeminiModelProvider.ts
@@ -13,7 +13,6 @@ export const GoogleGeminiModelProvider: core.serialization.ObjectSchema<
auth: ModelProviderAuth,
baseUrl: core.serialization.property("base_url", core.serialization.string().optional()),
models: core.serialization.list(ModelEntry),
- name: core.serialization.stringLiteral("google-gemini").optional(),
type: core.serialization.stringLiteral("google-gemini"),
});
@@ -22,7 +21,6 @@ export declare namespace GoogleGeminiModelProvider {
auth: ModelProviderAuth.Raw;
base_url?: string | null;
models: ModelEntry.Raw[];
- name?: "google-gemini" | null;
type: "google-gemini";
}
}
diff --git a/packages/sdk/src/serialization/types/MoonshotModelProvider.ts b/packages/sdk/src/serialization/types/MoonshotModelProvider.ts
index e569f2eeb..ec7981536 100644
--- a/packages/sdk/src/serialization/types/MoonshotModelProvider.ts
+++ b/packages/sdk/src/serialization/types/MoonshotModelProvider.ts
@@ -13,7 +13,6 @@ export const MoonshotModelProvider: core.serialization.ObjectSchema<
auth: ModelProviderAuth,
baseUrl: core.serialization.property("base_url", core.serialization.string().optional()),
models: core.serialization.list(ModelEntry),
- name: core.serialization.stringLiteral("moonshot").optional(),
type: core.serialization.stringLiteral("moonshot"),
});
@@ -22,7 +21,6 @@ export declare namespace MoonshotModelProvider {
auth: ModelProviderAuth.Raw;
base_url?: string | null;
models: ModelEntry.Raw[];
- name?: "moonshot" | null;
type: "moonshot";
}
}
diff --git a/packages/sdk/src/serialization/types/OpenAiModelProvider.ts b/packages/sdk/src/serialization/types/OpenAiModelProvider.ts
index c5dff8d7d..cd2e3fc70 100644
--- a/packages/sdk/src/serialization/types/OpenAiModelProvider.ts
+++ b/packages/sdk/src/serialization/types/OpenAiModelProvider.ts
@@ -13,7 +13,6 @@ export const OpenAiModelProvider: core.serialization.ObjectSchema<
auth: ModelProviderAuth,
baseUrl: core.serialization.property("base_url", core.serialization.string().optional()),
models: core.serialization.list(ModelEntry),
- name: core.serialization.stringLiteral("openai").optional(),
type: core.serialization.stringLiteral("openai"),
});
@@ -22,7 +21,6 @@ export declare namespace OpenAiModelProvider {
auth: ModelProviderAuth.Raw;
base_url?: string | null;
models: ModelEntry.Raw[];
- name?: "openai" | null;
type: "openai";
}
}
diff --git a/packages/sdk/src/serialization/types/TogetherAiModelProvider.ts b/packages/sdk/src/serialization/types/TogetherAiModelProvider.ts
index 7fe627691..bd3fd4385 100644
--- a/packages/sdk/src/serialization/types/TogetherAiModelProvider.ts
+++ b/packages/sdk/src/serialization/types/TogetherAiModelProvider.ts
@@ -13,7 +13,6 @@ export const TogetherAiModelProvider: core.serialization.ObjectSchema<
auth: ModelProviderAuth,
baseUrl: core.serialization.property("base_url", core.serialization.string().optional()),
models: core.serialization.list(ModelEntry),
- name: core.serialization.stringLiteral("together").optional(),
type: core.serialization.stringLiteral("together"),
});
@@ -22,7 +21,6 @@ export declare namespace TogetherAiModelProvider {
auth: ModelProviderAuth.Raw;
base_url?: string | null;
models: ModelEntry.Raw[];
- name?: "together" | null;
type: "together";
}
}
diff --git a/packages/sdk/src/serialization/types/ZaiModelProvider.ts b/packages/sdk/src/serialization/types/ZaiModelProvider.ts
index 619cf5731..f31a6e733 100644
--- a/packages/sdk/src/serialization/types/ZaiModelProvider.ts
+++ b/packages/sdk/src/serialization/types/ZaiModelProvider.ts
@@ -13,7 +13,6 @@ export const ZaiModelProvider: core.serialization.ObjectSchema<
auth: ModelProviderAuth,
baseUrl: core.serialization.property("base_url", core.serialization.string().optional()),
models: core.serialization.list(ModelEntry),
- name: core.serialization.stringLiteral("zai").optional(),
type: core.serialization.stringLiteral("zai"),
});
@@ -22,7 +21,6 @@ export declare namespace ZaiModelProvider {
auth: ModelProviderAuth.Raw;
base_url?: string | null;
models: ModelEntry.Raw[];
- name?: "zai" | null;
type: "zai";
}
}
diff --git a/packages/sdk/tests/wire/settings/modelProviders.test.ts b/packages/sdk/tests/wire/settings/modelProviders.test.ts
index 37f336039..f8e7d29ec 100644
--- a/packages/sdk/tests/wire/settings/modelProviders.test.ts
+++ b/packages/sdk/tests/wire/settings/modelProviders.test.ts
@@ -15,7 +15,6 @@ describe("ModelProvidersClient", () => {
auth: { api_key: "api_key" },
base_url: "base_url",
models: [{ model_id: "model_id", name: "name", properties: {} }],
- name: "alibaba",
type: "alibaba",
},
],
@@ -44,7 +43,6 @@ describe("ModelProvidersClient", () => {
properties: {},
},
],
- name: "alibaba",
type: "alibaba",
},
],
@@ -102,7 +100,6 @@ describe("ModelProvidersClient", () => {
auth: { api_key: "api_key" },
base_url: "base_url",
models: [{ model_id: "model_id", name: "name", properties: {} }],
- name: "alibaba",
type: "alibaba",
},
};
@@ -142,7 +139,6 @@ describe("ModelProvidersClient", () => {
properties: {},
},
],
- name: "alibaba",
type: "alibaba",
},
});
diff --git a/packages/server/src/apis/modelProviders.ts b/packages/server/src/apis/modelProviders.ts
index 4b267e9a8..77893199d 100644
--- a/packages/server/src/apis/modelProviders.ts
+++ b/packages/server/src/apis/modelProviders.ts
@@ -7,6 +7,7 @@ import {
listModelProvidersRoute,
putModelProviderRoute,
} from '../routes/modelProviderRoutes';
+import { modelProviderName } from '../schemas/modelProvider';
import { TENANT_ID } from './sessions';
export interface ModelProvidersRouterDeps<TTransaction> {
@@ -26,9 +27,11 @@ export function createModelProvidersRouter<TTransaction>(deps: ModelProvidersRou
};
const putHandler: RouteHandler<typeof putModelProviderRoute> = async c => {
+ const provider = c.req.valid('json');
const record = await deps.modelProviderStore.upsertProvider({
tenant_id: TENANT_ID,
- manifest: c.req.valid('json'),
+ name: modelProviderName(provider),
+ manifest: provider,
});
return c.json({ data: record.manifest }, 200);
};
diff --git a/packages/server/src/db/modelProviderStore.ts b/packages/server/src/db/modelProviderStore.ts
index 8b55cf40f..192faacc3 100644
--- a/packages/server/src/db/modelProviderStore.ts
+++ b/packages/server/src/db/modelProviderStore.ts
@@ -23,7 +23,8 @@ export interface GetProviderInput {
export interface UpsertProviderInput {
tenant_id: string;
- /** Stored whole; its `name` becomes the row's key column. */
+ /** Derived from the document by `modelProviderName`, never chosen by the caller. */
+ name: ResourceName;
manifest: ModelProvider;
}
diff --git a/packages/server/src/db/postgres/model-provider-store/PostgresModelProviderStore.ts b/packages/server/src/db/postgres/model-provider-store/PostgresModelProviderStore.ts
index 52ffa0e81..d398a7086 100644
--- a/packages/server/src/db/postgres/model-provider-store/PostgresModelProviderStore.ts
+++ b/packages/server/src/db/postgres/model-provider-store/PostgresModelProviderStore.ts
@@ -58,7 +58,7 @@ export class PostgresModelProviderStore implements IModelProviderStore<Transacti
.insertInto('model_provider')
.values({
tenant_id: input.tenant_id,
- name: input.manifest.name,
+ name: input.name,
manifest: json(input.manifest),
created_at: now(),
updated_at: now(),
diff --git a/packages/server/src/db/sqlite/model-provider-store/SqliteModelProviderStore.ts b/packages/server/src/db/sqlite/model-provider-store/SqliteModelProviderStore.ts
index 2b0765663..acb6041ba 100644
--- a/packages/server/src/db/sqlite/model-provider-store/SqliteModelProviderStore.ts
+++ b/packages/server/src/db/sqlite/model-provider-store/SqliteModelProviderStore.ts
@@ -58,7 +58,7 @@ export class SqliteModelProviderStore implements IModelProviderStore<Transaction
.insertInto('model_provider')
.values({
tenant_id: input.tenant_id,
- name: input.manifest.name,
+ name: input.name,
manifest: jsonbBind(input.manifest),
created_at: timestamp,
updated_at: timestamp,
diff --git a/packages/server/src/routes/modelProviderRoutes.ts b/packages/server/src/routes/modelProviderRoutes.ts
index 8b9ef94c9..92dd65d1e 100644
--- a/packages/server/src/routes/modelProviderRoutes.ts
+++ b/packages/server/src/routes/modelProviderRoutes.ts
@@ -19,8 +19,9 @@ export const getModelProviderCatalogRoute = createRoute({
tags: [MODEL_PROVIDERS_TAG],
summary: 'Get the model catalog',
description:
- 'Provider and model presets shipped with the server (model-catalog.yaml). Discovery-only: copy an entry ' +
- 'into PUT /settings/model-providers to configure it. 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. ' +
+ 'Custom providers are not listed here.',
'x-fern-sdk-group-name': ['settings', 'modelProviders'],
'x-fern-sdk-method-name': 'catalog',
responses: {
@@ -69,9 +70,9 @@ export const putModelProviderRoute = createRoute({
tags: [MODEL_PROVIDERS_TAG],
summary: 'Create or replace a model provider',
description:
- 'Full upsert keyed by `name`: creates the provider or replaces its entire configuration (models included). ' +
- 'Every type but `custom` is named after itself, so each is limited to one configured provider and a repeat ' +
- 'call replaces it; only `custom` providers are named, and numbered, by the caller.',
+ 'Full upsert: creates the provider or replaces its entire configuration (models included). The key is the ' +
+ 'returned `name`, which every type but `custom` takes from its own `type`, so each is limited to one ' +
+ 'configured provider and a repeat call replaces it; only `custom` providers are named by the caller.',
'x-fern-sdk-group-name': ['settings', 'modelProviders'],
'x-fern-sdk-method-name': 'upsert',
request: {
diff --git a/packages/server/src/schemas/modelProvider.ts b/packages/server/src/schemas/modelProvider.ts
index 8b952ded0..dc2671250 100644
--- a/packages/server/src/schemas/modelProvider.ts
+++ b/packages/server/src/schemas/modelProvider.ts
@@ -5,7 +5,7 @@
*/
import { z } from '@hono/zod-openapi';
import { SUPPORTED_REASONING_EFFORTS, VERCEL_AI_PROVIDER_NAMES } from '@truefoundry/utils-core/core';
-import { NameSchema, uniqueNames } from './common';
+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');
@@ -69,8 +69,9 @@ const ModelProviderManifestBaseSchema = z
.strict();
/**
- * Naming a provider after its type limits a tenant to one of each: the `(tenant_id, name)` primary
- * key replaces the row rather than adding a sibling. `base_url` defaults to the adapter's endpoint.
+ * A well-known provider has no name of its own: it is named after its type, which limits a tenant to
+ * 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'>>({
type,
@@ -81,7 +82,6 @@ function wellKnownProviderSchema<Type extends Exclude<ProviderType, 'custom'>>({
}) {
return ModelProviderManifestBaseSchema.extend({
type: z.literal(type),
- name: z.literal(type).default(type),
base_url: z.url().default(base_url).describe("Override of the provider's default API base URL."),
}).strict();
}
@@ -126,6 +126,7 @@ const AlibabaModelProviderSchema = wellKnownProviderSchema({
base_url: 'https://dashscope-intl.aliyuncs.com/compatible-mode/v1',
}).openapi('AlibabaModelProvider');
+/** The one type a caller names, because only it supplies its own endpoint. */
const CustomModelProviderSchema = ModelProviderManifestBaseSchema.extend({
type: z.literal('custom'),
name: NameSchema,
@@ -134,18 +135,6 @@ const CustomModelProviderSchema = ModelProviderManifestBaseSchema.extend({
.strict()
.openapi('CustomModelProvider');
-const MODEL_PROVIDER_SCHEMAS = [
- OpenAiModelProviderSchema,
- AnthropicModelProviderSchema,
- GoogleGeminiModelProviderSchema,
- FireworksModelProviderSchema,
- ZaiModelProviderSchema,
- MoonshotModelProviderSchema,
- TogetherAIModelProviderSchema,
- AlibabaModelProviderSchema,
- CustomModelProviderSchema,
-] as const;
-
export function refineModelProviderManifest(
manifest: { models: { model_id: string; name: string }[] },
ctx: z.RefinementCtx,
@@ -157,13 +146,29 @@ export type ModelProperties = z.infer<typeof ModelPropertiesSchema>;
/**
* Configured provider: PUT body, response data, and the persisted `model_provider.manifest` document
- * in one shape. The `name` column is written from it, so the two cannot disagree.
+ * in one shape. Only `custom` carries a name, so the row's key column comes from
+ * `modelProviderName` rather than from a field every type repeats.
*/
export const ModelProviderSchema = z
- .discriminatedUnion('type', MODEL_PROVIDER_SCHEMAS)
+ .discriminatedUnion('type', [
+ OpenAiModelProviderSchema,
+ AnthropicModelProviderSchema,
+ GoogleGeminiModelProviderSchema,
+ FireworksModelProviderSchema,
+ ZaiModelProviderSchema,
+ MoonshotModelProviderSchema,
+ TogetherAIModelProviderSchema,
+ AlibabaModelProviderSchema,
+ CustomModelProviderSchema,
+ ])
.superRefine(refineModelProviderManifest)
.openapi('ModelProvider');
+/** The row's key: only `custom` carries a name of its own. */
+export function modelProviderName(provider: ModelProvider): ResourceName {
+ return provider.type === 'custom' ? provider.name : provider.type;
+}
+
export const PutModelProviderRequestSchema = ModelProviderSchema;
export const ListModelProvidersResponseSchema = z
diff --git a/packages/server/tests/db/modelProviderStoreContractSuite.ts b/packages/server/tests/db/modelProviderStoreContractSuite.ts
index ac3828d47..d70eeface 100644
--- a/packages/server/tests/db/modelProviderStoreContractSuite.ts
+++ b/packages/server/tests/db/modelProviderStoreContractSuite.ts
@@ -7,10 +7,9 @@ import type { ModelProvider } from '../../src/schemas/modelProvider';
const TENANT = 'default';
-/** Each type pins its own `name`, so one fixture per provider. */
+/** The API derives the row's name from the document; these fixtures pass it explicitly. */
const anthropic = {
type: 'anthropic',
- name: 'anthropic',
base_url: 'https://api.anthropic.com/v1',
auth: { api_key: 'sk-ant-test' },
models: [
@@ -24,7 +23,6 @@ const anthropic = {
const openai = {
type: 'openai',
- name: 'openai',
base_url: 'https://api.openai.com/v1',
auth: { api_key: 'sk-oai-test' },
models: [
@@ -45,7 +43,7 @@ const ISO_UTC = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/;
export function runModelProviderStoreContractSuite(getStore: () => IModelProviderStore): void {
it('upsert creates a provider and round-trips the document', async () => {
const store = getStore();
- const created = await store.upsertProvider({ tenant_id: TENANT, manifest: anthropic });
+ const created = await store.upsertProvider({ tenant_id: TENANT, name: 'anthropic', manifest: anthropic });
expect(created.tenant_id).toBe(TENANT);
expect(created.name).toBe('anthropic');
@@ -64,7 +62,7 @@ export function runModelProviderStoreContractSuite(getStore: () => IModelProvide
it('upsert replaces the whole document and preserves created_at', async () => {
const store = getStore();
- const created = await store.upsertProvider({ tenant_id: TENANT, manifest: anthropic });
+ const created = await store.upsertProvider({ tenant_id: TENANT, name: 'anthropic', manifest: anthropic });
const replacement = {
...anthropic,
@@ -77,7 +75,7 @@ export function runModelProviderStoreContractSuite(getStore: () => IModelProvide
},
],
};
- const updated = await store.upsertProvider({ tenant_id: TENANT, manifest: replacement });
+ const updated = await store.upsertProvider({ tenant_id: TENANT, name: 'anthropic', manifest: replacement });
expect(updated.manifest).toEqual(replacement);
expect(updated.created_at).toBe(created.created_at);
@@ -89,9 +87,9 @@ export function runModelProviderStoreContractSuite(getStore: () => IModelProvide
it('listProviders returns only the tenant, ordered by name', async () => {
const store = getStore();
- await store.upsertProvider({ tenant_id: TENANT, manifest: openai });
- await store.upsertProvider({ tenant_id: TENANT, manifest: anthropic });
- await store.upsertProvider({ tenant_id: 'other-tenant', manifest: anthropic });
+ await store.upsertProvider({ tenant_id: TENANT, name: 'openai', manifest: openai });
+ await store.upsertProvider({ tenant_id: TENANT, name: 'anthropic', manifest: anthropic });
+ await store.upsertProvider({ tenant_id: 'other-tenant', name: 'anthropic', manifest: anthropic });
const providers = await store.listProviders(TENANT);
expect(providers.map(record => record.name)).toEqual(['anthropic', 'openai']);
@@ -100,15 +98,15 @@ export function runModelProviderStoreContractSuite(getStore: () => IModelProvide
it('stores custom providers with base_url', async () => {
const store = getStore();
- const created = await store.upsertProvider({ tenant_id: TENANT, manifest: custom });
+ const created = await store.upsertProvider({ tenant_id: TENANT, name: custom.name, manifest: custom });
expect(created.manifest.base_url).toBe('https://llm.internal.example.com/v1');
});
it('listModels flattens documents into fully qualified names', async () => {
const store = getStore();
- await store.upsertProvider({ tenant_id: TENANT, manifest: anthropic });
- await store.upsertProvider({ tenant_id: TENANT, manifest: openai });
- await store.upsertProvider({ tenant_id: 'other-tenant', manifest: openai });
+ await store.upsertProvider({ tenant_id: TENANT, name: 'anthropic', manifest: anthropic });
+ await store.upsertProvider({ tenant_id: TENANT, name: 'openai', manifest: openai });
+ await store.upsertProvider({ tenant_id: 'other-tenant', name: 'openai', manifest: openai });
const models = await store.listModels(TENANT);
expect(models).toEqual([
diff --git a/packages/server/tests/unit/apis/agents.test.ts b/packages/server/tests/unit/apis/agents.test.ts
index 60074b5e0..6a6eb805f 100644
--- a/packages/server/tests/unit/apis/agents.test.ts
+++ b/packages/server/tests/unit/apis/agents.test.ts
@@ -9,7 +9,6 @@ import { SqliteSkillStore } from '../../../src/db/sqlite/skill-store/SqliteSkill
const modelProvider = {
type: 'anthropic' as const,
- name: 'anthropic' as const,
base_url: 'https://api.anthropic.com/v1',
auth: { api_key: 'sk-ant-secret' },
models: [
@@ -47,7 +46,7 @@ describe('agents router', () => {
const db = createSqliteDb(':memory:');
await migrateSqliteToLatest(db);
const modelProviderStore = new SqliteModelProviderStore(db);
- await modelProviderStore.upsertProvider({ tenant_id: 'default', manifest: modelProvider });
+ await modelProviderStore.upsertProvider({ tenant_id: 'default', name: 'anthropic', manifest: modelProvider });
router = createAgentsRouter({
agentStore: new SqliteAgentStore(db),
modelProviderStore,
diff --git a/packages/server/tests/unit/apis/modelProviders.test.ts b/packages/server/tests/unit/apis/modelProviders.test.ts
index 957ce2a27..62b68b4ec 100644
--- a/packages/server/tests/unit/apis/modelProviders.test.ts
+++ b/packages/server/tests/unit/apis/modelProviders.test.ts
@@ -25,8 +25,8 @@ const anthropicBody = {
models: [model],
};
-/** What the body above is stored and echoed as: named after its type, endpoint from its schema. */
-const anthropicProvider = { ...anthropicBody, name: 'anthropic', base_url: 'https://api.anthropic.com/v1' };
+/** What the body above is stored and echoed as: no name of its own, endpoint from its schema. */
+const anthropicProvider = { ...anthropicBody, base_url: 'https://api.anthropic.com/v1' };
const customBody = {
type: 'custom' as const,
@@ -113,7 +113,7 @@ describe('settings model-providers and models routers', () => {
});
it('PUT rejects invalid bodies at the Zod layer', async () => {
- const badName = await settingsRouter.request('/model-providers', putInit({ ...anthropicBody, name: 'Not A Name' }));
+ const badName = await settingsRouter.request('/model-providers', putInit({ ...customBody, name: 'Not A Name' }));
expect(badName.status).toBe(400);
});
@@ -155,10 +155,15 @@ describe('well-known types are limited to one provider', () => {
]);
});
- it('PUT rejects a name of its own for a well-known type', async () => {
+ it('PUT takes no name for a well-known type, not even its own', async () => {
const { settingsRouter } = await createRouters();
- const named = await settingsRouter.request('/model-providers', putInit({ ...anthropicBody, name: 'anthropic-eu' }));
- expect(named.status).toBe(400);
+ const sibling = await settingsRouter.request(
+ '/model-providers',
+ putInit({ ...anthropicBody, name: 'anthropic-eu' }),
+ );
+ expect(sibling.status).toBe(400);
+ const echoed = await settingsRouter.request('/model-providers', putInit({ ...anthropicBody, name: 'anthropic' }));
+ expect(echoed.status).toBe(400);
const list = await settingsRouter.request('/model-providers');
expect(await list.json()).toEqual({ data: [] });
@@ -187,11 +192,12 @@ describe('catalog presets are configurable', () => {
// A preset is copied into a PUT body with an api_key added, so every catalog type must parse.
it.each(ModelCatalog.load().list())('PUT accepts the $type preset', async preset => {
const { settingsRouter } = await createRouters();
- // `logo` is catalog-only metadata; everything else copies straight into a PUT body.
- const { logo, ...presetWithoutLogo } = preset;
+ // `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 body = {
- ...presetWithoutLogo,
- auth: { api_key: `sk-${preset.name}` },
+ ...presetFields,
+ auth: { api_key: `sk-${name}` },
};
expect(logo === undefined || typeof logo === 'string').toBe(true);
const response = await settingsRouter.request('/model-providers', putInit(body));
diff --git a/packages/server/tests/unit/apis/sessionHttp.test.ts b/packages/server/tests/unit/apis/sessionHttp.test.ts
index 7f6c75820..a18a010c8 100644
--- a/packages/server/tests/unit/apis/sessionHttp.test.ts
+++ b/packages/server/tests/unit/apis/sessionHttp.test.ts
@@ -45,9 +45,9 @@ describe('sessions HTTP agent binding', () => {
await modelProviderStore.upsertProvider({
tenant_id: TENANT_ID,
+ name: 'anthropic',
manifest: {
type: 'anthropic',
- name: 'anthropic',
base_url: 'https://api.anthropic.com/v1',
auth: { api_key: 'sk-ant-secret' },
models: [
diff --git a/packages/server/tests/unit/apis/turnHarnessErrorStatus.test.ts b/packages/server/tests/unit/apis/turnHarnessErrorStatus.test.ts
index e2f62ca37..fef41ddc5 100644
--- a/packages/server/tests/unit/apis/turnHarnessErrorStatus.test.ts
+++ b/packages/server/tests/unit/apis/turnHarnessErrorStatus.test.ts
@@ -22,6 +22,7 @@ async function postTurnRejectingWith(error: AgentHarnessError): Promise<Response
const modelProviderStore = new SqliteModelProviderStore(db);
await modelProviderStore.upsertProvider({
tenant_id: 'default',
+ name: 'test-provider',
manifest: {
type: 'custom',
name: 'test-provider',
diff --git a/packages/server/tests/unit/apis/turns.test.ts b/packages/server/tests/unit/apis/turns.test.ts
index 6711a5574..e48f1c97a 100644
--- a/packages/server/tests/unit/apis/turns.test.ts
+++ b/packages/server/tests/unit/apis/turns.test.ts
@@ -106,6 +106,7 @@ describe('turns', () => {
const modelProviderStore = new SqliteModelProviderStore(db);
await modelProviderStore.upsertProvider({
tenant_id: 'default',
+ name: 'test-provider',
manifest: {
// Caller-named, so `custom` is the only type it can be.
type: 'custom',
@@ -222,6 +223,7 @@ describe('turns', () => {
const modelProviderStore = new SqliteModelProviderStore(db);
await modelProviderStore.upsertProvider({
tenant_id: 'default',
+ name: 'test-provider',
manifest: {
// Caller-named, so `custom` is the only type it can be.
type: 'custom',
diff --git a/packages/server/tests/unit/runtime/sessionResources.test.ts b/packages/server/tests/unit/runtime/sessionResources.test.ts
index e5882e5ce..4d97ae93f 100644
--- a/packages/server/tests/unit/runtime/sessionResources.test.ts
+++ b/packages/server/tests/unit/runtime/sessionResources.test.ts
@@ -17,6 +17,7 @@ describe('validateAgentSpec', () => {
const modelProviderStore = new SqliteModelProviderStore(db);
await modelProviderStore.upsertProvider({
tenant_id: TENANT_ID,
+ name: 'test-provider',
manifest: {
// Caller-named, so `custom` is the only type it can be.
type: 'custom',
diff --git a/packages/server/tests/unit/schemas/modelProvider.test.ts b/packages/server/tests/unit/schemas/modelProvider.test.ts
index a761acb03..268e2c2e4 100644
--- a/packages/server/tests/unit/schemas/modelProvider.test.ts
+++ b/packages/server/tests/unit/schemas/modelProvider.test.ts
@@ -1,23 +1,28 @@
import { VERCEL_AI_PROVIDER_NAMES } from '@truefoundry/utils-core/core';
-import { ModelProviderSchema } from '../../../src/schemas/modelProvider';
+import { ModelProviderSchema, modelProviderName } from '../../../src/schemas/modelProvider';
const models = [{ model_id: 'a-model', name: 'a-model', properties: {} }];
function parse(body: Record<string, unknown>): { success: boolean; name?: string; base_url?: string } {
const result = ModelProviderSchema.safeParse({ auth: { api_key: 'k' }, models, ...body });
return result.success
- ? { success: true, name: result.data.name, base_url: result.data.base_url }
+ ? { success: true, name: modelProviderName(result.data), base_url: result.data.base_url }
: { success: false };
}
-/** A custom endpoint is arbitrary, so there is nothing to default to. */
-const TYPES_WITHOUT_DEFAULT_BASE_URL = ['custom'];
+/** A custom endpoint is arbitrary, so there is nothing to default to, and nothing to name it after. */
+const CALLER_SUPPLIED_TYPES = ['custom'];
+
+/** Only `custom` takes a name; the others reject one, so fixtures name just that type. */
+function providerFor(type: string, body: Record<string, unknown> = {}): Record<string, unknown> {
+ return { type, ...(CALLER_SUPPLIED_TYPES.includes(type) ? { name: 'internal' } : {}), ...body };
+}
describe('ModelProviderSchema', () => {
// A type with no schema of its own leaves its catalog entries unconfigurable.
it('can configure every adapter the harness can build', () => {
const rejected = VERCEL_AI_PROVIDER_NAMES.filter(
- type => !parse({ type, name: type, base_url: 'https://example.com/v1' }).success,
+ type => !parse(providerFor(type, { base_url: 'https://example.com/v1' })).success,
);
expect(rejected).toEqual([]);
});
@@ -25,8 +30,8 @@ describe('ModelProviderSchema', () => {
// A named endpoint keeps buildLanguageModel off its adapter's implicit default.
it('defaults base_url for every type that has a known endpoint', () => {
for (const type of VERCEL_AI_PROVIDER_NAMES) {
- const parsed = parse({ type });
- if (TYPES_WITHOUT_DEFAULT_BASE_URL.includes(type)) {
+ const parsed = parse(providerFor(type));
+ if (CALLER_SUPPLIED_TYPES.includes(type)) {
expect([type, parsed.success]).toEqual([type, false]);
} else {
expect([type, parsed.base_url]).toEqual([type, expect.stringMatching(/^https:\/\//)]);
@@ -40,10 +45,10 @@ describe('ModelProviderSchema', () => {
);
});
- // Pinning the name to the type is what makes a second write replace the first.
- it('names every type but custom after itself', () => {
+ // Deriving the name is what makes a second write replace the first, so the body cannot carry one.
+ it('names every type but custom after itself, and takes no name from the caller', () => {
expect(parse({ type: 'anthropic' }).name).toBe('anthropic');
- expect(parse({ type: 'anthropic', name: 'anthropic' }).name).toBe('anthropic');
+ expect(parse({ type: 'anthropic', name: 'anthropic' }).success).toBe(false);
expect(parse({ type: 'anthropic', name: 'anthropic-eu' }).success).toBe(false);
});