add Amazon Q Developer CLI usage example

[cornelcroi]

I've added the configuration to use this MCP server in Amazon Q Developer CLI.

Summary by CodeRabbit

• Documentation
  • Added an “Amazon A Developer CLI” section with a JSON example for configuring MCP via a config file.
  • Reorganized the Installation and Configuration content for clearer setup steps.
  • Included direct links to MCP documentation for deeper guidance.
  • Improved readability and structure of setup instructions.
  • No changes to application behavior.

[coderabbitai]

Walkthrough

Adds a new “Amazon A Developer CLI” section to README.md with a JSON MCP configuration snippet, links to MCP docs, and reorganized installation/configuration text. No source code or API changes.

Changes

Cohort / File(s)	Summary
Docs — README update README.md	Added “Amazon A Developer CLI” section, included JSON snippet for MCP config file, linked to MCP documentation, and adjusted Installation/Configuration structure. Documentation-only; no logic changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I nibbled the docs with whiskered delight,
A JSON crumb tucked neat and tight.
MCP paths lined, tidy and clear,
Install steps shuffled, carrots near.
No code to chase—just pages to preen,
A happy hop through README green. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title “add Amazon Q Developer CLI usage example” accurately and concisely conveys the main change of this pull request, which is adding a usage example for the Amazon Q Developer CLI to the documentation, ensuring readers immediately understand its purpose.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2670a7d and 1169db7.

📒 Files selected for processing (1)

• README.md (1 hunks)

[coderabbitai]

⚠️ Potential issue | 🟠 Major

Fix the product name and align with the current Amazon Q CLI config path.

This section calls the tool “Amazon A Developer CLI”, but AWS branding and documentation consistently call it “Amazon Q Developer CLI”, so the typo will confuse readers. In addition, Amazon Q CLI’s July 31 2025 custom-agent update moved MCP configuration into ~/.aws/amazonq/cli-agents/…; pointing users to ~/.aws/amazonq/mcp.json is now legacy and won’t load on fresh installs. Please update the heading/link text to “Amazon Q Developer CLI” and rewrite the example to show how to add the mcpServers block inside an agent file under the new cli-agents directory (or otherwise follow the updated agent format).(aws.amazon.com)

🤖 Prompt for AI Agents

In README.md around lines 180 to 196, fix the product name and update the MCP
config path: change the heading/link text from “Amazon A Developer CLI” to
“Amazon Q Developer CLI” and update the example to show adding the mcpServers
block inside an agent file under ~/.aws/amazonq/cli-agents/ (follow the new
agent file format used by the July 31 2025 update) instead of referencing the
legacy ~/.aws/amazonq/mcp.json path; ensure the example reflects the new agent
file location and format and update the accompanying link text to match the
corrected product name.