Repository navigation
docs: add a configuration assistant skill for AI tools - #707
Open
davecramer wants to merge 2 commits into
Open
davecramer wants to merge 2 commits into
davecramer wants to merge 2 commits into
Conversation
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.
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a configuration assistant skill for AI coding tools, and document how to install it.
Description
Add
docs/NODEJS-WRAPPER-CONFIGURATION-ASSISTANT.mdand a "Configuring the Wrapper with AI Tools" section indocs/GettingStarted.mdwith 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.
3.0.0tag: all 21 plugin codes inconnection_plugin_chain_builder.tshave a section, everyWrapperPropertyincommon/lib/wrapper_property.tsappears, and so do all 16 configuration presets.tsc --noEmitagainstaws-advanced-nodejs-wrapper@3.0.0withpgandmysql2installed (except two short fragments that are not complete programs), and the JavaScript blocks passnode --check. No database connection was made.pgclient, 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:
wrapperConnectTimeoutdefaults to10000(wrapper_property.ts);UsingTheNodejsWrapper.mdsays 20000.Telemetry.mdnamestelemetrySubmitTopLevel; the property istelemetrySubmitToplevel.UsingTheConnectionPool.mdimportsAwsPoolConfigfromaws-advanced-nodejs-wrapper/mysql; it is exported only from the package root (index.ts).README.mdsays Aurora Global Database failover is not supported; 3.0.0 hasgdbFailover, andGlobalDatabases.mddocumentsfailover2andgdbFailoverfor it.GlobalDatabases.mdlistsauroraConnectionTracker"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:
monitorDisposalTimeandgdbMonitoringConnectionPrioritydefaults that differ from the docs,enableGreenHostReplacementandsingleWriterConnectionStringdefaulting 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 inUsingTheNodejsWrapper.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.