fix: clarify gateway-connector help text - #2235
Conversation
- Add enum values to --connector description so `agentcore project add gateway-connector --help` shows the accepted values [bedrock-knowledge-bases | web-search]. - Drop the "project Knowledge Base name" reference from --knowledge-base: the handler only passes the string through as knowledgeBaseId, and project-owned Knowledge Bases are not yet implemented.
|
Claude Security Review: no high-confidence findings. (run) |
There was a problem hiding this comment.
AgentCore Harness Review
Verdict: Looks good
Small, doc-only change updating two flag descriptions in src/handlers/project/add/gateway-connector/index.ts.
- The added enum hint on
--connector([bedrock-knowledge-bases | web-search]) matches the zod enum on the next line. - The
--knowledge-basedescription change aligns with actual handler behavior:connectorTargetFromShortcut(lines 101–126) passes the string straight through asknowledgeBaseIdwith no project-KB resolution, and per the commit message project-owned KBs aren't implemented yet. Note thatsrc/projectSchemas/project.ts(~lines 183–207) still tolerates a project-KB name as a valid reference, so if/when that flow is wired up end-to-end the help text may need to be widened again — but for now the new wording is more accurate than the old one.
No code changes required.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## refactor #2235 +/- ##
=========================================
Coverage 96.98% 96.98%
=========================================
Files 564 564
Lines 39226 39226
=========================================
Hits 38042 38042
Misses 1184 1184 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
Thanks for the report, @codecov-commenter — feedback like this is exactly Would you mind opening a new issue so we can track it properly? If this is a security issue, please report it privately via |
Summary
agentcore project add gateway-connector --helpdidn't list the accepted values for--connector. Add `[bedrock-knowledge-bases | web-search]` to the description so users can discover them without reading the source.--knowledge-baseclaimed to accept a "project Knowledge Base name or external ten-character ID", but project-owned Knowledge Bases are not implemented — the handler passes the string straight through as `knowledgeBaseId`. Drop the false claim.Before
```
--connector curated connector
--knowledge-base project Knowledge Base name or external ten-character ID; only for bedrock-knowledge-bases
```
After
```
--connector curated connector [bedrock-knowledge-bases | web-search]
--knowledge-base external ten-character Knowledge Base ID; only for bedrock-knowledge-bases
```
Test plan