114 lines
5.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Interactive Feedback MCP
Developed by Fábio Ferreira ([@fabiomlferreira](https://x.com/fabiomlferreira)).
Check out [dotcursorrules.com](https://dotcursorrules.com/) for more AI development enhancements.
Simple [MCP Server](https://modelcontextprotocol.io/) to enable a human-in-the-loop workflow in AI-assisted development tools like [Cursor](https://www.cursor.com). This server allows you to run commands, view their output, and provide textual feedback directly to the AI. It is also compatible with [Cline](https://cline.bot) and [Windsurf](https://windsurf.com).
![Interactive Feedback UI - Main View](https://github.com/noopstudios/interactive-feedback-mcp/blob/main/.github/interactive_feedback_1.jpg?raw=true)
![Interactive Feedback UI - Command Section Open](https://github.com/noopstudios/interactive-feedback-mcp/blob/main/.github/interactive_feedback_2.jpg)
## Prompt Engineering
For the best results, add the following to your custom prompt in your AI assistant, you should add it on a rule or directly in the prompt (e.g., Cursor):
> Whenever you want to ask a question, always call the MCP interactive_feedback.
> Whenever youre about to complete a user request, call the MCP interactive_feedback instead of simply ending the process.
This will ensure your AI assistant uses this MCP server to request user feedback before marking the task as completed.
## Configuration
This MCP server uses Qt's `QSettings` to store configuration on a per-project basis. This includes:
* The command to run.
* Whether to execute the command automatically on the next startup for that project (see "Execute automatically on next run" checkbox).
* The visibility state (shown/hidden) of the command section (this is saved immediately when toggled).
* Window geometry and state (general UI preferences).
These settings are typically stored in platform-specific locations (e.g., registry on Windows, plist files on macOS, configuration files in `~/.config` or `~/.local/share` on Linux) under an organization name "FabioFerreira" and application name "InteractiveFeedbackMCP", with a unique group for each project directory.
The "Save Configuration" button in the UI primarily saves the current command typed into the command input field and the state of the "Execute automatically on next run" checkbox for the active project. The visibility of the command section is saved automatically when you toggle it. General window size and position are saved when the application closes.
## Installation (Cursor)
![Instalation on Cursor](https://github.com/noopstudios/interactive-feedback-mcp/blob/main/.github/cursor-example.jpg?raw=true)
1. **Prerequisites:**
* Python 3.11 or newer.
* [uv](https://github.com/astral-sh/uv) (Python package manager). Install it with:
* Windows: `pip install uv`
* Linux/Mac: `curl -LsSf https://astral.sh/uv/install.sh | sh`
2. **Get the code:**
* Clone this repository:
`git clone https://github.com/noopstudios/interactive-feedback-mcp.git`
* Or download the source code.
3. **Navigate to the directory:**
* `cd path/to/interactive-feedback-mcp`
4. **Install dependencies:**
* `uv sync` (this creates a virtual environment and installs packages)
5. **Run the MCP Server:**
* `uv run server.py`
6. **Configure in Cursor:**
* Cursor typically allows specifying custom MCP servers in its settings. You'll need to point Cursor to this running server. The exact mechanism might vary, so consult Cursor's documentation for adding custom MCPs.
* **Manual Configuration (e.g., via `mcp.json`)**
**Remember to change the `/Users/fabioferreira/Dev/scripts/interactive-feedback-mcp` path to the actual path where you cloned the repository on your system.**
```json
{
"mcpServers": {
"interactive-feedback-mcp": {
"command": "uv",
"args": [
"--directory",
"/Users/fabioferreira/Dev/scripts/interactive-feedback-mcp",
"run",
"server.py"
],
"timeout": 600,
"autoApprove": [
"interactive_feedback"
]
}
}
}
```
* You might use a server identifier like `interactive-feedback-mcp` when configuring it in Cursor.
### For Cline / Windsurf
Similar setup principles apply. You would configure the server command (e.g., `uv run server.py` with the correct `--directory` argument pointing to the project directory) in the respective tool's MCP settings, using `interactive-feedback-mcp` as the server identifier.
## Development
To run the server in development mode with a web interface for testing:
```sh
uv run fastmcp dev server.py
```
This will open a web interface and allow you to interact with the MCP tools for testing.
## Available tools
Here's an example of how the AI assistant would call the `interactive_feedback` tool:
```xml
<use_mcp_tool>
<server_name>interactive-feedback-mcp</server_name>
<tool_name>interactive_feedback</tool_name>
<arguments>
{
"project_directory": "/path/to/your/project",
"summary": "I've implemented the changes you requested and refactored the main module."
}
</arguments>
</use_mcp_tool>
```
## Acknowledgements & Contact
If you find this Interactive Feedback MCP useful, the best way to show appreciation is by following Fábio Ferreira on [X @fabiomlferreira](https://x.com/fabiomlferreira).
For any questions, suggestions, or if you just want to share how you're using it, feel free to reach out on X!
Also, check out [dotcursorrules.com](https://dotcursorrules.com/) for more resources on enhancing your AI-assisted development workflow.