Repository navigation
docs: add a configuration assistant skill for AI tools - #1293
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/PYTHON-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 psycopg, MySQL Connector/Python, SQLAlchemy (sync and async), Django, IAM, Secrets Manager, read/write splitting, Aurora Global Database, and Multi-AZ DB clusters, and documents every plugin and parameter of release 3.1.0. The skill follows the source where the docs disagree with it, for example failover_mode values must use underscores (strict_writer), the host_monitoring plugins raise with mysql-connector-python, and the default plugin chain uses failover_v2 and host_monitoring_v2. Add a "Configuring the Wrapper with AI Tools" section to GettingStarted.md with installation steps for common tools.
Match the JDBC wrapper's AI tools section with four example prompts: start, skip the interview, review a configuration, and diagnose an error. The error example uses the exact message the host_monitoring_v2 plugin raises with mysql-connector-python.
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.
Description
Add
docs/PYTHON-WRAPPER-CONFIGURATION-ASSISTANT.md, a configuration assistant skill for AI coding tools, and a "Configuring the Wrapper with AI Tools" section indocs/GettingStarted.mdthat explains how to install it.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 psycopg, MySQL Connector/Python, SQLAlchemy (sync and async), Django, IAM, Secrets Manager, read/write splitting, Aurora Global Database, Multi-AZ DB clusters, multiple clusters, and the internal connection pool. It targets release 3.1.0 and names only this wrapper.
How it was checked.
3.1.0tag: all 22 plugin codes inPluginManager.PLUGIN_FACTORIEShave a section, and all 116WrapperPropertynames inutils/properties.pyappear in the skill.maindiffers from3.1.0in one example file only.aws-advanced-python-wrapper==3.1.0with psycopg, mysql-connector-python, SQLAlchemy, and Django installed. No database connection was made.Docs that disagree with the source. Where they differ, the skill follows the source. I confirmed these in the 3.1.0 code:
failover_modeaccepts onlystrict_writerandstrict_reader(utils/failover_mode.py); any other value, including the hyphenatedstrict-writerused inUsingTheFailover2Plugin.mdandGlobalDatabases.md, silently becomesreader_or_writer.UsingTheFailover2Plugin.mdsays the v1failoverplugin is the default when "wrapperPlugins" is unset. The parameter isplugins, and the default chain isinitial_connection,aurora_connection_tracker,failover_v2,host_monitoring_v2(withouthost_monitoring_v2for mysql-connector-python).host_monitoringandhost_monitoring_v2raise at plugin creation with mysql-connector-python, whileSqlAlchemySupport.mdandDjangoSupport.mdshow MySQL chains that includehost_monitoring_v2.DatabaseDialects.mdlistsrds-multi-az-mysql-clusterandrds-multi-az-pg-cluster; the codes aremulti-az-mysqlandmulti-az-pg.Telemetry.mdnamestelemetry_submit_top_level; the property istelemetry_submit_toplevel.UsingTheSimpleReadWriteSplittingPlugin.mdgivessrw_connect_retry_timeout_msa default of 6000; the source default is 60000.Also found while writing the skill but not individually re-checked:
iam_expiration(docs 870, source default 900), the Secrets Manager key parameter names (source adds a_keysuffix), the fastest-response parameter name and value, andcreate_async_engine("postgresql+aws_wrapper_psycopg://")failing with SQLAlchemy 2.1 but working with 2.0.x. 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.