docs: add gateway-target documents five of eight target types, connector and web search are missing
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 86/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- typescript
- 領域
- cli, documentation
調査の方向性
まず docs/commands.md、docs/configuration.md、docs/gateway.md の add gateway-target セクションから始め、次に src/cli/primitives/GatewayTargetPrimitive.ts および issue で示されている schema references と比較します。既存の README の web-search 例と、一覧にある lifecycle tests を確認します。受け入れられるすべての target types と connector flags がドキュメント化され、web-search と Bedrock Knowledge Bases の例があり、3つのドキュメントの内容が一致していれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Description
agentcore add gateway-target accepts eight --type values at main (31e98b7), but the docs describe five. The three
missing from the docs are connector, http-runtime and passthrough. connector is the only way to add a managed web
search or Bedrock Knowledge Bases target, so web search reads as unsupported to anyone working from docs/.
The help string in the code lists all eight (src/cli/primitives/GatewayTargetPrimitive.ts:278):
Target type (required): mcp-server, api-gateway, open-api-schema, smithy-model, lambda-function-arn, http-runtime, connector, passthrough [non-interactive]
Three pages are affected:
docs/commands.md,add gateway-target: says "Supports five target types" and the--typerow lists five.
--connector,--knowledge-base-idand--exclude-domainsare not documented anywhere on the page, although
--connector <id>is registered atGatewayTargetPrimitive.ts:299and--exclude-domains <list>at:309.docs/configuration.md:493: thetargetTypefield is documented asmcpServer,lambda,openApiSchema,
smithyModel,apiGatewayorlambdaFunctionArn. The schema also validatesconnector,httpRuntimeand
passthrough(src/schema/schemas/mcp.ts:746,:637,:681), and a connector target carries aconnectorIdand a
configurations[]array that the page does not describe.docs/gateway.md:README.md:228sends readers here "for full target setup", and the stringsconnectorand
web-searchappear zero times in it.
README.md:218 does document the web search target, so the README and docs/ disagree with each other.
Steps to Reproduce
- Read the
add gateway-targetsection ofdocs/commands.md. - Run
agentcore add gateway-target --help. - Compare the
--typevalues in each.
Expected Behavior
The documented target types match the ones the CLI accepts, and --connector, --knowledge-base-id and
--exclude-domains appear in the add gateway-target flag table with an example for web search and one for Bedrock
Knowledge Bases.
Actual Behavior
docs/commands.md documents five of the eight types and none of the connector flags. docs/configuration.md documents
six of the nine targetType values. docs/gateway.md does not mention connector targets at all.
CLI Version
0.28.1
Operating System
macOS
Additional Context
Verified by reading the repository at main (31e98b7).
Web search itself is not gated. src/cli/feature-flags.ts checks ENABLE_GATED_FEATURES, and the only target type
still behind it is passthrough (e2e-tests/httpgateway-all-targets.test.ts:74). The connector path is covered by
e2e-tests/web-search-lifecycle.test.ts and integ-tests/add-remove-web-search.test.ts.
Web search did move in and out of a gate earlier this year (#1558, reverted in #1567, #1597, re-gated in #1625, tests
restored in #1711), which may be how the docs were left behind.
- 主要言語
- TypeScript
- スター
- 291
- フォーク
- 96
- 平均マージ
- 21時間 31分
- マージ済み PR(30日)
- 217
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
aws/agentcore-cli のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
aws/agentcore-cli#2395 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
aws/agentcore-cli#2392 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
aws/agentcore-cli#2267 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
aws/agentcore-cli#2258 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
aws/agentcore-cli#2176 ·
aws/agentcore-cli の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
bcgov/bc-wallet-mobile#4761 · コメント 1 件 ·
-
external-issue to-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
-
area-deployment area-integrations triage:bot-seen
難易度 2/5 半日 初心者へのやさしさ 86/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
-
refactor
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100