Skip to content

docs: add a configuration assistant skill for AI tools - #707

Open
davecramer wants to merge 2 commits into
aws:mainfrom
davecramer:docs/configuration-assistant-skill
Open

davecramer wants to merge 2 commits into
aws:mainfrom
davecramer:docs/configuration-assistant-skill

Conversation

@davecramer

Copy link
Copy Markdown

Summary

Add a configuration assistant skill for AI coding tools, and document how to install it.

Description

Add docs/NODEJS-WRAPPER-CONFIGURATION-ASSISTANT.md and a "Configuring the Wrapper with AI Tools" section in docs/GettingStarted.md with installation steps for common tools and example prompts.

What the skill does. It is a single markdown file in the Agent Skills format. Loaded into an AI assistant, it lets the assistant interview a user, review a pasted configuration, answer parameter questions, and diagnose common errors. It has recipes for pg, mysql2, the wrapper's pool clients, Prisma, IAM, Secrets Manager, read/write splitting, Aurora Global Database, Multi-AZ DB clusters, multiple clusters, and configuration presets. It targets release 3.0.0 and names only this wrapper.

How it was checked.

  • Every plugin code, parameter name, and default was checked against the source at the 3.0.0 tag: all 21 plugin codes in connection_plugin_chain_builder.ts have a section, every WrapperProperty in common/lib/wrapper_property.ts appears, and so do all 16 configuration presets.
  • Every TypeScript code block type-checks with tsc --noEmit against aws-advanced-nodejs-wrapper@3.0.0 with pg and mysql2 installed (except two short fragments that are not complete programs), and the JavaScript blocks pass node --check. No database connection was made.
  • 16 conversations on Claude Opus 5.5 (four scenarios: a single pg client, the pool client, mysql2, and Aurora Global Database; each with and without the interview, twice). A simulated user answered from a hidden description of the application, and a separate grader checked each final configuration against the wrapper's docs and source. All 16 configurations passed every required check. The file is about 118,000 tokens on that model.

Docs that disagree with the source. Where they differ, the skill follows the source. I confirmed these in the 3.0.0 code:

  • wrapperConnectTimeout defaults to 10000 (wrapper_property.ts); UsingTheNodejsWrapper.md says 20000.
  • Telemetry.md names telemetrySubmitTopLevel; the property is telemetrySubmitToplevel.
  • UsingTheConnectionPool.md imports AwsPoolConfig from aws-advanced-nodejs-wrapper/mysql; it is exported only from the package root (index.ts).
  • README.md says Aurora Global Database failover is not supported; 3.0.0 has gdbFailover, and GlobalDatabases.md documents failover2 and gdbFailover for it.
  • GlobalDatabases.md lists auroraConnectionTracker "with connection pooling", but the plugin skips connections that come from the wrapper's pool clients (aurora_connection_tracker_plugin.ts:69).

Also found while writing the skill but not individually re-checked: monitorDisposalTime and gdbMonitoringConnectionPriority defaults that differ from the docs, enableGreenHostReplacement and singleWriterConnectionString defaulting to the string "false" (which is truthy), the fastest-response-strategy property prefix, log levels in the docs that turn wrapper logging off, and several plugin codes missing from the plugins table in UsingTheNodejsWrapper.md. These would be worth fixing in the docs separately.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Add docs/NODEJS-WRAPPER-CONFIGURATION-ASSISTANT.md, a self-contained
skill in the Agent Skills format. An AI assistant loads it to build,
review, or troubleshoot a wrapper configuration: it interviews the
user, gives recipes for pg, mysql2, the wrapper's pool clients,
Prisma, IAM, Secrets Manager, read/write splitting, Aurora Global
Database, Multi-AZ DB clusters, and configuration presets, and
documents every plugin, parameter, and preset of release 3.0.0.

Where the docs disagree with the source, the skill follows the
source, for example the wrapperConnectTimeout default (10000) and the
telemetrySubmitToplevel parameter name.

Add a "Configuring the Wrapper with AI Tools" section to
GettingStarted.md with installation steps for common tools and
example prompts.
@davecramer
davecramer requested a review from a team as a code owner October 14, 2026 20:34
The repository's CI runs prettier . --check; apply the project's
.prettierrc (printWidth 150) to the skill and GettingStarted.md.

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant