Update README with detailed instructions for Aider /code mode usage

[lutzleonhardt]

User description

This PR updates the README to clarify the requirements for using the toolprompt method with Aider. It highlights the necessity of using Aider's /code mode for the automatic execution of tool-generated bash commands.

Key changes include:

• A new "Important" warning regarding /code mode at the start of the section.
• A detailed step-by-step workflow including the use of the --yes flag and switching to /code mode.
• An explanation of common errors (e.g., "The LLM did not conform to the edit format") that occur when /code mode is omitted, helping users troubleshoot failed integrations.

These updates aim to improve the developer experience by preventing common setup errors and providing a clearer path to a working integration.

Fixes #16

---

PR Type

Documentation

---

Description

• Clarifies Aider /code mode requirement for toolprompt integration

• Adds step-by-step workflow with explicit mode switching instructions

• Documents common errors and troubleshooting guidance

• Explains why /code mode is necessary for bash command execution

---

Diagram Walkthrough

flowchart LR
  A["README Documentation"] -->|Add warning| B["Important /code mode notice"]
  A -->|Add workflow| C["Step-by-step instructions"]
  A -->|Add troubleshooting| D["Error explanation section"]
  C -->|Includes| E["Start Aider with --yes"]
  C -->|Includes| F["Switch to /code mode"]
  C -->|Includes| G["Run toolprompt command"]
  D -->|Explains| H["Edit format errors"]

Loading

File Walkthrough

Relevant files

Documentation

README.md Expand Aider integration docs with workflow and troubleshooting README.md Added prominent warning about /code mode requirement at section start Replaced simple command with detailed 4-step workflow including Aider startup with --yes flag and explicit /code mode switching Added new troubleshooting section documenting common errors and explaining why they occur Clarified that /code mode is necessary for automatic bash command execution +34/-9

---

[qodo-code-review]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🟡	🎫 #16 🟢 Prevent/clarify the error scenario where Aider reports "The LLM did not conform to the edit format" / "No filename provided before in file listing" when attempting toolprompt-based tool calls. Provide guidance on the correct Aider mode/flags/workflow needed for the integration (e.g., /code mode, --yes) so users can reliably run tools. 🔴 Enable successful tool usage so that the constructed command (e.g., mcpm-aider call @modelcontextprotocol/postgres query '{"sql":"..."}') is executed as expected when using Aider with toolprompt.
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
🟢	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[qodo-code-review]

PR Code Suggestions ✨

No code suggestions found for the PR.