Skip to content

fix: clarify gateway-connector help text - #2235

Merged
tejaskash merged 1 commit into
refactorfrom
fix/gateway-connector-help
Sep 4, 2026
Merged

fix: clarify gateway-connector help text#2235
tejaskash merged 1 commit into
refactorfrom
fix/gateway-connector-help

Conversation

@jariy17

@jariy17 jariy17 commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Summary

  • agentcore project add gateway-connector --help didn'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-base claimed 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

  • `bun run build`
  • `agentcore project add gateway-connector --help` shows the updated text
  • No behavior change — the enum on `--connector` and the pass-through of `--knowledge-base` were already what the code did; this only aligns the help text with reality

- 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.
@github-actions github-actions Bot added the size/xs PR size: XS label Sep 4, 2026
@agentcore-devx-automation agentcore-devx-automation Bot added agentcore-harness-reviewing AgentCore Harness review in progress claude-security-reviewing Claude Code /security-review in progress labels Sep 4, 2026
@agentcore-devx-automation

Copy link
Copy Markdown
Contributor

Claude Security Review: no high-confidence findings. (run)

@agentcore-devx-automation agentcore-devx-automation Bot removed claude-security-reviewing Claude Code /security-review in progress agentcore-harness-reviewing AgentCore Harness review in progress labels Sep 4, 2026

@agentcore-devx-automation agentcore-devx-automation Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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-base description change aligns with actual handler behavior: connectorTargetFromShortcut (lines 101–126) passes the string straight through as knowledgeBaseId with no project-KB resolution, and per the commit message project-owned KBs aren't implemented yet. Note that src/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.

@tejaskash
tejaskash merged commit 0e37a6f into refactor Sep 4, 2026
19 of 21 checks passed
@tejaskash
tejaskash deleted the fix/gateway-connector-help branch September 4, 2026 20:05
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.98%. Comparing base (81f5af2) to head (84c3dca).
⚠️ Report is 1 commits behind head on refactor.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Thanks for the report, @codecov-commenter — feedback like this is exactly
how we catch the things we missed. Because this PR is already
closed, the team won't see follow-up comments here.

Would you mind opening a new issue so we can track it properly?
https://github.com/aws/agentcore-cli/issues/new/choose

If this is a security issue, please report it privately via
https://aws.amazon.com/security/vulnerability-reporting/ instead
of a public issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/xs PR size: XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants