Uh oh!
There was an error while loading. Please reload this page.
feat: add API Gateway REST API as new gateway target type - #509
Conversation
Coverage Report
|
Uh oh!
There was an error while loading. Please reload this page.
| sourcePath: '', | ||
| language: 'Other', | ||
| host: 'AgentCoreRuntime', | ||
| targetType: 'apiGateway', |
There was a problem hiding this comment.
Can we see if targetType is defined in the original Type?
There was a problem hiding this comment.
And it also looks like createApiGatewayTarget() never reads config.targetType — it hardcodes targetType: 'apiGateway' when building the target object at line ~527
| // Handle API Gateway targets (no code generation) | ||
| if (cliOptions.type === 'apiGateway') { | ||
| const config: AddGatewayTargetConfig = { |
There was a problem hiding this comment.
The AddGatewayTargetConfig type was designed for MCP server / Lambda targets. For API Gateway targets, several required fields are set to meaningless values:
- sourcePath: '' — no source code for API Gateway targets
- host: 'AgentCoreRuntime' — not a real compute host
- toolDefinition: { name, description, inputSchema: { type: 'object' } } — a dummy value, never used by
createApiGatewayTarget()
Consider either making these fields optional or introducing a discriminated union / separate config type
for API Gateway targets so the type system enforces correctness.
| if (data.targetType === 'apiGateway') { | ||
| if (!data.apiGateway) { | ||
| ctx.addIssue({ |
There was a problem hiding this comment.
The CLI validation correctly rejects --outbound-auth for api-gateway, but the Zod schema's superRefine block does not check for outboundAuth on apiGateway targets. Someone editing mcp.json manually could add outboundAuth to an apiGateway target and the schema would accept it. Add a check similar to the compute/endpoint ones:
if(data.outboundAuth){ctx.addIssue({code: z.ZodIssueCode.custom,message: 'outboundAuth is not applicable for apiGateway target type',path: ['outboundAuth'],});}| .option('--rest-api-id <id>', 'API Gateway REST API ID (required for api-gateway type)') | ||
| .option('--stage <stage>', 'API Gateway deployment stage (required for api-gateway type)') | ||
| .option('--tool-filter-path <path>', 'Tool filter path pattern, e.g. /pets/*') | ||
| .option('--tool-filter-methods <methods>', 'Comma-separated HTTP methods, e.g. GET,POST') |
There was a problem hiding this comment.
When --tool-filter-methods is omitted:
- In CLI action (GatewayTargetPrimitive.ts:~296): defaults to ['GET']
- In createApiGatewayTarget (GatewayTargetPrimitive.ts:~530): defaults to [{ filterPath: '/*', methods:
['GET'] }]
Description
Adds
--type api-gatewayas a new gateway target type, allowing users to register an existing Amazon API Gateway REST API as a gateway target. This enables agents to invoke tools backed by REST API endpoints through an AgentCore gateway without the REST API needing to speak MCP.Changes:
'apiGateway'toGatewayTargetTypeSchema, 5 new Zod schemas (ApiGatewayConfigSchema,ApiGatewayToolFilterSchema, etc.),apiGatewayfield onAgentCoreGatewayTargetSchemawith superRefine validation--rest-api-id,--stage,--tool-filter-path,--tool-filter-methodscreateApiGatewayTarget()method onGatewayTargetPrimitive— writes apiGateway target config to mcp.jsonmapMcpGatewaysToGatewayProviders→mapGatewaysToGatewayProviders, simplified outputs.ts regexUsage:
Writes to mcp.json:
Note: API Gateway targets use
GATEWAY_IAM_ROLEfor authentication — no credential setup needed. The corresponding CDK construct changes (which synthesize the CloudFormation) are in a separate CDK repo PR.Related Issue
Closes #
Documentation PR
N/A — documentation updates will follow with the TUI wizard 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 snapshotsAdditionally:
Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the
terms of your choice.