The open-source agent harness - the runtime layer that turns an LLM into a working agent.
Make API key optional for custom model providers (#180)
Bhavesh Patel0595457814bb
diff --git a/.github/fern/openapi/openapi.json b/.github/fern/openapi/openapi.jsonindex 9401f0c92..ce3bf8922 100644--- a/.github/fern/openapi/openapi.json+++ b/.github/fern/openapi/openapi.json@@ -863,7 +863,6 @@}},"required": [- "auth","models","type","name",diff --git a/packages/frontend/src/modelProviderCatalog.ts b/packages/frontend/src/modelProviderCatalog.tsindex f0061d7cc..49af9c0c4 100644--- a/packages/frontend/src/modelProviderCatalog.ts+++ b/packages/frontend/src/modelProviderCatalog.ts@@ -84,7 +84,6 @@ export function toHarnessModelProvider(req: {models: UiModelEntry[];}): TrueForgeApi.ModelProvider {const models = req.models.map(toHarnessModelEntry);- const auth = { apiKey: req.apiKey };if (!isProviderType(req.type)) {throw new Error(`Unsupported model provider type: ${req.type}`);}@@ -94,28 +93,41 @@ export function toHarnessModelProvider(req: {if (baseUrl === undefined) {throw new Error(`Model providers of type "${req.type}" require a base URL`);}- return { type: req.type, name: req.name, auth, models, baseUrl };+ // Blank form field is ""; custom must omit auth on the wire (empty string is rejected).+ return {+ type: req.type,+ name: req.name,+ models,+ baseUrl,+ ...(req.apiKey === '' ? {} : { auth: { apiKey: req.apiKey } }),+ };}+ const auth = { apiKey: req.apiKey };if (baseUrl !== undefined) {return { type: req.type, auth, models, baseUrl };}return { type: req.type, auth, models };}-async function resolveApiKey(req: { id?: string; apiKey: string }): Promise<string> {+async function resolveApiKey(req: { id?: string; type?: string; apiKey: string }): Promise<string> {const trimmed = req.apiKey.trim();if (trimmed !== '') {return trimmed;}if (req.id === undefined) {+ // Create with a blank key: allow only for custom; "" is mapped to omitted auth below.+ if (req.type === 'custom') {+ return '';+ }throw new Error('API key is required');}+ // Update with empty means keep the stored key.const listed = await client.settings.modelProviders.list();const existing = listed.data.find(provider => toUiModelProvider(provider).id === req.id);if (existing === undefined) {throw new Error(`Model provider "${req.id}" not found`);}- return existing.auth.apiKey;+ return existing.auth?.apiKey ?? '';}async function upsertFromUi(req: {@@ -155,7 +167,7 @@ export function createModelProviderCatalog(): ModelCatalogServer<return body.data.map(toUiModelProvider);},createModelProvider: async req => {- const apiKey = await resolveApiKey({ apiKey: req.apiKey });+ const apiKey = await resolveApiKey({ type: req.type, apiKey: req.apiKey });return upsertFromUi({type: req.type,name: req.name,@@ -166,7 +178,7 @@ export function createModelProviderCatalog(): ModelCatalogServer<},updateModelProvider: async req => {// UI sends apiKey: "" when only models change; reuse the stored key.- const apiKey = await resolveApiKey({ id: req.id, apiKey: req.apiKey });+ const apiKey = await resolveApiKey({ id: req.id, type: req.type, apiKey: req.apiKey });return upsertFromUi({type: req.type,name: req.id,diff --git a/packages/frontend/tests/modelProviderCatalog.test.ts b/packages/frontend/tests/modelProviderCatalog.test.tsindex 580a48568..3097971ab 100644--- a/packages/frontend/tests/modelProviderCatalog.test.ts+++ b/packages/frontend/tests/modelProviderCatalog.test.ts@@ -160,6 +160,28 @@ describe('modelProviderCatalog mappers', () => {],},);++ assert.deepEqual(+ toHarnessModelProvider({+ type: 'custom',+ name: 'local-llama',+ apiKey: '',+ baseUrl: 'http://127.0.0.1:11434/v1',+ models: [{ id: 'llama3', name: 'llama3' }],+ }),+ {+ type: 'custom',+ name: 'local-llama',+ baseUrl: 'http://127.0.0.1:11434/v1',+ models: [+ {+ modelId: 'llama3',+ name: 'llama3',+ properties: {},+ },+ ],+ },+ );});it('rejects custom providers without a base URL', () => {diff --git a/packages/sdk/.fern/metadata.json b/packages/sdk/.fern/metadata.jsonindex 377669d7e..6910e5b7b 100644--- a/packages/sdk/.fern/metadata.json+++ b/packages/sdk/.fern/metadata.json@@ -28,7 +28,7 @@"streamType": "web","useDefaultRequestParameterValues": true},- "originGitCommit": "1b85847acb5099742cb53678d3c608af90930147",+ "originGitCommit": "98015f5b2b16475ab69e6a0c6b67fc44d803bca7","originGitCommitIsDirty": true,"invokedBy": "ci","requestedVersion": "0.0.0",diff --git a/packages/sdk/src/api/types/CustomModelProvider.ts b/packages/sdk/src/api/types/CustomModelProvider.tsindex 2ff352baa..51f2cea0b 100644--- a/packages/sdk/src/api/types/CustomModelProvider.ts+++ b/packages/sdk/src/api/types/CustomModelProvider.ts@@ -3,7 +3,7 @@import type * as TrueForge from "../index.js";export interface CustomModelProvider {- auth: TrueForge.ModelProviderAuth;+ auth?: TrueForge.ModelProviderAuth;/** Base URL of the provider's API. */baseUrl: string;/** Models exposed by this provider (at least one). */diff --git a/packages/sdk/src/serialization/types/CustomModelProvider.ts b/packages/sdk/src/serialization/types/CustomModelProvider.tsindex b55d29c5c..dec97b6aa 100644--- a/packages/sdk/src/serialization/types/CustomModelProvider.ts+++ b/packages/sdk/src/serialization/types/CustomModelProvider.ts@@ -11,7 +11,7 @@ export const CustomModelProvider: core.serialization.ObjectSchema<serializers.CustomModelProvider.Raw,TrueForge.CustomModelProvider> = core.serialization.object({- auth: ModelProviderAuth,+ auth: ModelProviderAuth.optional(),baseUrl: core.serialization.property("base_url", core.serialization.string()),models: core.serialization.list(ModelEntry),name: ResourceName,@@ -20,7 +20,7 @@ export const CustomModelProvider: core.serialization.ObjectSchema<export declare namespace CustomModelProvider {export interface Raw {- auth: ModelProviderAuth.Raw;+ auth?: ModelProviderAuth.Raw | null;base_url: string;models: ModelEntry.Raw[];name: ResourceName.Raw;diff --git a/packages/server/src/apis/modelProviders.ts b/packages/server/src/apis/modelProviders.tsindex 19a4903ae..2c79e9081 100644--- a/packages/server/src/apis/modelProviders.ts+++ b/packages/server/src/apis/modelProviders.ts@@ -20,6 +20,9 @@ export interface ModelProvidersRouterDeps<TTransaction> {}function redactModelProvider(manifest: ModelProvider): ModelProvider {+ if (manifest.auth === undefined) {+ return manifest;+ }return {...manifest,auth: { api_key: toRedactedSecretValue(manifest.auth.api_key) },@@ -54,15 +57,18 @@ export function createModelProvidersRouter<TTransaction>(deps: ModelProvidersRou{ tenant_id: TENANT_ID, name },transaction,);- const manifest: ModelProvider = {- ...provider,- auth: {- api_key: resolveStoredSecretValue({- incoming: provider.auth.api_key,- existing: existing?.manifest.auth.api_key,- }),- },- };+ const manifest: ModelProvider =+ provider.auth === undefined+ ? provider+ : {+ ...provider,+ auth: {+ api_key: resolveStoredSecretValue({+ incoming: provider.auth.api_key,+ existing: existing?.manifest.auth?.api_key,+ }),+ },+ };return deps.modelProviderStore.upsertProvider({ tenant_id: TENANT_ID, name, manifest }, transaction);});return c.json({ data: redactModelProvider(record.manifest) }, 200);diff --git a/packages/server/src/runtime/sessionResources.ts b/packages/server/src/runtime/sessionResources.tsindex ea058fda8..c2acd6805 100644--- a/packages/server/src/runtime/sessionResources.ts+++ b/packages/server/src/runtime/sessionResources.ts@@ -81,7 +81,9 @@ export async function getModelProviderConfig({name,modelId: model.model_id,baseUrl: base_url,- apiKey: provider.manifest.auth.api_key,+ // Custom providers may omit auth; adapters still require a string.+ apiKey: provider.manifest.auth?.api_key ?? '',+headers: {},};}diff --git a/packages/server/src/schemas/modelProvider.ts b/packages/server/src/schemas/modelProvider.tsindex e6b4dd4d0..fc2d86c18 100644--- a/packages/server/src/schemas/modelProvider.ts+++ b/packages/server/src/schemas/modelProvider.ts@@ -136,6 +136,7 @@ const CustomModelProviderSchema = ModelProviderManifestBaseSchema.extend({type: z.literal('custom'),name: NameSchema,base_url: z.url().describe("Base URL of the provider's API."),+ auth: ModelProviderAuthSchema.optional(),}).strict().openapi('CustomModelProvider');diff --git a/packages/server/tests/unit/apis/modelProviders.test.ts b/packages/server/tests/unit/apis/modelProviders.test.tsindex 80ada9b28..af460ddee 100644--- a/packages/server/tests/unit/apis/modelProviders.test.ts+++ b/packages/server/tests/unit/apis/modelProviders.test.ts@@ -164,6 +164,71 @@ describe('settings model-providers and models routers', () => {});});+describe('custom providers may omit auth', () => {+ const model = {+ model_id: 'llama',+ name: 'llama',+ properties: { reasoning_efforts: ['minimal', 'low'] },+ };++ it.each([+ { label: 'auth omitted', auth: undefined, name: 'llama-no-key' },+ {+ label: 'auth set api_key',+ auth: { api_key: 'qwerty' },+ name: 'llama-with-key',+ },+ ])('PUT stores and lists custom provider with $label', async ({ auth, name }) => {+ const { settingsRouter } = await createRouters();+ const body = {+ type: 'custom' as const,+ name,+ base_url: 'http://localhost:11434/v1',+ models: [model],+ ...(auth === undefined ? {} : { auth }),+ };+ const expectedWire = auth === undefined ? body : withRedactedApiKey(body);++ const put = await settingsRouter.request('/model-providers', putInit(body));+ expect(put.status).toBe(200);+ expect(await put.json()).toEqual({ data: expectedWire });++ const list = await settingsRouter.request('/model-providers');+ expect(list.status).toBe(200);+ expect(await list.json()).toEqual({ data: [expectedWire] });+ });++ it('rejects empty api_key', async () => {+ const { settingsRouter } = await createRouters();+ const put = await settingsRouter.request(+ '/model-providers',+ putInit({+ type: 'custom',+ name: 'llama-empty-key',+ base_url: 'http://localhost:11434/v1',+ auth: { api_key: '' },+ models: [model],+ }),+ );+ expect(put.status).toBe(400);+ });++ it('rejects auth without api_key', async () => {+ const { settingsRouter } = await createRouters();+ const put = await settingsRouter.request(+ '/model-providers',+ putInit({+ type: 'custom',+ name: 'llama-empty-auth',+ base_url: 'http://localhost:11434/v1',+ auth: {},+ models: [model],+ }),+ );+ expect(put.status).toBe(400);+ });+});+describe('well-known types are limited to one provider', () => {it('PUT replaces the configured provider instead of adding a second of the type', async () => {const { settingsRouter, modelsRouter } = await createRouters();diff --git a/packages/trueforge-ui-sdk/src/containers/SettingsBuilder/CustomModelProviderForm.tsx b/packages/trueforge-ui-sdk/src/containers/SettingsBuilder/CustomModelProviderForm.tsxindex c487a74bd..0bcb830d6 100644--- a/packages/trueforge-ui-sdk/src/containers/SettingsBuilder/CustomModelProviderForm.tsx+++ b/packages/trueforge-ui-sdk/src/containers/SettingsBuilder/CustomModelProviderForm.tsx@@ -74,8 +74,7 @@ const CustomModelProviderForm = ({onOpenChange(nextOpen);};- const isValid =- !!name.trim() && !!baseUrl.trim() && !!apiKey.trim() && models.every(model => model.id.trim() && model.name.trim());+ const isValid = !!name.trim() && !!baseUrl.trim() && models.every(model => model.id.trim() && model.name.trim());const updateModel = (index: number, patch: Partial<ModelRow>) => {setModels(current => current.map((model, i) => (i === index ? { ...model, ...patch } : model)));@@ -156,17 +155,16 @@ const CustomModelProviderForm = ({<div><label htmlFor="custom-provider-api-key" className="mb-1.5 block text-sm font-medium text-foreground">API key- <RequiredMark />+ <span className="font-normal text-muted-foreground"> (optional)</span></label><inputid="custom-provider-api-key"type="password"- requiredvalue={apiKey}onChange={event => {setApiKey(event.target.value);}}- placeholder="Enter API Key"+ placeholder="Omit for unauthenticated endpoints"className={inputClassName}/></div>