@klitchevo/code-council 0.0.1 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -28
- package/dist/index.d.ts +0 -6
- package/dist/index.js +627 -57
- package/package.json +4 -3
- package/dist/config.d.ts +0 -48
- package/dist/config.d.ts.map +0 -1
- package/dist/config.js +0 -61
- package/dist/constants.d.ts +0 -33
- package/dist/constants.d.ts.map +0 -1
- package/dist/constants.js +0 -36
- package/dist/errors.d.ts +0 -53
- package/dist/errors.d.ts.map +0 -1
- package/dist/errors.js +0 -92
- package/dist/index.d.ts.map +0 -1
- package/dist/logger.d.ts +0 -22
- package/dist/logger.d.ts.map +0 -1
- package/dist/logger.js +0 -62
- package/dist/prompts/backend-review.d.ts +0 -6
- package/dist/prompts/backend-review.d.ts.map +0 -1
- package/dist/prompts/backend-review.js +0 -28
- package/dist/prompts/code-review.d.ts +0 -6
- package/dist/prompts/code-review.d.ts.map +0 -1
- package/dist/prompts/code-review.js +0 -18
- package/dist/prompts/frontend-review.d.ts +0 -6
- package/dist/prompts/frontend-review.d.ts.map +0 -1
- package/dist/prompts/frontend-review.js +0 -28
- package/dist/prompts/plan-review.d.ts +0 -6
- package/dist/prompts/plan-review.d.ts.map +0 -1
- package/dist/prompts/plan-review.js +0 -29
- package/dist/review-client.d.ts +0 -75
- package/dist/review-client.d.ts.map +0 -1
- package/dist/review-client.js +0 -116
- package/dist/schemas.d.ts +0 -60
- package/dist/schemas.d.ts.map +0 -1
- package/dist/schemas.js +0 -46
- package/dist/tools/factory.d.ts +0 -20
- package/dist/tools/factory.d.ts.map +0 -1
- package/dist/tools/factory.js +0 -55
- package/dist/tools/list-config.d.ts +0 -9
- package/dist/tools/list-config.d.ts.map +0 -1
- package/dist/tools/list-config.js +0 -31
- package/dist/tools/review-backend.d.ts +0 -22
- package/dist/tools/review-backend.d.ts.map +0 -1
- package/dist/tools/review-backend.js +0 -38
- package/dist/tools/review-code.d.ts +0 -15
- package/dist/tools/review-code.d.ts.map +0 -1
- package/dist/tools/review-code.js +0 -29
- package/dist/tools/review-frontend.d.ts +0 -22
- package/dist/tools/review-frontend.d.ts.map +0 -1
- package/dist/tools/review-frontend.js +0 -38
- package/dist/tools/review-plan.d.ts +0 -22
- package/dist/tools/review-plan.d.ts.map +0 -1
- package/dist/tools/review-plan.js +0 -35
- package/dist/utils/parallel-executor.d.ts +0 -10
- package/dist/utils/parallel-executor.d.ts.map +0 -1
- package/dist/utils/parallel-executor.js +0 -21
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Code Council
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/code-council)
|
|
3
|
+
[](https://www.npmjs.com/package/@klitchevo/code-council)
|
|
4
4
|
[](https://opensource.org/licenses/MIT)
|
|
5
5
|
[](https://github.com/klitchevo/code-council/actions)
|
|
6
6
|
[](https://codecov.io/gh/klitchevo/code-council)
|
|
@@ -32,7 +32,7 @@ Add to your `claude_desktop_config.json`:
|
|
|
32
32
|
"mcpServers": {
|
|
33
33
|
"code-council": {
|
|
34
34
|
"command": "npx",
|
|
35
|
-
"args": ["-y", "code-council"],
|
|
35
|
+
"args": ["-y", "@klitchevo/code-council"],
|
|
36
36
|
"env": {
|
|
37
37
|
"OPENROUTER_API_KEY": "your-api-key-here"
|
|
38
38
|
}
|
|
@@ -48,12 +48,12 @@ Add to your `claude_desktop_config.json`:
|
|
|
48
48
|
"mcpServers": {
|
|
49
49
|
"code-council": {
|
|
50
50
|
"command": "npx",
|
|
51
|
-
"args": ["-y", "code-council"],
|
|
51
|
+
"args": ["-y", "@klitchevo/code-council"],
|
|
52
52
|
"env": {
|
|
53
53
|
"OPENROUTER_API_KEY": "your-api-key-here",
|
|
54
|
-
"CODE_REVIEW_MODELS": ["anthropic/claude-
|
|
55
|
-
"FRONTEND_REVIEW_MODELS": ["anthropic/claude-
|
|
56
|
-
"BACKEND_REVIEW_MODELS": ["openai/gpt-
|
|
54
|
+
"CODE_REVIEW_MODELS": ["anthropic/claude-sonnet-4.5", "openai/gpt-4o"],
|
|
55
|
+
"FRONTEND_REVIEW_MODELS": ["anthropic/claude-sonnet-4.5"],
|
|
56
|
+
"BACKEND_REVIEW_MODELS": ["openai/gpt-4o", "google/gemini-2.0-flash-exp"]
|
|
57
57
|
}
|
|
58
58
|
}
|
|
59
59
|
}
|
|
@@ -69,7 +69,7 @@ Add to your Cursor MCP settings (`.cursor/mcp.json` or similar):
|
|
|
69
69
|
"mcpServers": {
|
|
70
70
|
"code-council": {
|
|
71
71
|
"command": "npx",
|
|
72
|
-
"args": ["-y", "code-council"],
|
|
72
|
+
"args": ["-y", "@klitchevo/code-council"],
|
|
73
73
|
"env": {
|
|
74
74
|
"OPENROUTER_API_KEY": "your-api-key-here"
|
|
75
75
|
}
|
|
@@ -85,7 +85,7 @@ For any MCP client that supports environment variables:
|
|
|
85
85
|
```json
|
|
86
86
|
{
|
|
87
87
|
"command": "npx",
|
|
88
|
-
"args": ["-y", "code-council"],
|
|
88
|
+
"args": ["-y", "@klitchevo/code-council"],
|
|
89
89
|
"env": {
|
|
90
90
|
"OPENROUTER_API_KEY": "your-openrouter-api-key"
|
|
91
91
|
}
|
|
@@ -97,7 +97,7 @@ For any MCP client that supports environment variables:
|
|
|
97
97
|
If you prefer to install globally:
|
|
98
98
|
|
|
99
99
|
```bash
|
|
100
|
-
npm install -g code-council
|
|
100
|
+
npm install -g @klitchevo/code-council
|
|
101
101
|
```
|
|
102
102
|
|
|
103
103
|
Then configure without npx:
|
|
@@ -106,7 +106,7 @@ Then configure without npx:
|
|
|
106
106
|
{
|
|
107
107
|
"mcpServers": {
|
|
108
108
|
"code-council": {
|
|
109
|
-
"command": "code-council",
|
|
109
|
+
"command": "@klitchevo/code-council",
|
|
110
110
|
"env": {
|
|
111
111
|
"OPENROUTER_API_KEY": "your-api-key-here"
|
|
112
112
|
}
|
|
@@ -124,17 +124,49 @@ Then configure without npx:
|
|
|
124
124
|
|
|
125
125
|
## Security Best Practices
|
|
126
126
|
|
|
127
|
-
⚠️ **
|
|
127
|
+
⚠️ **CRITICAL SECURITY WARNING**: Never commit your OpenRouter API key to git!
|
|
128
128
|
|
|
129
|
-
###
|
|
130
|
-
- Store the API key in the `env` section of your MCP client configuration
|
|
131
|
-
- The key stays in your local config file and is never committed to version control
|
|
132
|
-
- Each MCP client isolates environment variables per server
|
|
129
|
+
### MCP Config File Locations (Safe - Not in Git)
|
|
133
130
|
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
-
|
|
131
|
+
MCP client configurations are stored **outside your project directory** and won't be committed:
|
|
132
|
+
|
|
133
|
+
- **Claude Desktop**:
|
|
134
|
+
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
135
|
+
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
136
|
+
- Linux: `~/.config/Claude/claude_desktop_config.json`
|
|
137
|
+
- **Cursor**: Global settings (not in project)
|
|
138
|
+
- **Other MCP Clients**: Typically in user config directories
|
|
139
|
+
|
|
140
|
+
These files are **safe to put your API key in** because they're not in your git repository.
|
|
141
|
+
|
|
142
|
+
### ✅ SAFE:
|
|
143
|
+
- Putting the API key in MCP client config files (they're outside git)
|
|
144
|
+
- Using system environment variables and referencing them
|
|
145
|
+
- Keeping configs in user directories (`~/.config/`, `~/Library/`, etc.)
|
|
146
|
+
|
|
147
|
+
### ❌ NEVER DO:
|
|
148
|
+
- Don't create `.mcp.json` or config files **inside your project directory**
|
|
149
|
+
- Don't commit any file containing your API key to git
|
|
137
150
|
- Don't share config files containing API keys
|
|
151
|
+
- Don't hardcode API keys in code
|
|
152
|
+
|
|
153
|
+
### Using Environment Variables (Extra Security)
|
|
154
|
+
|
|
155
|
+
For added security, store the key in your shell environment:
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
# Add to ~/.zshrc or ~/.bashrc
|
|
159
|
+
export OPENROUTER_API_KEY="sk-or-v1-..."
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
Then reference it in your MCP config:
|
|
163
|
+
```json
|
|
164
|
+
{
|
|
165
|
+
"env": {
|
|
166
|
+
"OPENROUTER_API_KEY": "${OPENROUTER_API_KEY}"
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
```
|
|
138
170
|
|
|
139
171
|
## Available Tools
|
|
140
172
|
|
|
@@ -211,11 +243,17 @@ Show which AI models are currently configured for each review type.
|
|
|
211
243
|
You can customize which AI models are used for reviews by setting environment variables in your MCP client configuration. Each review type can use different models.
|
|
212
244
|
|
|
213
245
|
**Available Environment Variables:**
|
|
246
|
+
|
|
247
|
+
**Model Configuration:**
|
|
214
248
|
- `CODE_REVIEW_MODELS` - Models for general code reviews
|
|
215
249
|
- `FRONTEND_REVIEW_MODELS` - Models for frontend reviews
|
|
216
250
|
- `BACKEND_REVIEW_MODELS` - Models for backend reviews
|
|
217
251
|
- `PLAN_REVIEW_MODELS` - Models for plan reviews
|
|
218
252
|
|
|
253
|
+
**LLM Parameters:**
|
|
254
|
+
- `TEMPERATURE` - Response temperature (0.0-2.0, default: 0.3)
|
|
255
|
+
- `MAX_TOKENS` - Maximum response tokens (default: 16384)
|
|
256
|
+
|
|
219
257
|
**Format:** Array of strings (JSON array)
|
|
220
258
|
|
|
221
259
|
**Example:**
|
|
@@ -224,12 +262,12 @@ You can customize which AI models are used for reviews by setting environment va
|
|
|
224
262
|
"mcpServers": {
|
|
225
263
|
"code-council": {
|
|
226
264
|
"command": "npx",
|
|
227
|
-
"args": ["-y", "code-council"],
|
|
265
|
+
"args": ["-y", "@klitchevo/code-council"],
|
|
228
266
|
"env": {
|
|
229
267
|
"OPENROUTER_API_KEY": "your-api-key",
|
|
230
|
-
"CODE_REVIEW_MODELS": ["anthropic/claude-
|
|
231
|
-
"FRONTEND_REVIEW_MODELS": ["anthropic/claude-
|
|
232
|
-
"BACKEND_REVIEW_MODELS": ["openai/gpt-
|
|
268
|
+
"CODE_REVIEW_MODELS": ["anthropic/claude-sonnet-4.5", "openai/gpt-4o", "google/gemini-2.0-flash-exp"],
|
|
269
|
+
"FRONTEND_REVIEW_MODELS": ["anthropic/claude-sonnet-4.5"],
|
|
270
|
+
"BACKEND_REVIEW_MODELS": ["openai/gpt-4o", "anthropic/claude-sonnet-4.5"]
|
|
233
271
|
}
|
|
234
272
|
}
|
|
235
273
|
}
|
|
@@ -243,12 +281,11 @@ If you don't specify models, the server uses these defaults:
|
|
|
243
281
|
|
|
244
282
|
**Finding Models:**
|
|
245
283
|
Browse all available models at [OpenRouter Models](https://openrouter.ai/models). Popular choices include:
|
|
246
|
-
- `anthropic/claude-
|
|
247
|
-
- `
|
|
248
|
-
- `
|
|
249
|
-
- `
|
|
250
|
-
- `
|
|
251
|
-
- `minimax/minimax-m2.1` - Good balance of speed and quality
|
|
284
|
+
- `anthropic/claude-sonnet-4.5` - Latest Sonnet, excellent for code review
|
|
285
|
+
- `anthropic/claude-opus-4.5` - Frontier reasoning model for complex tasks
|
|
286
|
+
- `openai/gpt-4o` - Latest GPT-4 Omni model
|
|
287
|
+
- `google/gemini-2.0-flash-exp` - Fast and affordable
|
|
288
|
+
- `meta-llama/llama-3.3-70b-instruct` - Latest open source option
|
|
252
289
|
|
|
253
290
|
### Local Development
|
|
254
291
|
|