Skip to content

feat(agents): Support agent description - #650

Merged
bhaveshpatel640 merged 12 commits into
mainfrom
AGE-2120
Sep 11, 2026
Merged

feat(agents): Support agent description#650
bhaveshpatel640 merged 12 commits into
mainfrom
AGE-2120

Conversation

@bhaveshpatel640

@bhaveshpatel640 bhaveshpatel640 commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Persist top-level agent description


Note

Medium Risk
Create-agent is a breaking API/SDK contract change, plus a DB migration and ServiceFoundry dual-write paths where description sync failures could leave remote/local skew.

Overview
Adds a required top-level description (1–1024 chars) on agents, separate from the manifest, and threads it through storage, the public API, ServiceFoundry sync, the regenerated SDK, and the UI.

Backend & API: OpenAPI and Zod schemas now include description on Agent, require it on create, and allow optional updates (manifest-only PUT keeps the stored description). Postgres/SQLite migrations add the column and backfill from name. Agent create/update/import and TrueFoundryAgentStore push the real description to ServiceFoundry instead of always using the agent name.

UI: Save/update flows require a description field, shell mode carries it outside AgentSpec, the agents library shows truncated descriptions (skipping name-echo fallbacks), agent overview shows a Description card, and clone/edit propagate the stored value. The harness adapter sends top-level description on create (name fallback for legacy clones) and omits empty description on update to avoid wiping stored text.

SDK: Fern-generated types and wire tests include description; create calls must pass it.

Reviewed by Cursor Bugbot for commit dd80759. Bugbot is set up for automated code reviews on this repo. Configure here.

@changeset-bot

changeset-bot Bot commented Sep 9, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: dd80759

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@truefoundry/trueforge-sdk Patch
@truefoundry/trueforge-ui Patch
@truefoundry/trueforge Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stale Bugbot comment from a previous run.

Comment thread .github/fern/openapi/openapi.json
cursor[bot]

This comment was marked as outdated.

Comment thread .github/fern/openapi/openapi.json

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 00210d3. Configure here.

Comment thread packages/trueforge/src/schemas/agent.ts
@harshil-2096
harshil-2096 added this pull request to stack #708 September 11, 2026 09:57
Comment thread packages/trueforge/tests/unit/truefoundry/TrueFoundryAgentStore.test.ts Outdated
@bhaveshpatel640
bhaveshpatel640 removed this pull request from stack #708 September 11, 2026 11:50
@bhaveshpatel640
bhaveshpatel640 added this pull request to stack #712 September 11, 2026 12:19
@bhaveshpatel640
bhaveshpatel640 removed this pull request from stack #712 September 11, 2026 12:51
* Regenerate OpenAPI document and TypeScript SDK

* Chore: Add agent description support in UI

* Enhancement: Implement support for agent descriptions across UI components

* chore: update @truefoundry/assistant-ui-runtime to version 0.1.37 in package.json files

* Refactor: Simplify agent description handling and improve UI consistency

* Fix: Ensure agent description is displayed in the save dialog

* Refactor: Replace description text with tooltip in AgentLibraryRow and remove unused description in AgentOverview

* Enhancement: Add description display in AgentOverview component

* Add description field to agent records in tests and update AgentsLibrary for better handling of agent descriptions

- Added 'description' field to agent records in agentStoreContractSuite, TrueFoundryMcpServerStore.test, and TrueFoundryModelProviderStore.test.
- Updated AgentsLibrary component to improve description handling, ensuring proper truncation and avoiding name-echo descriptions.
- Enhanced test cases to verify description truncation and visibility in the AgentsLibrary.

---------

Co-authored-by: trueforge-dev-bot[bot] <trueforge-dev-bot[bot]@users.noreply.github.com>
Co-authored-by: Govinda Vashishtha <57435703+govindavashishtha@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Bhavesh Patel <bhavesh@truefoundry.com>
@bhaveshpatel640 bhaveshpatel640 changed the title Persist top-level agent description TF Support Agent Description - BE updates Sep 11, 2026
@bhaveshpatel640
bhaveshpatel640 merged commit 8c31eae into main Sep 11, 2026
12 checks passed
@bhaveshpatel640
bhaveshpatel640 deleted the AGE-2120 branch September 11, 2026 12:56
@bhaveshpatel640 bhaveshpatel640 changed the title TF Support Agent Description - BE updates feat(agents): Support agent description Sep 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants