Skip to content

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

Standardize agent API schema naming and request structure (#231)

Srajan Asthana050bbea0839a
diff --git a/.github/fern/openapi/openapi.json b/.github/fern/openapi/openapi.json
index 8cc7779e5..4f5f4a47e 100644
--- a/.github/fern/openapi/openapi.json
+++ b/.github/fern/openapi/openapi.json
@@ -24,36 +24,33 @@
]
},
"Agent": {
- "allOf": [
- {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "description": "Immutable server-generated agent identifier.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "manifest": {
"$ref": "#/components/schemas/AgentSpec"
},
- {
- "properties": {
- "id": {
- "description": "Immutable server-generated agent identifier.",
- "minLength": 1,
- "type": "string"
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ResourceName"
},
- "name": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ResourceName"
- },
- {
- "description": "Immutable unique agent name within the tenant."
- }
- ]
+ {
+ "description": "Fully qualified name. Unique within a tenant."
}
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
+ ]
}
+ },
+ "required": [
+ "id",
+ "name",
+ "manifest"
],
- "description": "Complete agent definition used inline on a session or saved as a named agent."
+ "type": "object"
},
"AgentInfo": {
"properties": {
@@ -182,32 +179,6 @@
],
"type": "object"
},
- "AgentWriteRequest": {
- "allOf": [
- {
- "$ref": "#/components/schemas/AgentSpec"
- },
- {
- "properties": {
- "name": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ResourceName"
- },
- {
- "description": "Fully qualified name. Unique within a tenant."
- }
- ]
- }
- },
- "required": [
- "name"
- ],
- "type": "object"
- }
- ],
- "description": "Complete agent definition used inline on a session or saved as a named agent."
- },
"AlibabaModelProvider": {
"additionalProperties": false,
"properties": {
@@ -808,14 +779,26 @@
},
"type": "object"
},
- "CreateAgentResponse": {
+ "CreateAgentRequest": {
+ "additionalProperties": false,
"properties": {
- "data": {
- "$ref": "#/components/schemas/Agent"
+ "manifest": {
+ "$ref": "#/components/schemas/AgentSpec"
+ },
+ "name": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/ResourceName"
+ },
+ {
+ "description": "Fully qualified name. Unique within a tenant."
+ }
+ ]
}
},
"required": [
- "data"
+ "name",
+ "manifest"
],
"type": "object"
},
@@ -1009,6 +992,10 @@
],
"type": "object"
},
+ "DeleteAgentResponse": {
+ "properties": {},
+ "type": "object"
+ },
"DynamicSubAgentsConfig": {
"default": {
"enabled": true
@@ -2491,14 +2478,15 @@
"default": "auto",
"description": "Defaults to 'auto' (chain to session last turn). Use 'none' for a new root turn."
},
- "PutAgentResponse": {
+ "PutAgentRequest": {
+ "additionalProperties": false,
"properties": {
- "data": {
- "$ref": "#/components/schemas/Agent"
+ "manifest": {
+ "$ref": "#/components/schemas/AgentSpec"
}
},
"required": [
- "data"
+ "manifest"
],
"type": "object"
},
@@ -4044,49 +4032,6 @@
}
]
},
- "UpdateAgentRequest": {
- "description": "Complete agent definition used inline on a session or saved as a named agent.",
- "properties": {
- "config": {
- "$ref": "#/components/schemas/RuntimeConfig"
- },
- "instructions": {
- "description": "Optional system prompt — the agent's role, behavior, and constraints.",
- "type": "string"
- },
- "mcp_servers": {
- "description": "Optional MCP servers attached by configured name.",
- "items": {
- "$ref": "#/components/schemas/MCPServer"
- },
- "type": "array"
- },
- "messages": {
- "description": "Optional seed user messages injected at the start of every session.",
- "items": {
- "$ref": "#/components/schemas/AgentSpecUserMessage"
- },
- "type": "array"
- },
- "model": {
- "$ref": "#/components/schemas/AgentSpecModel"
- },
- "response_format": {
- "$ref": "#/components/schemas/ResponseFormat"
- },
- "skills": {
- "description": "Optional name-only skill references. Requires `config.sandbox.enabled: true`.",
- "items": {
- "$ref": "#/components/schemas/SkillNameRef"
- },
- "type": "array"
- }
- },
- "required": [
- "model"
- ],
- "type": "object"
- },
"UpdateSessionRequest": {
"additionalProperties": false,
"properties": {
@@ -4298,18 +4243,18 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AgentWriteRequest"
+ "$ref": "#/components/schemas/CreateAgentRequest"
}
}
},
"required": true
},
"responses": {
- "200": {
+ "201": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CreateAgentResponse"
+ "$ref": "#/components/schemas/GetAgentResponse"
}
}
},
@@ -4374,7 +4319,14 @@
}
],
"responses": {
- "204": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DeleteAgentResponse"
+ }
+ }
+ },
"description": "Agent deleted."
},
"401": {
@@ -4443,26 +4395,20 @@
"agents"
],
"x-fern-sdk-method-name": "get"
- }
- },
- "/api/v1/agents/{name}": {
+ },
"put": {
- "description": "Replaces the AgentSpec for an existing agent keyed by immutable `name`.",
+ "description": "Replaces the manifest for an existing agent keyed by immutable `agent_id`.",
"parameters": [
{
- "description": "Immutable unique agent name within the tenant.",
+ "description": "Immutable agent identifier.",
"in": "path",
- "name": "name",
+ "name": "agent_id",
"required": true,
"schema": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ResourceName"
- },
- {
- "description": "Immutable unique agent name within the tenant."
- }
- ]
+ "description": "Immutable agent identifier.",
+ "maxLength": 64,
+ "minLength": 1,
+ "type": "string"
}
}
],
@@ -4470,7 +4416,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UpdateAgentRequest"
+ "$ref": "#/components/schemas/PutAgentRequest"
}
}
},
@@ -4481,7 +4427,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PutAgentResponse"
+ "$ref": "#/components/schemas/GetAgentResponse"
}
}
},
diff --git a/packages/sdk/.fern/metadata.json b/packages/sdk/.fern/metadata.json
index 17bb01d45..7c2aa2c1b 100644
--- a/packages/sdk/.fern/metadata.json
+++ b/packages/sdk/.fern/metadata.json
@@ -28,7 +28,7 @@
"streamType": "web",
"useDefaultRequestParameterValues": true
},
- "originGitCommit": "f5a7441846b361cf22892b725f31a3e3717e0fa4",
+ "originGitCommit": "5676ea0eb7e3d959b8bc49a361bd8782d4fdce6d",
"originGitCommitIsDirty": true,
"invokedBy": "ci",
"requestedVersion": "0.0.0",
diff --git a/packages/sdk/README.md b/packages/sdk/README.md
index 74476a0b2..8e8012610 100644
--- a/packages/sdk/README.md
+++ b/packages/sdk/README.md
@@ -63,7 +63,7 @@ following namespace:
```typescript
import { TrueForge } from "@truefoundry/trueforge-sdk";
-const request: TrueForge.AgentWriteRequest = {
+const request: TrueForge.CreateAgentRequest = {
...
};
```
diff --git a/packages/sdk/reference.md b/packages/sdk/reference.md
index fcee4249c..6809deefa 100644
--- a/packages/sdk/reference.md
+++ b/packages/sdk/reference.md
@@ -55,7 +55,7 @@ await client.agents.list();
</dl>
</details>
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">create</a>({ ...params }) -> TrueForge.CreateAgentResponse</code></summary>
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">create</a>({ ...params }) -> TrueForge.GetAgentResponse</code></summary>
<dl>
<dd>
@@ -83,8 +83,10 @@ Creates an agent and allocates an immutable id. Fails if `name` is already taken
```typescript
await client.agents.create({
- model: {
- name: "name"
+ manifest: {
+ model: {
+ name: "name"
+ }
},
name: "name"
});
@@ -103,7 +105,7 @@ await client.agents.create({
<dl>
<dd>
-**request:** `TrueForge.AgentWriteRequest`
+**request:** `TrueForge.CreateAgentRequest`
</dd>
</dl>
@@ -186,7 +188,7 @@ await client.agents.get("agent_id");
</dl>
</details>
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">delete</a>(agent_id) -> void</code></summary>
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">update</a>(agent_id, { ...params }) -> TrueForge.GetAgentResponse</code></summary>
<dl>
<dd>
@@ -198,7 +200,7 @@ await client.agents.get("agent_id");
<dl>
<dd>
-Delete a configured agent by immutable id. Idempotent if already gone.
+Replaces the manifest for an existing agent keyed by immutable `agent_id`.
</dd>
</dl>
</dd>
@@ -213,7 +215,13 @@ Delete a configured agent by immutable id. Idempotent if already gone.
<dd>
```typescript
-await client.agents.delete("agent_id");
+await client.agents.update("agent_id", {
+ manifest: {
+ model: {
+ name: "name"
+ }
+ }
+});
```
</dd>
@@ -237,6 +245,14 @@ await client.agents.delete("agent_id");
<dl>
<dd>
+**request:** `TrueForge.PutAgentRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
**requestOptions:** `AgentsClient.RequestOptions`
</dd>
@@ -249,7 +265,7 @@ await client.agents.delete("agent_id");
</dl>
</details>
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">update</a>(name, { ...params }) -> TrueForge.PutAgentResponse</code></summary>
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">delete</a>(agent_id) -> TrueForge.DeleteAgentResponse</code></summary>
<dl>
<dd>
@@ -261,7 +277,7 @@ await client.agents.delete("agent_id");
<dl>
<dd>
-Replaces the AgentSpec for an existing agent keyed by immutable `name`.
+Delete a configured agent by immutable id. Idempotent if already gone.
</dd>
</dl>
</dd>
@@ -276,11 +292,7 @@ Replaces the AgentSpec for an existing agent keyed by immutable `name`.
<dd>
```typescript
-await client.agents.update("name", {
- model: {
- name: "name"
- }
-});
+await client.agents.delete("agent_id");
```
</dd>
@@ -296,15 +308,7 @@ await client.agents.update("name", {
<dl>
<dd>
-**name:** `string` — Immutable unique agent name within the tenant.
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `TrueForge.UpdateAgentRequest`
+**agent_id:** `string` — Immutable agent identifier.
</dd>
</dl>
diff --git a/packages/sdk/src/api/resources/agents/client/Client.ts b/packages/sdk/src/api/resources/agents/client/Client.ts
index 671bb13bd..a32e178bc 100644
--- a/packages/sdk/src/api/resources/agents/client/Client.ts
+++ b/packages/sdk/src/api/resources/agents/client/Client.ts
@@ -104,7 +104,7 @@ export class AgentsClient {
/**
* Creates an agent and allocates an immutable id. Fails if `name` is already taken. Name cannot be changed later.
*
- * @param {TrueForge.AgentWriteRequest} request
+ * @param {TrueForge.CreateAgentRequest} request
* @param {AgentsClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link TrueForge.BadRequestError}
@@ -115,23 +115,25 @@ export class AgentsClient {
*
* @example
* await client.agents.create({
- * model: {
- * name: "name"
+ * manifest: {
+ * model: {
+ * name: "name"
+ * }
* },
* name: "name"
* })
*/
public create(
- request: TrueForge.AgentWriteRequest,
+ request: TrueForge.CreateAgentRequest,
requestOptions?: AgentsClient.RequestOptions,
- ): core.HttpResponsePromise<TrueForge.CreateAgentResponse> {
+ ): core.HttpResponsePromise<TrueForge.GetAgentResponse> {
return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
}
private async __create(
- request: TrueForge.AgentWriteRequest,
+ request: TrueForge.CreateAgentRequest,
requestOptions?: AgentsClient.RequestOptions,
- ): Promise<core.WithRawResponse<TrueForge.CreateAgentResponse>> {
+ ): Promise<core.WithRawResponse<TrueForge.GetAgentResponse>> {
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
@@ -150,7 +152,7 @@ export class AgentsClient {
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
requestType: "json",
body: mergeAdditionalBodyParameters(
- serializers.AgentWriteRequest.jsonOrThrow(request, {
+ serializers.CreateAgentRequest.jsonOrThrow(request, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -166,7 +168,7 @@ export class AgentsClient {
});
if (_response.ok) {
return {
- data: serializers.CreateAgentResponse.parseOrThrow(_response.body, {
+ data: serializers.GetAgentResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -308,26 +310,40 @@ export class AgentsClient {
}
/**
- * Delete a configured agent by immutable id. Idempotent if already gone.
+ * Replaces the manifest for an existing agent keyed by immutable `agent_id`.
*
* @param {string} agent_id - Immutable agent identifier.
+ * @param {TrueForge.PutAgentRequest} request
* @param {AgentsClient.RequestOptions} requestOptions - Request-specific configuration.
*
- * @throws {@link TrueForge.UnauthorizedError}
+ * @throws {@link TrueForge.BadRequestError}
+ * @throws {@link TrueForge.NotFoundError}
+ * @throws {@link TrueForge.UnprocessableEntityError}
* @throws {@link errors.TrueForgeError}
* @throws {@link errors.TrueForgeTimeoutError}
*
* @example
- * await client.agents.delete("agent_id")
+ * await client.agents.update("agent_id", {
+ * manifest: {
+ * model: {
+ * name: "name"
+ * }
+ * }
+ * })
*/
- public delete(agent_id: string, requestOptions?: AgentsClient.RequestOptions): core.HttpResponsePromise<void> {
- return core.HttpResponsePromise.fromPromise(this.__delete(agent_id, requestOptions));
+ public update(
+ agent_id: string,
+ request: TrueForge.PutAgentRequest,
+ requestOptions?: AgentsClient.RequestOptions,
+ ): core.HttpResponsePromise<TrueForge.GetAgentResponse> {
+ return core.HttpResponsePromise.fromPromise(this.__update(agent_id, request, requestOptions));
}
- private async __delete(
+ private async __update(
agent_id: string,
+ request: TrueForge.PutAgentRequest,
requestOptions?: AgentsClient.RequestOptions,
- ): Promise<core.WithRawResponse<void>> {
+ ): Promise<core.WithRawResponse<TrueForge.GetAgentResponse>> {
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
@@ -340,9 +356,20 @@ export class AgentsClient {
(await core.Supplier.get(this._options.environment)),
`api/v1/agents/${core.url.encodePathParam(agent_id)}`,
),
- method: "DELETE",
+ method: "PUT",
headers: _headers,
+ contentType: "application/json",
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+ requestType: "json",
+ body: mergeAdditionalBodyParameters(
+ serializers.PutAgentRequest.jsonOrThrow(request, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ omitUndefined: true,
+ }),
+ requestOptions?.additionalBodyParameters,
+ ),
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
abortSignal: requestOptions?.abortSignal,
@@ -350,13 +377,44 @@ export class AgentsClient {
logging: this._options.logging,
});
if (_response.ok) {
- return { data: undefined, rawResponse: _response.rawResponse };
+ return {
+ data: serializers.GetAgentResponse.parseOrThrow(_response.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ rawResponse: _response.rawResponse,
+ };
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
- case 401:
- throw new TrueForge.UnauthorizedError(
+ case 400:
+ throw new TrueForge.BadRequestError(
+ serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ _response.rawResponse,
+ );
+ case 404:
+ throw new TrueForge.NotFoundError(
+ serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
+ unrecognizedObjectKeys: "passthrough",
+ allowUnrecognizedUnionMembers: true,
+ allowUnrecognizedEnumValues: true,
+ skipValidation: true,
+ breadcrumbsPrefix: ["response"],
+ }),
+ _response.rawResponse,
+ );
+ case 422:
+ throw new TrueForge.UnprocessableEntityError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
@@ -375,42 +433,33 @@ export class AgentsClient {
}
}
- return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/api/v1/agents/{agent_id}");
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/api/v1/agents/{agent_id}");
}
/**
- * Replaces the AgentSpec for an existing agent keyed by immutable `name`.
+ * Delete a configured agent by immutable id. Idempotent if already gone.
*
- * @param {string} name - Immutable unique agent name within the tenant.
- * @param {TrueForge.UpdateAgentRequest} request
+ * @param {string} agent_id - Immutable agent identifier.
* @param {AgentsClient.RequestOptions} requestOptions - Request-specific configuration.
*
- * @throws {@link TrueForge.BadRequestError}
- * @throws {@link TrueForge.NotFoundError}
- * @throws {@link TrueForge.UnprocessableEntityError}
+ * @throws {@link TrueForge.UnauthorizedError}
* @throws {@link errors.TrueForgeError}
* @throws {@link errors.TrueForgeTimeoutError}
*
* @example
- * await client.agents.update("name", {
- * model: {
- * name: "name"
- * }
- * })
+ * await client.agents.delete("agent_id")
*/
- public update(
- name: string,
- request: TrueForge.UpdateAgentRequest,
+ public delete(
+ agent_id: string,
requestOptions?: AgentsClient.RequestOptions,
- ): core.HttpResponsePromise<TrueForge.PutAgentResponse> {
- return core.HttpResponsePromise.fromPromise(this.__update(name, request, requestOptions));
+ ): core.HttpResponsePromise<TrueForge.DeleteAgentResponse> {
+ return core.HttpResponsePromise.fromPromise(this.__delete(agent_id, requestOptions));
}
- private async __update(
- name: string,
- request: TrueForge.UpdateAgentRequest,
+ private async __delete(
+ agent_id: string,
requestOptions?: AgentsClient.RequestOptions,
- ): Promise<core.WithRawResponse<TrueForge.PutAgentResponse>> {
+ ): Promise<core.WithRawResponse<TrueForge.DeleteAgentResponse>> {
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
@@ -421,22 +470,11 @@ export class AgentsClient {
url: core.url.join(
(await core.Supplier.get(this._options.baseUrl)) ??
(await core.Supplier.get(this._options.environment)),
- `api/v1/agents/${core.url.encodePathParam(name)}`,
+ `api/v1/agents/${core.url.encodePathParam(agent_id)}`,
),
- method: "PUT",
+ method: "DELETE",
headers: _headers,
- contentType: "application/json",
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
- requestType: "json",
- body: mergeAdditionalBodyParameters(
- serializers.UpdateAgentRequest.jsonOrThrow(request, {
- unrecognizedObjectKeys: "passthrough",
- allowUnrecognizedUnionMembers: true,
- allowUnrecognizedEnumValues: true,
- omitUndefined: true,
- }),
- requestOptions?.additionalBodyParameters,
- ),
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
abortSignal: requestOptions?.abortSignal,
@@ -445,7 +483,7 @@ export class AgentsClient {
});
if (_response.ok) {
return {
- data: serializers.PutAgentResponse.parseOrThrow(_response.body, {
+ data: serializers.DeleteAgentResponse.parseOrThrow(_response.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
@@ -458,30 +496,8 @@ export class AgentsClient {
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
- case 400:
- throw new TrueForge.BadRequestError(
- serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
- unrecognizedObjectKeys: "passthrough",
- allowUnrecognizedUnionMembers: true,
- allowUnrecognizedEnumValues: true,
- skipValidation: true,
- breadcrumbsPrefix: ["response"],
- }),
- _response.rawResponse,
- );
- case 404:
- throw new TrueForge.NotFoundError(
- serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
- unrecognizedObjectKeys: "passthrough",
- allowUnrecognizedUnionMembers: true,
- allowUnrecognizedEnumValues: true,
- skipValidation: true,
- breadcrumbsPrefix: ["response"],
- }),
- _response.rawResponse,
- );
- case 422:
- throw new TrueForge.UnprocessableEntityError(
+ case 401:
+ throw new TrueForge.UnauthorizedError(
serializers.RequestErrorResponse.parseOrThrow(_response.error.body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
@@ -500,6 +516,6 @@ export class AgentsClient {
}
}
- return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/api/v1/agents/{name}");
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/api/v1/agents/{agent_id}");
}
}
diff --git a/packages/sdk/src/api/resources/agents/client/requests/AgentWriteRequest.ts b/packages/sdk/src/api/resources/agents/client/requests/CreateAgentRequest.ts
similarity index 62%
rename from packages/sdk/src/api/resources/agents/client/requests/AgentWriteRequest.ts
rename to packages/sdk/src/api/resources/agents/client/requests/CreateAgentRequest.ts
index 5e3b9d022..a7e50e73c 100644
--- a/packages/sdk/src/api/resources/agents/client/requests/AgentWriteRequest.ts
+++ b/packages/sdk/src/api/resources/agents/client/requests/CreateAgentRequest.ts
@@ -5,13 +5,16 @@ import type * as TrueForge from "../../../../index.js";
/**
* @example
* {
- * model: {
- * name: "name"
+ * manifest: {
+ * model: {
+ * name: "name"
+ * }
* },
* name: "name"
* }
*/
-export interface AgentWriteRequest extends TrueForge.AgentSpec {
+export interface CreateAgentRequest {
+ manifest: TrueForge.AgentSpec;
/** Fully qualified name. Unique within a tenant. */
name: string;
}
diff --git a/packages/sdk/src/api/resources/agents/client/requests/PutAgentRequest.ts b/packages/sdk/src/api/resources/agents/client/requests/PutAgentRequest.ts
new file mode 100644
index 000000000..d8b41efc5
--- /dev/null
+++ b/packages/sdk/src/api/resources/agents/client/requests/PutAgentRequest.ts
@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as TrueForge from "../../../../index.js";
+
+/**
+ * @example
+ * {
+ * manifest: {
+ * model: {
+ * name: "name"
+ * }
+ * }
+ * }
+ */
+export interface PutAgentRequest {
+ manifest: TrueForge.AgentSpec;
+}
diff --git a/packages/sdk/src/api/resources/agents/client/requests/UpdateAgentRequest.ts b/packages/sdk/src/api/resources/agents/client/requests/UpdateAgentRequest.ts
deleted file mode 100644
index 2e211e85e..000000000
--- a/packages/sdk/src/api/resources/agents/client/requests/UpdateAgentRequest.ts
+++ /dev/null
@@ -1,25 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-
-import type * as TrueForge from "../../../../index.js";
-
-/**
- * @example
- * {
- * model: {
- * name: "name"
- * }
- * }
- */
-export interface UpdateAgentRequest {
- config?: TrueForge.RuntimeConfig;
- /** Optional system prompt — the agent's role, behavior, and constraints. */
- instructions?: string;
- /** Optional MCP servers attached by configured name. */
- mcpServers?: TrueForge.McpServer[];
- /** Optional seed user messages injected at the start of every session. */
- messages?: TrueForge.AgentSpecUserMessage[];
- model: TrueForge.AgentSpecModel;
- responseFormat?: TrueForge.ResponseFormat;
- /** Optional name-only skill references. Requires `config.sandbox.enabled: true`. */
- skills?: TrueForge.SkillNameRef[];
-}
diff --git a/packages/sdk/src/api/resources/agents/client/requests/index.ts b/packages/sdk/src/api/resources/agents/client/requests/index.ts
index 1f894cb37..5c34051d1 100644
--- a/packages/sdk/src/api/resources/agents/client/requests/index.ts
+++ b/packages/sdk/src/api/resources/agents/client/requests/index.ts
@@ -1,2 +1,2 @@
-export type { AgentWriteRequest } from "./AgentWriteRequest.js";
-export type { UpdateAgentRequest } from "./UpdateAgentRequest.js";
+export type { CreateAgentRequest } from "./CreateAgentRequest.js";
+export type { PutAgentRequest } from "./PutAgentRequest.js";
diff --git a/packages/sdk/src/api/types/Agent.ts b/packages/sdk/src/api/types/Agent.ts
index 830c4e96c..69203f736 100644
--- a/packages/sdk/src/api/types/Agent.ts
+++ b/packages/sdk/src/api/types/Agent.ts
@@ -2,12 +2,10 @@
import type * as TrueForge from "../index.js";
-/**
- * Complete agent definition used inline on a session or saved as a named agent.
- */
-export interface Agent extends TrueForge.AgentSpec {
+export interface Agent {
/** Immutable server-generated agent identifier. */
id: string;
- /** Immutable unique agent name within the tenant. */
+ manifest: TrueForge.AgentSpec;
+ /** Fully qualified name. Unique within a tenant. */
name: string;
}
diff --git a/packages/sdk/src/api/types/CreateAgentResponse.ts b/packages/sdk/src/api/types/CreateAgentResponse.ts
deleted file mode 100644
index 726309082..000000000
--- a/packages/sdk/src/api/types/CreateAgentResponse.ts
+++ /dev/null
@@ -1,7 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-
-import type * as TrueForge from "../index.js";
-
-export interface CreateAgentResponse {
- data: TrueForge.Agent;
-}
diff --git a/packages/sdk/src/api/types/DeleteAgentResponse.ts b/packages/sdk/src/api/types/DeleteAgentResponse.ts
new file mode 100644
index 000000000..5bddc62da
--- /dev/null
+++ b/packages/sdk/src/api/types/DeleteAgentResponse.ts
@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+
+export type DeleteAgentResponse = {};
diff --git a/packages/sdk/src/api/types/PutAgentResponse.ts b/packages/sdk/src/api/types/PutAgentResponse.ts
deleted file mode 100644
index 4f7912db4..000000000
--- a/packages/sdk/src/api/types/PutAgentResponse.ts
+++ /dev/null
@@ -1,7 +0,0 @@
-// This file was auto-generated by Fern from our API Definition.
-
-import type * as TrueForge from "../index.js";
-
-export interface PutAgentResponse {
- data: TrueForge.Agent;
-}
diff --git a/packages/sdk/src/api/types/index.ts b/packages/sdk/src/api/types/index.ts
index 8ed8dffa2..1f6d1e768 100644
--- a/packages/sdk/src/api/types/index.ts
+++ b/packages/sdk/src/api/types/index.ts
@@ -31,11 +31,11 @@ export * from "./ConfiguredMcpServer.js";
export * from "./ConfiguredMcpServerAuth.js";
export * from "./ContextManagementConfig.js";
export * from "./ContextManagementConfigCompaction.js";
-export * from "./CreateAgentResponse.js";
export * from "./CreateSessionAgent.js";
export * from "./CustomModelProvider.js";
export * from "./DaytonaSandboxProvider.js";
export * from "./DaytonaSandboxProviderAuth.js";
+export * from "./DeleteAgentResponse.js";
export * from "./DynamicSubAgentsConfig.js";
export * from "./ExtendedChunkDeltaToolCall.js";
export * from "./FileContent.js";
@@ -110,7 +110,6 @@ export * from "./ModelProviderAuth.js";
export * from "./MoonshotModelProvider.js";
export * from "./OpenAiModelProvider.js";
export * from "./PreviousTurnIdInput.js";
-export * from "./PutAgentResponse.js";
export * from "./PutMcpServerResponse.js";
export * from "./PutModelProviderResponse.js";
export * from "./PutSandboxProviderResponse.js";
diff --git a/packages/sdk/src/serialization/resources/agents/client/requests/AgentWriteRequest.ts b/packages/sdk/src/serialization/resources/agents/client/requests/AgentWriteRequest.ts
deleted file mode 100644
index 8e58d0e05..000000000
--- a/packages/sdk/src/serialization/resources/agents/client/requests/AgentWriteRequest.ts
+++ /dev/null
@@ -1,21 +0,0 @@
-// 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 { AgentSpec } from "../../../../types/AgentSpec.js";
-
-export const AgentWriteRequest: core.serialization.Schema<
- serializers.AgentWriteRequest.Raw,
- TrueForge.AgentWriteRequest
-> = core.serialization
- .object({
- name: core.serialization.string(),
- })
- .extend(AgentSpec);
-
-export declare namespace AgentWriteRequest {
- export interface Raw extends AgentSpec.Raw {
- name: string;
- }
-}
diff --git a/packages/sdk/src/serialization/resources/agents/client/requests/CreateAgentRequest.ts b/packages/sdk/src/serialization/resources/agents/client/requests/CreateAgentRequest.ts
new file mode 100644
index 000000000..1c20ff65d
--- /dev/null
+++ b/packages/sdk/src/serialization/resources/agents/client/requests/CreateAgentRequest.ts
@@ -0,0 +1,21 @@
+// 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 { AgentSpec } from "../../../../types/AgentSpec.js";
+
+export const CreateAgentRequest: core.serialization.Schema<
+ serializers.CreateAgentRequest.Raw,
+ TrueForge.CreateAgentRequest
+> = core.serialization.object({
+ manifest: AgentSpec,
+ name: core.serialization.string(),
+});
+
+export declare namespace CreateAgentRequest {
+ export interface Raw {
+ manifest: AgentSpec.Raw;
+ name: string;
+ }
+}
diff --git a/packages/sdk/src/serialization/resources/agents/client/requests/PutAgentRequest.ts b/packages/sdk/src/serialization/resources/agents/client/requests/PutAgentRequest.ts
new file mode 100644
index 000000000..4c3f44ff1
--- /dev/null
+++ b/packages/sdk/src/serialization/resources/agents/client/requests/PutAgentRequest.ts
@@ -0,0 +1,17 @@
+// 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 { AgentSpec } from "../../../../types/AgentSpec.js";
+
+export const PutAgentRequest: core.serialization.Schema<serializers.PutAgentRequest.Raw, TrueForge.PutAgentRequest> =
+ core.serialization.object({
+ manifest: AgentSpec,
+ });
+
+export declare namespace PutAgentRequest {
+ export interface Raw {
+ manifest: AgentSpec.Raw;
+ }
+}
diff --git a/packages/sdk/src/serialization/resources/agents/client/requests/UpdateAgentRequest.ts b/packages/sdk/src/serialization/resources/agents/client/requests/UpdateAgentRequest.ts
deleted file mode 100644
index f99132ad1..000000000
--- a/packages/sdk/src/serialization/resources/agents/client/requests/UpdateAgentRequest.ts
+++ /dev/null
@@ -1,36 +0,0 @@
-// 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 { AgentSpecModel } from "../../../../types/AgentSpecModel.js";
-import { AgentSpecUserMessage } from "../../../../types/AgentSpecUserMessage.js";
-import { McpServer } from "../../../../types/McpServer.js";
-import { ResponseFormat } from "../../../../types/ResponseFormat.js";
-import { RuntimeConfig } from "../../../../types/RuntimeConfig.js";
-import { SkillNameRef } from "../../../../types/SkillNameRef.js";
-
-export const UpdateAgentRequest: core.serialization.Schema<
- serializers.UpdateAgentRequest.Raw,
- TrueForge.UpdateAgentRequest
-> = core.serialization.object({
- config: RuntimeConfig.optional(),
- instructions: core.serialization.string().optional(),
- mcpServers: core.serialization.property("mcp_servers", core.serialization.list(McpServer).optional()),
- messages: core.serialization.list(AgentSpecUserMessage).optional(),
- model: AgentSpecModel,
- responseFormat: core.serialization.property("response_format", ResponseFormat.optional()),
- skills: core.serialization.list(SkillNameRef).optional(),
-});
-
-export declare namespace UpdateAgentRequest {
- export interface Raw {
- config?: RuntimeConfig.Raw | null;
- instructions?: string | null;
- mcp_servers?: McpServer.Raw[] | null;
- messages?: AgentSpecUserMessage.Raw[] | null;
- model: AgentSpecModel.Raw;
- response_format?: ResponseFormat.Raw | null;
- skills?: SkillNameRef.Raw[] | null;
- }
-}
diff --git a/packages/sdk/src/serialization/resources/agents/client/requests/index.ts b/packages/sdk/src/serialization/resources/agents/client/requests/index.ts
index 548a9fc6f..a656b83ed 100644
--- a/packages/sdk/src/serialization/resources/agents/client/requests/index.ts
+++ b/packages/sdk/src/serialization/resources/agents/client/requests/index.ts
@@ -1,2 +1,2 @@
-export { AgentWriteRequest } from "./AgentWriteRequest.js";
-export { UpdateAgentRequest } from "./UpdateAgentRequest.js";
+export { CreateAgentRequest } from "./CreateAgentRequest.js";
+export { PutAgentRequest } from "./PutAgentRequest.js";
diff --git a/packages/sdk/src/serialization/types/Agent.ts b/packages/sdk/src/serialization/types/Agent.ts
index 52f8cc7e8..2eba62666 100644
--- a/packages/sdk/src/serialization/types/Agent.ts
+++ b/packages/sdk/src/serialization/types/Agent.ts
@@ -5,16 +5,18 @@ import * as core from "../../core/index.js";
import type * as serializers from "../index.js";
import { AgentSpec } from "./AgentSpec.js";
-export const Agent: core.serialization.ObjectSchema<serializers.Agent.Raw, TrueForge.Agent> = core.serialization
- .object({
+export const Agent: core.serialization.ObjectSchema<serializers.Agent.Raw, TrueForge.Agent> = core.serialization.object(
+ {
id: core.serialization.string(),
+ manifest: AgentSpec,
name: core.serialization.string(),
- })
- .extend(AgentSpec);
+ },
+);
export declare namespace Agent {
- export interface Raw extends AgentSpec.Raw {
+ export interface Raw {
id: string;
+ manifest: AgentSpec.Raw;
name: string;
}
}
diff --git a/packages/sdk/src/serialization/types/CreateAgentResponse.ts b/packages/sdk/src/serialization/types/CreateAgentResponse.ts
deleted file mode 100644
index 633d4cb5b..000000000
--- a/packages/sdk/src/serialization/types/CreateAgentResponse.ts
+++ /dev/null
@@ -1,19 +0,0 @@
-// 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 { Agent } from "./Agent.js";
-
-export const CreateAgentResponse: core.serialization.ObjectSchema<
- serializers.CreateAgentResponse.Raw,
- TrueForge.CreateAgentResponse
-> = core.serialization.object({
- data: Agent,
-});
-
-export declare namespace CreateAgentResponse {
- export interface Raw {
- data: Agent.Raw;
- }
-}
diff --git a/packages/sdk/src/serialization/types/DeleteAgentResponse.ts b/packages/sdk/src/serialization/types/DeleteAgentResponse.ts
new file mode 100644
index 000000000..df9a35239
--- /dev/null
+++ b/packages/sdk/src/serialization/types/DeleteAgentResponse.ts
@@ -0,0 +1,14 @@
+// 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";
+
+export const DeleteAgentResponse: core.serialization.ObjectSchema<
+ serializers.DeleteAgentResponse.Raw,
+ TrueForge.DeleteAgentResponse
+> = core.serialization.object({});
+
+export declare namespace DeleteAgentResponse {
+ export type Raw = {};
+}
diff --git a/packages/sdk/src/serialization/types/PutAgentResponse.ts b/packages/sdk/src/serialization/types/PutAgentResponse.ts
deleted file mode 100644
index 4465fc9b6..000000000
--- a/packages/sdk/src/serialization/types/PutAgentResponse.ts
+++ /dev/null
@@ -1,19 +0,0 @@
-// 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 { Agent } from "./Agent.js";
-
-export const PutAgentResponse: core.serialization.ObjectSchema<
- serializers.PutAgentResponse.Raw,
- TrueForge.PutAgentResponse
-> = core.serialization.object({
- data: Agent,
-});
-
-export declare namespace PutAgentResponse {
- export interface Raw {
- data: Agent.Raw;
- }
-}
diff --git a/packages/sdk/src/serialization/types/index.ts b/packages/sdk/src/serialization/types/index.ts
index 8ed8dffa2..1f6d1e768 100644
--- a/packages/sdk/src/serialization/types/index.ts
+++ b/packages/sdk/src/serialization/types/index.ts
@@ -31,11 +31,11 @@ export * from "./ConfiguredMcpServer.js";
export * from "./ConfiguredMcpServerAuth.js";
export * from "./ContextManagementConfig.js";
export * from "./ContextManagementConfigCompaction.js";
-export * from "./CreateAgentResponse.js";
export * from "./CreateSessionAgent.js";
export * from "./CustomModelProvider.js";
export * from "./DaytonaSandboxProvider.js";
export * from "./DaytonaSandboxProviderAuth.js";
+export * from "./DeleteAgentResponse.js";
export * from "./DynamicSubAgentsConfig.js";
export * from "./ExtendedChunkDeltaToolCall.js";
export * from "./FileContent.js";
@@ -110,7 +110,6 @@ export * from "./ModelProviderAuth.js";
export * from "./MoonshotModelProvider.js";
export * from "./OpenAiModelProvider.js";
export * from "./PreviousTurnIdInput.js";
-export * from "./PutAgentResponse.js";
export * from "./PutMcpServerResponse.js";
export * from "./PutModelProviderResponse.js";
export * from "./PutSandboxProviderResponse.js";
diff --git a/packages/sdk/tests/wire/agents.test.ts b/packages/sdk/tests/wire/agents.test.ts
index 244c0bf2e..23b40e671 100644
--- a/packages/sdk/tests/wire/agents.test.ts
+++ b/packages/sdk/tests/wire/agents.test.ts
@@ -9,20 +9,7 @@ describe("AgentsClient", () => {
const server = mockServerPool.createServer();
const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
- const rawResponseBody = {
- data: [
- {
- instructions: "instructions",
- mcp_servers: [{ name: "name" }],
- messages: [{ content: "content", type: "user.message" }],
- model: { name: "name" },
- response_format: { type: "json_object" },
- skills: [{ name: "name" }],
- id: "id",
- name: "name",
- },
- ],
- };
+ const rawResponseBody = { data: [{ id: "id", manifest: { model: { name: "name" } }, name: "name" }] };
server.mockEndpoint().get("/api/v1/agents").respondWith().statusCode(200).jsonBody(rawResponseBody).build();
@@ -30,30 +17,12 @@ describe("AgentsClient", () => {
expect(response).toEqual({
data: [
{
- instructions: "instructions",
- mcpServers: [
- {
+ id: "id",
+ manifest: {
+ model: {
name: "name",
},
- ],
- messages: [
- {
- content: "content",
- type: "user.message",
- },
- ],
- model: {
- name: "name",
- },
- responseFormat: {
- type: "json_object",
},
- skills: [
- {
- name: "name",
- },
- ],
- id: "id",
name: "name",
},
],
@@ -76,17 +45,18 @@ describe("AgentsClient", () => {
test("create (1)", async () => {
const server = mockServerPool.createServer();
const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
- const rawRequestBody = { model: { name: "name" }, name: "name" };
+ const rawRequestBody = { manifest: { model: { name: "name" } }, name: "name" };
const rawResponseBody = {
data: {
- config: { iteration_limit: 1, sandbox: { enabled: true } },
- instructions: "instructions",
- mcp_servers: [{ name: "name" }],
- messages: [{ content: "content", type: "user.message" }],
- model: { name: "name" },
- response_format: { type: "json_object" },
- skills: [{ name: "name" }],
id: "id",
+ manifest: {
+ instructions: "instructions",
+ mcp_servers: [{ name: "name" }],
+ messages: [{ content: "content", type: "user.message" }],
+ model: { name: "name" },
+ response_format: { type: "json_object" },
+ skills: [{ name: "name" }],
+ },
name: "name",
},
};
@@ -101,43 +71,41 @@ describe("AgentsClient", () => {
.build();
const response = await client.agents.create({
- model: {
- name: "name",
+ manifest: {
+ model: {
+ name: "name",
+ },
},
name: "name",
});
expect(response).toEqual({
data: {
- config: {
- iterationLimit: 1,
- sandbox: {
- enabled: true,
- },
- },
- instructions: "instructions",
- mcpServers: [
- {
+ id: "id",
+ manifest: {
+ instructions: "instructions",
+ mcpServers: [
+ {
+ name: "name",
+ },
+ ],
+ messages: [
+ {
+ content: "content",
+ type: "user.message",
+ },
+ ],
+ model: {
name: "name",
},
- ],
- messages: [
- {
- content: "content",
- type: "user.message",
+ responseFormat: {
+ type: "json_object",
},
- ],
- model: {
- name: "name",
- },
- responseFormat: {
- type: "json_object",
+ skills: [
+ {
+ name: "name",
+ },
+ ],
},
- skills: [
- {
- name: "name",
- },
- ],
- id: "id",
name: "name",
},
});
@@ -146,7 +114,7 @@ describe("AgentsClient", () => {
test("create (2)", async () => {
const server = mockServerPool.createServer();
const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
- const rawRequestBody = { name: "xy", model: { name: "x" } };
+ const rawRequestBody = { manifest: { model: { name: "x" } }, name: "xy" };
const rawResponseBody = { error: { message: "message" } };
server
@@ -160,10 +128,12 @@ describe("AgentsClient", () => {
await expect(async () => {
return await client.agents.create({
- name: "xy",
- model: {
- name: "x",
+ manifest: {
+ model: {
+ name: "x",
+ },
},
+ name: "xy",
});
}).rejects.toThrow(TrueForgeTypes.BadRequestError);
});
@@ -171,7 +141,7 @@ describe("AgentsClient", () => {
test("create (3)", async () => {
const server = mockServerPool.createServer();
const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
- const rawRequestBody = { name: "xy", model: { name: "x" } };
+ const rawRequestBody = { manifest: { model: { name: "x" } }, name: "xy" };
const rawResponseBody = { error: { message: "message" } };
server
@@ -185,10 +155,12 @@ describe("AgentsClient", () => {
await expect(async () => {
return await client.agents.create({
- name: "xy",
- model: {
- name: "x",
+ manifest: {
+ model: {
+ name: "x",
+ },
},
+ name: "xy",
});
}).rejects.toThrow(TrueForgeTypes.ConflictError);
});
@@ -196,7 +168,7 @@ describe("AgentsClient", () => {
test("create (4)", async () => {
const server = mockServerPool.createServer();
const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
- const rawRequestBody = { name: "xy", model: { name: "x" } };
+ const rawRequestBody = { manifest: { model: { name: "x" } }, name: "xy" };
const rawResponseBody = { error: { message: "message" } };
server
@@ -210,10 +182,12 @@ describe("AgentsClient", () => {
await expect(async () => {
return await client.agents.create({
- name: "xy",
- model: {
- name: "x",
+ manifest: {
+ model: {
+ name: "x",
+ },
},
+ name: "xy",
});
}).rejects.toThrow(TrueForgeTypes.UnprocessableEntityError);
});
@@ -224,14 +198,15 @@ describe("AgentsClient", () => {
const rawResponseBody = {
data: {
- config: { iteration_limit: 1, sandbox: { enabled: true } },
- instructions: "instructions",
- mcp_servers: [{ name: "name" }],
- messages: [{ content: "content", type: "user.message" }],
- model: { name: "name" },
- response_format: { type: "json_object" },
- skills: [{ name: "name" }],
id: "id",
+ manifest: {
+ instructions: "instructions",
+ mcp_servers: [{ name: "name" }],
+ messages: [{ content: "content", type: "user.message" }],
+ model: { name: "name" },
+ response_format: { type: "json_object" },
+ skills: [{ name: "name" }],
+ },
name: "name",
},
};
@@ -247,36 +222,32 @@ describe("AgentsClient", () => {
const response = await client.agents.get("agent_id");
expect(response).toEqual({
data: {
- config: {
- iterationLimit: 1,
- sandbox: {
- enabled: true,
- },
- },
- instructions: "instructions",
- mcpServers: [
- {
+ id: "id",
+ manifest: {
+ instructions: "instructions",
+ mcpServers: [
+ {
+ name: "name",
+ },
+ ],
+ messages: [
+ {
+ content: "content",
+ type: "user.message",
+ },
+ ],
+ model: {
name: "name",
},
- ],
- messages: [
- {
- content: "content",
- type: "user.message",
+ responseFormat: {
+ type: "json_object",
},
- ],
- model: {
- name: "name",
- },
- responseFormat: {
- type: "json_object",
+ skills: [
+ {
+ name: "name",
+ },
+ ],
},
- skills: [
- {
- name: "name",
- },
- ],
- id: "id",
name: "name",
},
});
@@ -301,99 +272,69 @@ describe("AgentsClient", () => {
}).rejects.toThrow(TrueForgeTypes.NotFoundError);
});
- test("delete (1)", async () => {
- const server = mockServerPool.createServer();
- const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
-
- server.mockEndpoint().delete("/api/v1/agents/agent_id").respondWith().statusCode(200).build();
-
- const response = await client.agents.delete("agent_id");
- expect(response).toEqual(undefined);
- });
-
- test("delete (2)", async () => {
- const server = mockServerPool.createServer();
- const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
-
- const rawResponseBody = { error: { message: "message" } };
-
- server
- .mockEndpoint()
- .delete("/api/v1/agents/agent_id")
- .respondWith()
- .statusCode(401)
- .jsonBody(rawResponseBody)
- .build();
-
- await expect(async () => {
- return await client.agents.delete("agent_id");
- }).rejects.toThrow(TrueForgeTypes.UnauthorizedError);
- });
-
test("update (1)", async () => {
const server = mockServerPool.createServer();
const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
- const rawRequestBody = { model: { name: "name" } };
+ const rawRequestBody = { manifest: { model: { name: "name" } } };
const rawResponseBody = {
data: {
- config: { iteration_limit: 1, sandbox: { enabled: true } },
- instructions: "instructions",
- mcp_servers: [{ name: "name" }],
- messages: [{ content: "content", type: "user.message" }],
- model: { name: "name" },
- response_format: { type: "json_object" },
- skills: [{ name: "name" }],
id: "id",
+ manifest: {
+ instructions: "instructions",
+ mcp_servers: [{ name: "name" }],
+ messages: [{ content: "content", type: "user.message" }],
+ model: { name: "name" },
+ response_format: { type: "json_object" },
+ skills: [{ name: "name" }],
+ },
name: "name",
},
};
server
.mockEndpoint()
- .put("/api/v1/agents/name")
+ .put("/api/v1/agents/agent_id")
.jsonBody(rawRequestBody)
.respondWith()
.statusCode(200)
.jsonBody(rawResponseBody)
.build();
- const response = await client.agents.update("name", {
- model: {
- name: "name",
+ const response = await client.agents.update("agent_id", {
+ manifest: {
+ model: {
+ name: "name",
+ },
},
});
expect(response).toEqual({
data: {
- config: {
- iterationLimit: 1,
- sandbox: {
- enabled: true,
- },
- },
- instructions: "instructions",
- mcpServers: [
- {
+ id: "id",
+ manifest: {
+ instructions: "instructions",
+ mcpServers: [
+ {
+ name: "name",
+ },
+ ],
+ messages: [
+ {
+ content: "content",
+ type: "user.message",
+ },
+ ],
+ model: {
name: "name",
},
- ],
- messages: [
- {
- content: "content",
- type: "user.message",
+ responseFormat: {
+ type: "json_object",
},
- ],
- model: {
- name: "name",
- },
- responseFormat: {
- type: "json_object",
+ skills: [
+ {
+ name: "name",
+ },
+ ],
},
- skills: [
- {
- name: "name",
- },
- ],
- id: "id",
name: "name",
},
});
@@ -402,12 +343,12 @@ describe("AgentsClient", () => {
test("update (2)", async () => {
const server = mockServerPool.createServer();
const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
- const rawRequestBody = { model: { name: "x" } };
+ const rawRequestBody = { manifest: { model: { name: "x" } } };
const rawResponseBody = { error: { message: "message" } };
server
.mockEndpoint()
- .put("/api/v1/agents/name")
+ .put("/api/v1/agents/agent_id")
.jsonBody(rawRequestBody)
.respondWith()
.statusCode(400)
@@ -415,9 +356,11 @@ describe("AgentsClient", () => {
.build();
await expect(async () => {
- return await client.agents.update("name", {
- model: {
- name: "x",
+ return await client.agents.update("agent_id", {
+ manifest: {
+ model: {
+ name: "x",
+ },
},
});
}).rejects.toThrow(TrueForgeTypes.BadRequestError);
@@ -426,12 +369,12 @@ describe("AgentsClient", () => {
test("update (3)", async () => {
const server = mockServerPool.createServer();
const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
- const rawRequestBody = { model: { name: "x" } };
+ const rawRequestBody = { manifest: { model: { name: "x" } } };
const rawResponseBody = { error: { message: "message" } };
server
.mockEndpoint()
- .put("/api/v1/agents/name")
+ .put("/api/v1/agents/agent_id")
.jsonBody(rawRequestBody)
.respondWith()
.statusCode(404)
@@ -439,9 +382,11 @@ describe("AgentsClient", () => {
.build();
await expect(async () => {
- return await client.agents.update("name", {
- model: {
- name: "x",
+ return await client.agents.update("agent_id", {
+ manifest: {
+ model: {
+ name: "x",
+ },
},
});
}).rejects.toThrow(TrueForgeTypes.NotFoundError);
@@ -450,12 +395,12 @@ describe("AgentsClient", () => {
test("update (4)", async () => {
const server = mockServerPool.createServer();
const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
- const rawRequestBody = { model: { name: "x" } };
+ const rawRequestBody = { manifest: { model: { name: "x" } } };
const rawResponseBody = { error: { message: "message" } };
server
.mockEndpoint()
- .put("/api/v1/agents/name")
+ .put("/api/v1/agents/agent_id")
.jsonBody(rawRequestBody)
.respondWith()
.statusCode(422)
@@ -463,11 +408,50 @@ describe("AgentsClient", () => {
.build();
await expect(async () => {
- return await client.agents.update("name", {
- model: {
- name: "x",
+ return await client.agents.update("agent_id", {
+ manifest: {
+ model: {
+ name: "x",
+ },
},
});
}).rejects.toThrow(TrueForgeTypes.UnprocessableEntityError);
});
+
+ test("delete (1)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
+
+ const rawResponseBody = {};
+
+ server
+ .mockEndpoint()
+ .delete("/api/v1/agents/agent_id")
+ .respondWith()
+ .statusCode(200)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ const response = await client.agents.delete("agent_id");
+ expect(response).toEqual({});
+ });
+
+ test("delete (2)", async () => {
+ const server = mockServerPool.createServer();
+ const client = new TrueForge({ maxRetries: 0, token: "test", baseUrl: server.baseUrl });
+
+ const rawResponseBody = { error: { message: "message" } };
+
+ server
+ .mockEndpoint()
+ .delete("/api/v1/agents/agent_id")
+ .respondWith()
+ .statusCode(401)
+ .jsonBody(rawResponseBody)
+ .build();
+
+ await expect(async () => {
+ return await client.agents.delete("agent_id");
+ }).rejects.toThrow(TrueForgeTypes.UnauthorizedError);
+ });
});
diff --git a/packages/server/src/apis/agents.ts b/packages/server/src/apis/agents.ts
index 2e9957441..90255201e 100644
--- a/packages/server/src/apis/agents.ts
+++ b/packages/server/src/apis/agents.ts
@@ -17,7 +17,7 @@ import {
putAgentRoute,
} from '../routes/agentRoutes';
import { validateAgentSpec } from '../runtime/sessionResources';
-import { toAgentManifest, type Agent, type AgentWriteRequest } from '../schemas/agent';
+import { type Agent, type CreateAgentRequest } from '../schemas/agent';
import { TENANT_ID } from './sessions';
export interface AgentsRouterDeps<TTransaction> {
@@ -29,12 +29,12 @@ export interface AgentsRouterDeps<TTransaction> {
withTransaction: WithTransaction<TTransaction>;
}
-/** Wire view: identity columns plus AgentSpec fields flattened. */
+/** Wire view: identity columns plus nested manifest. */
function toWireAgent(record: AgentRecord): Agent {
return {
id: record.id,
name: record.name,
- ...record.manifest,
+ manifest: record.manifest,
};
}
@@ -63,15 +63,15 @@ export function createAgentsRouter<TTransaction>(deps: AgentsRouterDeps<TTransac
};
const createHandler: RouteHandler<typeof createAgentRoute> = async c => {
- const body: AgentWriteRequest = c.req.valid('json');
- const manifest = await validateManifest({ spec: toAgentManifest(body), deps });
+ const body: CreateAgentRequest = c.req.valid('json');
+ const manifest = await validateManifest({ spec: body.manifest, deps });
try {
const record = await deps.agentStore.createAgent({
tenant_id: TENANT_ID,
name: body.name,
manifest,
});
- return c.json({ data: toWireAgent(record) }, 200);
+ return c.json({ data: toWireAgent(record) }, 201);
} catch (error) {
if (error instanceof AgentNameConflictError) {
return c.json({ error: { message: error.message } }, 409);
@@ -92,20 +92,20 @@ export function createAgentsRouter<TTransaction>(deps: AgentsRouterDeps<TTransac
const deleteHandler: RouteHandler<typeof deleteAgentRoute> = async c => {
const { agent_id: agentId } = c.req.valid('param');
await deps.agentStore.deleteAgent({ tenant_id: TENANT_ID, id: agentId });
- return c.body(null, 204);
+ return c.json({}, 200);
};
const putHandler: RouteHandler<typeof putAgentRoute> = async c => {
- const { name } = c.req.valid('param');
+ const { agent_id: agentId } = c.req.valid('param');
const body = c.req.valid('json');
- const manifest = await validateManifest({ spec: body, deps });
+ const manifest = await validateManifest({ spec: body.manifest, deps });
const record = await deps.agentStore.updateAgent({
tenant_id: TENANT_ID,
- name,
+ id: agentId,
manifest,
});
if (record === undefined) {
- return c.json({ error: { message: `Agent not found: ${name}` } }, 404);
+ return c.json({ error: { message: `Agent not found: ${agentId}` } }, 404);
}
return c.json({ data: toWireAgent(record) }, 200);
};
diff --git a/packages/server/src/db/agentStore.ts b/packages/server/src/db/agentStore.ts
index 13ac9b803..e30863dcc 100644
--- a/packages/server/src/db/agentStore.ts
+++ b/packages/server/src/db/agentStore.ts
@@ -35,10 +35,10 @@ export interface CreateAgentInput {
manifest: AgentSpec;
}
-/** Replace manifest for an existing agent keyed by immutable name. */
+/** Replace manifest for an existing agent keyed by immutable id. */
export interface UpdateAgentInput {
tenant_id: string;
- name: ResourceName;
+ id: string;
manifest: AgentSpec;
}
@@ -65,7 +65,7 @@ export interface IAgentStore<TTransaction = never> {
getAgent(input: GetAgentInput, transaction?: TTransaction): Promise<AgentRecord | undefined>;
/** Inserts a new agent with a generated ULID. Throws AgentNameConflictError on name clash. */
createAgent(input: CreateAgentInput, transaction?: TTransaction): Promise<AgentRecord>;
- /** Replaces `manifest` for an existing name. Returns undefined if missing. */
+ /** Replaces `manifest` for an existing id. Returns undefined if missing. */
updateAgent(input: UpdateAgentInput, transaction?: TTransaction): Promise<AgentRecord | undefined>;
/** Deletes by immutable id. Idempotent if already missing. */
deleteAgent(input: DeleteAgentInput, transaction?: TTransaction): Promise<void>;
diff --git a/packages/server/src/db/postgres/agent-store/PostgresAgentStore.ts b/packages/server/src/db/postgres/agent-store/PostgresAgentStore.ts
index 1542f3d45..5630e4342 100644
--- a/packages/server/src/db/postgres/agent-store/PostgresAgentStore.ts
+++ b/packages/server/src/db/postgres/agent-store/PostgresAgentStore.ts
@@ -83,7 +83,7 @@ export class PostgresAgentStore implements IAgentStore<Transaction<Database>> {
updated_at: now(),
})
.where('tenant_id', '=', input.tenant_id)
- .where('name', '=', input.name)
+ .where('id', '=', input.id)
.returningAll()
.executeTakeFirst();
return row === undefined ? undefined : toRecord(row);
diff --git a/packages/server/src/db/sqlite/agent-store/SqliteAgentStore.ts b/packages/server/src/db/sqlite/agent-store/SqliteAgentStore.ts
index 2c18ab67a..f4653c6e4 100644
--- a/packages/server/src/db/sqlite/agent-store/SqliteAgentStore.ts
+++ b/packages/server/src/db/sqlite/agent-store/SqliteAgentStore.ts
@@ -102,7 +102,7 @@ export class SqliteAgentStore implements IAgentStore<Transaction<Database>> {
updated_at: nowIso(),
})
.where('tenant_id', '=', input.tenant_id)
- .where('name', '=', input.name)
+ .where('id', '=', input.id)
.returning(recordColumns)
.executeTakeFirst();
return row === undefined ? undefined : toRecord(row);
diff --git a/packages/server/src/routes/agentRoutes.ts b/packages/server/src/routes/agentRoutes.ts
index e71e521ee..fea097bc7 100644
--- a/packages/server/src/routes/agentRoutes.ts
+++ b/packages/server/src/routes/agentRoutes.ts
@@ -4,14 +4,12 @@
*/
import { createRoute, z } from '@hono/zod-openapi';
import {
- AgentWriteRequestSchema,
- CreateAgentResponseSchema,
+ CreateAgentRequestSchema,
+ DeleteAgentResponseSchema,
GetAgentResponseSchema,
ListAgentsResponseSchema,
- PutAgentResponseSchema,
- UpdateAgentRequestSchema,
+ PutAgentRequestSchema,
} from '../schemas/agent';
-import { NameSchema } from '../schemas/common';
import { RequestErrorResponseSchema } from '../schemas/errors';
const AGENTS_TAG = 'Agents';
@@ -20,10 +18,6 @@ export const AgentIdParamsSchema = z.object({
agent_id: z.string().min(1).max(64).describe('Immutable agent identifier.'),
});
-export const AgentNameParamsSchema = z.object({
- name: NameSchema.describe('Immutable unique agent name within the tenant.'),
-});
-
export const listAgentsRoute = createRoute({
method: 'get',
path: '/',
@@ -55,13 +49,13 @@ export const createAgentRoute = createRoute({
'x-fern-sdk-method-name': 'create',
request: {
body: {
- content: { 'application/json': { schema: AgentWriteRequestSchema } },
+ content: { 'application/json': { schema: CreateAgentRequestSchema } },
required: true,
},
},
responses: {
- 200: {
- content: { 'application/json': { schema: CreateAgentResponseSchema } },
+ 201: {
+ content: { 'application/json': { schema: GetAgentResponseSchema } },
description: 'The created agent.',
},
400: {
@@ -115,7 +109,8 @@ export const deleteAgentRoute = createRoute({
params: AgentIdParamsSchema,
},
responses: {
- 204: {
+ 200: {
+ content: { 'application/json': { schema: DeleteAgentResponseSchema } },
description: 'Agent deleted.',
},
401: {
@@ -127,22 +122,22 @@ export const deleteAgentRoute = createRoute({
export const putAgentRoute = createRoute({
method: 'put',
- path: '/{name}',
+ path: '/{agent_id}',
tags: [AGENTS_TAG],
summary: 'Update an agent',
- description: 'Replaces the AgentSpec for an existing agent keyed by immutable `name`.',
+ description: 'Replaces the manifest for an existing agent keyed by immutable `agent_id`.',
'x-fern-sdk-group-name': ['agents'],
'x-fern-sdk-method-name': 'update',
request: {
- params: AgentNameParamsSchema,
+ params: AgentIdParamsSchema,
body: {
- content: { 'application/json': { schema: UpdateAgentRequestSchema } },
+ content: { 'application/json': { schema: PutAgentRequestSchema } },
required: true,
},
},
responses: {
200: {
- content: { 'application/json': { schema: PutAgentResponseSchema } },
+ content: { 'application/json': { schema: GetAgentResponseSchema } },
description: 'The saved agent.',
},
400: {
diff --git a/packages/server/src/schemas/agent.ts b/packages/server/src/schemas/agent.ts
index 39137a595..d02366630 100644
--- a/packages/server/src/schemas/agent.ts
+++ b/packages/server/src/schemas/agent.ts
@@ -1,38 +1,42 @@
/**
- * Configured agent domain + wire schemas: identity columns plus an AgentSpec
- * manifest document. AgentSpec remains owned by harness; this module only adds
- * registry identity (`id`, `name`).
+ * Configured agent domain + wire schemas: identity columns plus a nested
+ * AgentSpec document (JSON key `manifest`).
*/
import { z } from '@hono/zod-openapi';
-import { AgentSpecSchema, type AgentSpec } from '@truefoundry/trueforge-core/agent-session';
+import { AgentSpecSchema } from '@truefoundry/trueforge-core/agent-session';
import { NameSchema } from './common';
-/** Create body: unique immutable `name` plus full AgentSpec. `id` is never client-supplied. */
-export const AgentWriteRequestSchema = AgentSpecSchema.extend({
- name: NameSchema,
-}).openapi('AgentWriteRequest');
+/** Create body: unique immutable `name` plus manifest. `id` is never client-supplied. */
+export const CreateAgentRequestSchema = z
+ .object({
+ name: NameSchema,
+ manifest: AgentSpecSchema,
+ })
+ .strict()
+ .openapi('CreateAgentRequest');
-/** Update body: full AgentSpec replacement. Name is the path key and is immutable. */
-export const UpdateAgentRequestSchema = AgentSpecSchema.openapi('UpdateAgentRequest');
+/** PUT body: full manifest replacement. Identity is the path `agent_id`. */
+export const PutAgentRequestSchema = z
+ .object({
+ manifest: AgentSpecSchema,
+ })
+ .strict()
+ .openapi('PutAgentRequest');
-/** List/get/create/update response item: immutable `id`, unique immutable `name`, and AgentSpec fields. */
-export const AgentSchema = AgentSpecSchema.extend({
- id: z.string().min(1).describe('Immutable server-generated agent identifier.'),
- name: NameSchema.describe('Immutable unique agent name within the tenant.'),
-}).openapi('Agent');
+/** List/get/create/update response item: identity columns plus nested manifest. */
+export const AgentSchema = z
+ .object({
+ id: z.string().min(1).describe('Immutable server-generated agent identifier.'),
+ name: NameSchema,
+ manifest: AgentSpecSchema,
+ })
+ .strict()
+ .openapi('Agent');
-export const CreateAgentResponseSchema = z.object({ data: AgentSchema }).openapi('CreateAgentResponse');
-export const PutAgentResponseSchema = z.object({ data: AgentSchema }).openapi('PutAgentResponse');
-export const ListAgentsResponseSchema = z.object({ data: z.array(AgentSchema) }).openapi('ListAgentsResponse');
export const GetAgentResponseSchema = z.object({ data: AgentSchema }).openapi('GetAgentResponse');
+export const ListAgentsResponseSchema = z.object({ data: z.array(AgentSchema) }).openapi('ListAgentsResponse');
+export const DeleteAgentResponseSchema = z.object({}).openapi('DeleteAgentResponse');
-export type AgentWriteRequest = z.infer<typeof AgentWriteRequestSchema>;
-export type UpdateAgentRequest = z.infer<typeof UpdateAgentRequestSchema>;
+export type CreateAgentRequest = z.infer<typeof CreateAgentRequestSchema>;
+export type PutAgentRequest = z.infer<typeof PutAgentRequestSchema>;
export type Agent = z.infer<typeof AgentSchema>;
-
-/** Strip registry identity; remaining fields are the persisted AgentSpec document. */
-export function toAgentManifest(request: AgentWriteRequest): AgentSpec {
- const { name, ...manifest } = request;
- void name;
- return manifest;
-}
diff --git a/packages/server/tests/db/agentStoreContractSuite.ts b/packages/server/tests/db/agentStoreContractSuite.ts
index 9baceea7c..69093fab0 100644
--- a/packages/server/tests/db/agentStoreContractSuite.ts
+++ b/packages/server/tests/db/agentStoreContractSuite.ts
@@ -46,7 +46,7 @@ export function runAgentStoreContractSuite(getStore: () => IAgentStore): void {
expect(await store.getAgent({ tenant_id: TENANT, name: 'missing' })).toBeUndefined();
});
- it('updateAgent by name replaces manifest but keeps id, name, and created_at', async () => {
+ it('updateAgent by id replaces manifest but keeps id, name, and created_at', async () => {
const store = getStore();
const created = await store.createAgent({
tenant_id: TENANT,
@@ -57,7 +57,7 @@ export function runAgentStoreContractSuite(getStore: () => IAgentStore): void {
const replacement = manifest({ instructions: 'Updated instructions.' });
const updated = await store.updateAgent({
tenant_id: TENANT,
- name: 'research',
+ id: created.id,
manifest: replacement,
});
@@ -78,12 +78,12 @@ export function runAgentStoreContractSuite(getStore: () => IAgentStore): void {
expect(await store.getAgent({ tenant_id: TENANT, name: 'research' })).toEqual(updated);
});
- it('updateAgent returns undefined for unknown names', async () => {
+ it('updateAgent returns undefined for unknown ids', async () => {
const store = getStore();
expect(
await store.updateAgent({
tenant_id: TENANT,
- name: 'missing',
+ id: 'missing',
manifest: manifest(),
}),
).toBeUndefined();
diff --git a/packages/server/tests/unit/apis/agents.test.ts b/packages/server/tests/unit/apis/agents.test.ts
index 6a6eb805f..bafaa62da 100644
--- a/packages/server/tests/unit/apis/agents.test.ts
+++ b/packages/server/tests/unit/apis/agents.test.ts
@@ -20,15 +20,27 @@ const modelProvider = {
],
};
-const writeBody = {
- name: 'research',
+const manifest = {
model: { name: 'anthropic/claude-sonnet-4-6' },
instructions: 'Be helpful.',
};
+const writeBody = {
+ name: 'research',
+ manifest,
+};
+
const updateBody = {
- model: { name: 'anthropic/claude-sonnet-4-6' },
- instructions: 'Updated instructions.',
+ manifest: {
+ model: { name: 'anthropic/claude-sonnet-4-6' },
+ instructions: 'Updated instructions.',
+ },
+};
+
+type WireAgent = {
+ id: string;
+ name: string;
+ manifest: { model: { name: string }; instructions?: string };
};
function jsonInit(method: string, body: unknown): RequestInit {
@@ -57,45 +69,48 @@ describe('agents router', () => {
});
});
- it('POST returns a flattened Agent; PUT by immutable name keeps the same id', async () => {
+ it('POST returns a wrapped Agent; PUT by immutable id keeps the same id', async () => {
const created = await router.request('/', jsonInit('POST', writeBody));
- expect(created.status).toBe(200);
- const createdJson = (await created.json()) as {
- data: { id: string; name: string; model: { name: string }; instructions?: string };
- };
- // HTTP wire flattens store.manifest onto the response; id is allocated server-side.
+ expect(created.status).toBe(201);
+ const createdJson = (await created.json()) as { data: WireAgent };
expect(createdJson.data.id.length).toBeGreaterThan(0);
expect(createdJson.data).toMatchObject({
name: 'research',
- model: { name: 'anthropic/claude-sonnet-4-6' },
- instructions: 'Be helpful.',
+ manifest: {
+ model: { name: 'anthropic/claude-sonnet-4-6' },
+ instructions: 'Be helpful.',
+ },
});
- const updated = await router.request('/research', jsonInit('PUT', updateBody));
+ const updated = await router.request(`/${createdJson.data.id}`, jsonInit('PUT', updateBody));
expect(updated.status).toBe(200);
- const updatedJson = (await updated.json()) as {
- data: { id: string; name: string; instructions?: string };
- };
+ const updatedJson = (await updated.json()) as { data: WireAgent };
expect(updatedJson.data.id).toBe(createdJson.data.id);
- expect(updatedJson.data.instructions).toBe('Updated instructions.');
+ expect(updatedJson.data.name).toBe('research');
+ expect(updatedJson.data.manifest.instructions).toBe('Updated instructions.');
});
- it('GET returns 404 for unknown ids; PUT returns 404 for unknown names', async () => {
+ it('GET and PUT return 404 for unknown ids', async () => {
const get = await router.request('/missing-agent-id');
expect(get.status).toBe(404);
- const put = await router.request('/missing-agent', jsonInit('PUT', updateBody));
+ const put = await router.request('/missing-agent-id', jsonInit('PUT', updateBody));
expect(put.status).toBe(404);
});
it('DELETE removes an agent by id and is idempotent', async () => {
const created = await router.request('/', jsonInit('POST', { ...writeBody, name: 'deletable' }));
- expect(created.status).toBe(200);
+ expect(created.status).toBe(201);
const { data } = (await created.json()) as { data: { id: string } };
- expect((await router.request(`/${data.id}`, { method: 'DELETE' })).status).toBe(204);
+ const deleted = await router.request(`/${data.id}`, { method: 'DELETE' });
+ expect(deleted.status).toBe(200);
+ expect(await deleted.json()).toEqual({});
+
expect((await router.request(`/${data.id}`)).status).toBe(404);
- expect((await router.request(`/${data.id}`, { method: 'DELETE' })).status).toBe(204);
+ const deletedAgain = await router.request(`/${data.id}`, { method: 'DELETE' });
+ expect(deletedAgain.status).toBe(200);
+ expect(await deletedAgain.json()).toEqual({});
});
it('POST rejects invalid bodies, unknown models, and duplicate names', async () => {
@@ -104,12 +119,15 @@ describe('agents router', () => {
const unknownModel = await router.request(
'/',
- jsonInit('POST', { ...writeBody, name: 'other', model: { name: 'missing/model' } }),
+ jsonInit('POST', {
+ name: 'other',
+ manifest: { ...manifest, model: { name: 'missing/model' } },
+ }),
);
expect(unknownModel.status).toBe(422);
const first = await router.request('/', jsonInit('POST', { ...writeBody, name: 'alpha' }));
- expect(first.status).toBe(200);
+ expect(first.status).toBe(201);
const clash = await router.request('/', jsonInit('POST', { ...writeBody, name: 'alpha' }));
expect(clash.status).toBe(409);
diff --git a/packages/trueforge-ui-sdk/src/plugins/trueforge-agent-server-adapter/builderServer.ts b/packages/trueforge-ui-sdk/src/plugins/trueforge-agent-server-adapter/builderServer.ts
index 4ac20dd4f..690c245d1 100644
--- a/packages/trueforge-ui-sdk/src/plugins/trueforge-agent-server-adapter/builderServer.ts
+++ b/packages/trueforge-ui-sdk/src/plugins/trueforge-agent-server-adapter/builderServer.ts
@@ -5,7 +5,7 @@
import type { TrueForge, TrueForgeApi } from '@truefoundry/trueforge-sdk';
import type { AgentBuilderServer, AgentLibraryEntry, ModelSelection, SearchAgentsParams } from '../../server/types.js';
import { toUiConnectorFromReadEntry } from './catalogs/connectorCatalog.js';
-import { agentManifest, toHarnessAgentSpec, toUiAgentSpec } from './chatServer.js';
+import { toHarnessAgentSpec, toUiAgentSpec } from './chatServer.js';
import { createTrueForgeClient, type CreateTrueForgeClientOptions } from './client.js';
import { listConfiguredMcpServers, listSkills } from './lists.js';
import type { HarnessAgentSpec } from './types.js';
@@ -48,7 +48,7 @@ function toLibraryEntry(agent: TrueForgeApi.Agent): AgentLibraryEntry {
return {
name: agent.name,
agentId: agent.id,
- agentSpec: toUiAgentSpec(agentManifest(agent)),
+ agentSpec: toUiAgentSpec(agent.manifest),
};
}
@@ -96,10 +96,13 @@ export function createHarnessBuilderServer(
if (intent === 'update') {
const { data } = await client.agents.list();
const existing = data.find(agent => agent.name === agentName);
- await client.agents.update(agentName, manifest);
- return existing === undefined ? {} : { agentId: existing.id };
+ if (!existing) {
+ return {};
+ }
+ await client.agents.update(existing.id, { manifest });
+ return { agentId: existing.id };
}
- const created = await client.agents.create({ name: agentName, ...manifest });
+ const created = await client.agents.create({ name: agentName, manifest });
return { agentId: created.data.id };
},
};
diff --git a/packages/trueforge-ui-sdk/src/plugins/trueforge-agent-server-adapter/chatServer.ts b/packages/trueforge-ui-sdk/src/plugins/trueforge-agent-server-adapter/chatServer.ts
index 14d74db99..c61827ce6 100644
--- a/packages/trueforge-ui-sdk/src/plugins/trueforge-agent-server-adapter/chatServer.ts
+++ b/packages/trueforge-ui-sdk/src/plugins/trueforge-agent-server-adapter/chatServer.ts
@@ -69,14 +69,6 @@ export function toUiAgentSpec(spec: TrueForgeApi.AgentSpec): HarnessAgentSpec {
};
}
-/** Drop registry identity columns so the rest is a plain AgentSpec. */
-export function agentManifest(agent: TrueForgeApi.Agent): TrueForgeApi.AgentSpec {
- const { id, name, ...spec } = agent;
- void id;
- void name;
- return spec;
-}
-
function toUiSession(session: TrueForgeApi.Session): Session<HarnessAgentSpec> {
return {
id: session.id,
diff --git a/packages/trueforge-ui-sdk/src/plugins/trueforge-agent-server-adapter/index.ts b/packages/trueforge-ui-sdk/src/plugins/trueforge-agent-server-adapter/index.ts
index 33b0d36af..7fecee1c8 100644
--- a/packages/trueforge-ui-sdk/src/plugins/trueforge-agent-server-adapter/index.ts
+++ b/packages/trueforge-ui-sdk/src/plugins/trueforge-agent-server-adapter/index.ts
@@ -39,7 +39,6 @@ export {
} from './catalogs/sandboxProviderCatalog.js';
export { createSkillCatalog, toHarnessManifest as toHarnessSkillManifest, toUiSkill } from './catalogs/skillCatalog.js';
export {
- agentManifest,
createHarnessChatServer,
toHarnessAgentSpec,
toUiAgentSpec,
diff --git a/packages/trueforge-ui-sdk/test/plugins/trueforge-agent-server-adapter/harnessBuilderServer.test.ts b/packages/trueforge-ui-sdk/test/plugins/trueforge-agent-server-adapter/harnessBuilderServer.test.ts
index 4e65a4107..a3ebe9096 100644
--- a/packages/trueforge-ui-sdk/test/plugins/trueforge-agent-server-adapter/harnessBuilderServer.test.ts
+++ b/packages/trueforge-ui-sdk/test/plugins/trueforge-agent-server-adapter/harnessBuilderServer.test.ts
@@ -182,12 +182,14 @@ describe('harnessBuilderServer', () => {
{
id: 'agt_1',
name: 'reviewer',
- model: { name: 'test/model' },
- instructions: 'Review carefully.',
- skills: [{ name: 'review' }],
- mcp_servers: [{ name: 'github', enable_tools: ['@all'] }],
+ manifest: {
+ model: { name: 'test/model' },
+ instructions: 'Review carefully.',
+ skills: [{ name: 'review' }],
+ mcp_servers: [{ name: 'github', enable_tools: ['@all'] }],
+ },
},
- { id: 'agt_2', name: 'writer', model: { name: 'test/model' } },
+ { id: 'agt_2', name: 'writer', manifest: { model: { name: 'test/model' } } },
],
});
}
@@ -223,7 +225,11 @@ describe('harnessBuilderServer', () => {
if (url.endsWith('/api/v1/agents') && method === 'POST' && typeof init?.body === 'string') {
requests.push({ method, url, body: JSON.parse(init.body) });
return Response.json({
- data: { id: 'agt_new', name: 'saved-agent', model: { name: 'test/model' } },
+ data: {
+ id: 'agt_new',
+ name: 'saved-agent',
+ manifest: { model: { name: 'test/model' } },
+ },
});
}
return new Response(`Unexpected request: ${method} ${url}`, { status: 500 });
@@ -242,8 +248,10 @@ describe('harnessBuilderServer', () => {
assert.deepEqual(result, { agentId: 'agt_new' });
assert.deepEqual(requests.at(-1)?.body, {
name: 'saved-agent',
- model: { name: 'test/model' },
- skills: [{ name: 'review' }],
+ manifest: {
+ model: { name: 'test/model' },
+ skills: [{ name: 'review' }],
+ },
});
});
@@ -254,17 +262,19 @@ describe('harnessBuilderServer', () => {
const method = init?.method ?? 'GET';
if (url.endsWith('/api/v1/agents') && method === 'GET') {
return Response.json({
- data: [{ id: 'agt_1', name: 'writer', model: { name: 'test/model' } }],
+ data: [{ id: 'agt_1', name: 'writer', manifest: { model: { name: 'test/model' } } }],
});
}
- if (url.endsWith('/api/v1/agents/writer') && method === 'PUT' && typeof init?.body === 'string') {
+ if (url.endsWith('/api/v1/agents/agt_1') && method === 'PUT' && typeof init?.body === 'string') {
requests.push({ method, url, body: JSON.parse(init.body) });
return Response.json({
data: {
id: 'agt_1',
name: 'writer',
- model: { name: 'test/model' },
- instructions: 'Write release notes.',
+ manifest: {
+ model: { name: 'test/model' },
+ instructions: 'Write release notes.',
+ },
},
});
}
@@ -284,8 +294,10 @@ describe('harnessBuilderServer', () => {
assert.deepEqual(result, { agentId: 'agt_1' });
assert.equal(requests.length, 1);
assert.deepEqual(requests[0]?.body, {
- model: { name: 'test/model' },
- instructions: 'Write release notes.',
+ manifest: {
+ model: { name: 'test/model' },
+ instructions: 'Write release notes.',
+ },
});
});
});