feat: add description field to connector configuration entries#1721
Open
nborges-aws wants to merge 1 commit into
Open
feat: add description field to connector configuration entries#1721nborges-aws wants to merge 1 commit into
nborges-aws wants to merge 1 commit into
Conversation
Adds a `description` field to each configuration entry written to agentcore.json. KB configurations are pre-populated with the API operation description from the Smithy model; web-search is left empty for customers to fill in. The CDK construct passes non-empty descriptions through to CloudFormation.
github-actions
Bot
added
size/xs
agentcore-devx-automation
Bot
added
the
claude-security-reviewing
Contributor
|
Claude Security Review: no high-confidence findings. (run) |
agentcore-devx-automation
Bot
removed
the
claude-security-reviewing
Contributor
Package TarballHow to installgh release download pr-1721-tarball --repo aws/agentcore-cli --pattern "*.tgz" --dir /tmp/pr-tarball
npm install -g /tmp/pr-tarball/aws-agentcore-0.23.0.tgz |
agentcore-cli-automation
approved these changes
Jul 9, 2026
agentcore-cli-automation
left a comment
agentcore-cli-automation
left a comment
There was a problem hiding this comment.
LGTM. Small, focused change that surfaces the description field in agentcore.json.
A few things I looked at that turned out to be fine:
- Type vs. schema mismatch:
ConfigurationEntry.descriptionis required (string) intranslators.ts, while the zod schema (mcp.ts) marks itoptional(). Not a real bug —ConfigurationEntryis only used as the return type oftranslateConnector(which always populates it), never as an input read from parsed config. Backward-compatible for existing hand-edited files. - Empty string for web-search: Writing
description: ''results in an explicit"description": ""entry inagentcore.json. This matches the PR's stated intent (surface the field so customers can fill it in) and is covered by the new integ assertion. - Telemetry: No new command / user-facing event, so no new instrumentation needed per
src/cli/telemetry/README.md. - Mocking: No new mocks introduced.
github-actions
Bot
removed
the
agentcore-harness-reviewing
Contributor
Coverage Report
|
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
2 participants
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.
Adds a description field to each connector configuration entry written to agentcore.json. KB configurations are pre-populated with a default description; web-search defaults to an empty string. This makes the field visible to customers editing agentcore.json directly, so they can provide tool descriptions without needing to know the field exists.
Description
Related Issue
Closes #
Documentation PR
Type of Change
Testing
How have you tested the change?
npm run test:unitandnpm run test:integnpm run typechecknpm run lintsrc/assets/, I rannpm run test:update-snapshotsand committed the updated snapshotsChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.