✨ feat(assistant): add description field support from Agent Server API - #726
Merged
codekiln merged 2 commits intoJan 22, 2026
Merged
Conversation
Add description field to Assistant SDK structs and CLI commands per Agent Server API spec. SDK changes: - Add description: Option<String> to Assistant struct - Add description to CreateAssistantRequest - Add description to UpdateAssistantRequest - Update unit tests to include description field - Update integration tests to include description field CLI changes: - Add --description flag to assistant create command - Add --description flag to assistant update command - Add description to ASSISTANT_COLUMNS for text output - Display description in get command output - Update ColumnMetadata to render description in TSV Fixes #725 Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
Contributor
Contributor
There was a problem hiding this comment.
Pull request overview
This PR implements support for the description field from the LangSmith Agent Server API, enabling users to add descriptive text to assistants for better documentation and discovery.
Changes:
- Added
description: Option<String>field to SDK Assistant structs (Assistant, CreateAssistantRequest, UpdateAssistantRequest) - Added
--descriptionflag to CLIcreateandupdatecommands for assistants - Enhanced CLI output to display description in
getcommand and include it as an available column for text output
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| sdk/src/assistants.rs | Added optional description field to Assistant, CreateAssistantRequest, and UpdateAssistantRequest structs with proper serialization attributes; updated unit tests |
| sdk/tests/assistant_integration_test.rs | Updated integration test requests to include description field (set to None for existing tests) |
| cli/src/commands/assistant.rs | Added --description flag to create/update commands, added description to available columns, implemented display logic for get command, and updated TSV rendering |
Contributor
…n field Adds SDK and CLI integration tests for assistant description field support: SDK Integration Tests (sdk/tests/assistant_integration_test.rs): - test_assistant_description_field: Full CRUD lifecycle with description - Create assistant WITH description - Verify description in GET response - Update description - Verify update persisted - Test clearing description (None handling) - Cleanup with DELETE CLI Integration Tests (cli/tests/assistant_command_test.rs): - test_assistant_description_field: Full CLI workflow with description - Create with --description flag - Verify description in JSON output - GET and verify description - UPDATE description via --description flag - Verify update persisted - Check description appears in text output (stderr) Testing Standards: - Follows CRUD lifecycle pattern (docs/dev/testing/crud-lifecycle-pattern.md) - Uses SDK to verify CLI actions persisted correctly - Verifies actual behavior, not just exit codes - Uses unique test names (microsecond timestamp + UUID) - Proper cleanup in all test paths - Marked with #[cfg_attr(not(feature = "integration-tests"), ignore)] All 610 workspace tests pass. Related to #725 Co-Authored-By: Claude <noreply@anthropic.com>
codekiln
deleted the
m12-i725-featassistant-add-description-field-support-from-a
branch
January 22, 2026 22:06
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements support for the
descriptionfield from the LangSmith Agent Server API in both SDK and CLI.Changes
SDK (
sdk/src/assistants.rs)description: Option<String>toAssistantstructdescription: Option<String>toCreateAssistantRequeststructdescription: Option<String>toUpdateAssistantRequeststructCLI (
cli/src/commands/assistant.rs)--descriptionflag toassistant createcommand--descriptionflag toassistant updatecommandassistant getcommand outputColumnMetadata::render_tsvto handle description columnAPI Specification
According to the Agent Server API docs:
string | nullTest Plan
Related Issues
Fixes #725
🤖 Generated with Claude Code