Skip to content

Commit a8faee1

Browse files
author
Zvi Fried
committed
feat/general-refinement - Improve README documentation structure
- Remove Technical Prerequisites section - Update AI assistants section to show only supported ones in clean table format - Change Critical Requirements to MCP Client Prerequisites with bold formatting - Convert Five Powerful Judge Tools to List of Tools with tools emoji - Reorganize tools section as a clean table with tool names and descriptions - Streamline documentation for better readability and focus
1 parent 8b4da37 commit a8faee1

File tree

1 file changed

+20
-56
lines changed

1 file changed

+20
-56
lines changed

README.md

Lines changed: 20 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
- 🔍 **Enforcing research and best practices** before implementation
2626
- ⚖️ **Creating a collaborative AI-human workflow** for better software quality
2727

28-
## 😌 **Vibe Coding doesn't have to be frustrating**
28+
## **Vibe Coding doesn't have to be frustrating**
2929

3030
### **What It Enforces:**
3131

@@ -59,33 +59,35 @@
5959
- **No hidden fallbacks** - transparent decision making
6060
- **Interactive problem solving** with real-time user input
6161

62-
### **⚖️ Five Powerful Judge Tools**
62+
### **🛠️ List of Tools**
6363

64-
1. **`get_workflow_guidance`** - Smart workflow analysis and tool recommendation
65-
2. **`judge_coding_plan`** - Comprehensive plan evaluation with requirements alignment
66-
3. **`judge_code_change`** - Code review with security and quality checks
67-
4. **`raise_obstacle`** - User involvement when blockers arise
68-
5. **`elicit_missing_requirements`** - Clarification of unclear requests
64+
| Tool Name | Description |
65+
|-----------|-------------|
66+
| **`get_workflow_guidance`** | Smart workflow analysis and tool recommendation |
67+
| **`judge_coding_plan`** | Comprehensive plan evaluation with requirements alignment |
68+
| **`judge_code_change`** | Code review with security and quality checks |
69+
| **`raise_obstacle`** | User involvement when blockers arise |
70+
| **`elicit_missing_requirements`** | Clarification of unclear requests |
6971

7072
## 🚀 **Quick Start**
7173

7274
### **Requirements & Recommendations**
7375

74-
#### **⚠️ Critical Requirements**
76+
#### **MCP Client Prerequisites**
7577

7678
MCP as a Judge is heavily dependent on **MCP Sampling** and **MCP Elicitation** features for its core functionality:
7779

7880
- **[MCP Sampling](https://modelcontextprotocol.io/docs/learn/client-concepts#sampling)** - Required for AI-powered code evaluation and judgment
7981
- **[MCP Elicitation](https://modelcontextprotocol.io/docs/learn/client-concepts#elicitation)** - Required for interactive user decision prompts
8082

81-
#### **🔧 Supported AI Assistants**
83+
#### **Supported AI Assistants**
8284

83-
Currently, **GitHub Copilot in VS Code** is the only AI assistant that fully supports these MCP features. Other coding assistants and other versions of GitHub Copilot are not supported at this time.
85+
| AI Assistant | Platform | MCP Support | Status | Notes |
86+
|---------------|----------|-------------|---------|-------|
87+
| **GitHub Copilot** | Visual Studio Code | ✅ Full | **Recommended** | Complete MCP integration with tool calling |
8488

85-
#### **📋 Technical Prerequisites**
89+
**✅ Recommended Setup:** GitHub Copilot in Visual Studio Code for the best MCP as a Judge experience.
8690

87-
- Python 3.12+ (latest secure version)
88-
- GitHub Copilot with MCP support enabled
8991

9092
#### **💡 Recommendations**
9193

@@ -133,19 +135,19 @@ uv sync --all-extras --dev
133135
uv run mcp-as-a-judge
134136
```
135137

136-
## 🔧 **VS Code Configuration**
138+
## 🔧 **Visual Studio Code Configuration**
137139

138-
Configure MCP as a Judge in VS Code with GitHub Copilot:
140+
Configure MCP as a Judge in Visual Studio Code with GitHub Copilot:
139141

140142
1. **Install the package:**
141143

142144
```bash
143145
uv add mcp-as-a-judge
144146
```
145147

146-
2. **Configure VS Code MCP settings:**
148+
2. **Configure Visual Studio Code MCP settings:**
147149

148-
Add this to your VS Code MCP configuration file:
150+
Add this to your Visual Studio Code MCP configuration file:
149151

150152
```json
151153
{
@@ -158,48 +160,10 @@ Configure MCP as a Judge in VS Code with GitHub Copilot:
158160
}
159161
```
160162

161-
### **📍 VS Code MCP Configuration Location**
162-
163-
The MCP configuration file is typically located at:
164-
165-
- **Windows**: `%APPDATA%\Code\User\globalStorage\github.copilot-chat\mcp.json`
166-
- **macOS**: `~/Library/Application Support/Code/User/globalStorage/github.copilot-chat/mcp.json`
167-
- **Linux**: `~/.config/Code/User/globalStorage/github.copilot-chat/mcp.json`
168-
169-
### **🔄 Restart VS Code**
170-
171-
After adding the configuration, restart VS Code to load the MCP server.
172-
173-
#### **Environment Variables**
174-
175-
**Available Environment Variables:**
176-
177-
```bash
178-
# Transport Configuration
179-
TRANSPORT=sse # Options: "stdio" or "sse"
180-
HOST=0.0.0.0 # Server host (SSE only)
181-
PORT=8050 # Server port (SSE only)
182-
183-
# Logging
184-
LOG_LEVEL=INFO # Options: DEBUG, INFO, WARNING, ERROR
185-
LOG_FORMAT=json # Options: json, text
186-
187-
# Development
188-
DEBUG=false # Enable debug mode
189-
DEVELOPMENT_MODE=false # Enable development features
190-
191-
# Performance
192-
MAX_CONCURRENT_REQUESTS=10 # Maximum concurrent requests
193-
REQUEST_TIMEOUT=30 # Request timeout in seconds
194-
195-
# Security
196-
CORS_ENABLED=false # Enable CORS (production: false)
197-
CORS_ORIGINS=* # CORS allowed origins
198-
```
199163

200164
## 📖 **How It Works**
201165

202-
Once MCP as a Judge is configured in VS Code with GitHub Copilot, it automatically guides your AI assistant through a structured software engineering workflow. The system operates transparently in the background, ensuring every development task follows best practices.
166+
Once MCP as a Judge is configured in Visual Studio Code with GitHub Copilot, it automatically guides your AI assistant through a structured software engineering workflow. The system operates transparently in the background, ensuring every development task follows best practices.
203167

204168
### **🔄 Automatic Workflow Enforcement**
205169

0 commit comments

Comments
 (0)