docs: add gateway-target documents five of eight target types, connector and web search are missing
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 86/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- typescript
- Área
- cli, documentation
Línea de trabajo
Comienza con las secciones de add gateway-target en docs/commands.md, docs/configuration.md y docs/gateway.md; después, compáralas con src/cli/primitives/GatewayTargetPrimitive.ts y con las referencias de esquema indicadas en el issue. Revisa el ejemplo existente de búsqueda web en README y las pruebas de ciclo de vida enumeradas. El trabajo estará terminado cuando estén documentados todos los tipos de target y flags de connector aceptados, haya ejemplos de web-search y Bedrock Knowledge Bases, y los tres documentos coincidan.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- TypeScript
- Estrellas
- 291
- Forks
- 96
- Merge medio
- 21 h 31 min
- PR fusionados (30 d)
- 217
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de aws/agentcore-cli
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
aws/agentcore-cli#2395 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
aws/agentcore-cli#2392 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
aws/agentcore-cli#2267 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
aws/agentcore-cli#2258 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
aws/agentcore-cli#2176 ·
Todos los issues de aws/agentcore-cli
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
bcgov/bc-wallet-mobile#4761 · 1 comentario ·
-
external-issue to-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
area-deployment area-integrations triage:bot-seen
Dificultad 2/5 Medio día Aptitud para principiantes 86/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
refactor
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100