Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
davecramer wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7eddc34
docs: add a configuration assistant skill for AI tools
davecramer Oct 14, 2026
3d50601
docs: format the configuration assistant docs with Prettier
davecramer Oct 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions docs/GettingStarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,70 @@ You can use [npm](https://www.npmjs.com/) to obtain the AWS Advanced NodeJS Wrap
## Using the AWS Advanced NodeJS Wrapper

For more detailed information about how to use and configure the AWS Advanced NodeJS Wrapper, please visit [this page](./using-the-nodejs-wrapper/UsingTheNodejsWrapper.md).

## Configuring the Wrapper with AI Tools

If you use an AI coding assistant (Kiro, Cursor, Claude Code, GitHub Copilot, ChatGPT, Amazon Bedrock, etc.), you can use the wrapper's configuration assistant skill to help build, review, or troubleshoot your wrapper configuration.

The skill is a single self-contained markdown file: [`NODEJS-WRAPPER-CONFIGURATION-ASSISTANT.md`](./NODEJS-WRAPPER-CONFIGURATION-ASSISTANT.md). It covers every plugin, parameter, default value, dialect, failover mode, configuration preset, and compatibility constraint of release 3.0.0, together with recipes for `pg`, `mysql2`, the wrapper's pool clients, and Prisma, so the AI can answer configuration questions without access to the wrapper source.

The file follows the [Agent Skills](https://agentskills.io) format. It is large: about 118,000 tokens on Claude Opus 5.5 (other models count tokens differently), and the AI receives it again with every message. Tools that cache the system prompt handle it far more cheaply than tools that resend it in full each time.

### Quick start

1. Download or copy [`NODEJS-WRAPPER-CONFIGURATION-ASSISTANT.md`](./NODEJS-WRAPPER-CONFIGURATION-ASSISTANT.md).
2. Add it to your AI tool:
- **Tools that support Agent Skills** (Kiro, Cursor, Claude Code, GitHub Copilot in VS Code, and others): create a folder named `nodejs-wrapper-configuration-assistant` in one of the tool's skills directories, and save the file inside it as `SKILL.md`. The folder name must match the `name` field at the top of the file; otherwise the tool does not load the skill.

| Tool | Project skills directory | User skills directory |
| ------------------------- | ---------------------------------------------------------- | ----------------------------------------------------------------- |
| Kiro | `.kiro/skills/` | `~/.kiro/skills/` |
| Cursor | `.cursor/skills/`, `.agents/skills/`, or `.claude/skills/` | `~/.cursor/skills/`, `~/.agents/skills/`, or `~/.claude/skills/` |
| Claude Code | `.claude/skills/` | `~/.claude/skills/` |
| GitHub Copilot in VS Code | `.github/skills/`, `.agents/skills/`, or `.claude/skills/` | `~/.copilot/skills/`, `~/.agents/skills/`, or `~/.claude/skills/` |

For example, to add the skill to a project for Claude Code, Cursor, and VS Code at once:

```bash
mkdir -p .claude/skills/nodejs-wrapper-configuration-assistant
curl -fsSL -o .claude/skills/nodejs-wrapper-configuration-assistant/SKILL.md \
https://raw.githubusercontent.com/aws/aws-advanced-nodejs-wrapper/main/docs/NODEJS-WRAPPER-CONFIGURATION-ASSISTANT.md
```

- **Claude Projects**: upload it as a project knowledge document.
- **ChatGPT custom GPT**: upload it as a knowledge file.
- **Amazon Bedrock**: send the file as the system prompt of your `InvokeModel` or `Converse` request. Avoid attaching it to a Bedrock knowledge base: a knowledge base passes the model only the passages that match each question, so the skill's interview steps and rules (section 1 of the file) may be missing.
- **Plain chat (ChatGPT, Claude, Gemini)**: paste it at the start of a new conversation, then ask your question.

3. Ask the AI for help. It will interview you when it needs more details, or give you a configuration straight away if you ask it to skip the interview.

### Example prompts

The simplest way to start:

```
Help me configure the AWS Advanced NodeJS Wrapper for my application.
```

Skip the interview when you already know what you want:

```
Give me a default configuration for Aurora PostgreSQL with the pg driver, the wrapper's pool client, and failover support.
```

Review an existing configuration:

```
Review this wrapper configuration and tell me what to change:

<paste your AwsPgClient, AwsMySQLClient, or pool client configuration here>
```

Diagnose an error:

```
My service on Aurora MySQL fails to connect with "UnsupportedMethodError: Keep alive
configuration is not supported for MySQL2." What's wrong?
```

The skill targets release 3.0.0 and avoids guessing: if it doesn't know something, it says so and points you at the official docs.
Loading
Loading