@klitchevo/code-council 0.0.1 → 0.0.2

package/README.md

@@ -1,6 +1,6 @@
 # Code Council
 
-[![npm version](https://img.shields.io/npm/v/code-council.svg)](https://www.npmjs.com/package/code-council)
+[![npm version](https://img.shields.io/npm/v/@klitchevo/code-council.svg)](https://www.npmjs.com/package/@klitchevo/code-council)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![CI](https://github.com/klitchevo/code-council/workflows/CI/badge.svg)](https://github.com/klitchevo/code-council/actions)
 [![codecov](https://codecov.io/gh/klitchevo/code-council/branch/main/graph/badge.svg)](https://codecov.io/gh/klitchevo/code-council)
@@ -32,7 +32,7 @@ Add to your `claude_desktop_config.json`:
   "mcpServers": {
     "code-council": {
       "command": "npx",
-      "args": ["-y", "code-council"],
+      "args": ["-y", "@klitchevo/code-council"],
       "env": {
         "OPENROUTER_API_KEY": "your-api-key-here"
       }
@@ -48,7 +48,7 @@ Add to your `claude_desktop_config.json`:
   "mcpServers": {
     "code-council": {
       "command": "npx",
-      "args": ["-y", "code-council"],
+      "args": ["-y", "@klitchevo/code-council"],
       "env": {
         "OPENROUTER_API_KEY": "your-api-key-here",
         "CODE_REVIEW_MODELS": ["anthropic/claude-3.5-sonnet", "openai/gpt-4-turbo"],
@@ -69,7 +69,7 @@ Add to your Cursor MCP settings (`.cursor/mcp.json` or similar):
   "mcpServers": {
     "code-council": {
       "command": "npx",
-      "args": ["-y", "code-council"],
+      "args": ["-y", "@klitchevo/code-council"],
       "env": {
         "OPENROUTER_API_KEY": "your-api-key-here"
       }
@@ -85,7 +85,7 @@ For any MCP client that supports environment variables:
 ```json
 {
   "command": "npx",
-  "args": ["-y", "code-council"],
+  "args": ["-y", "@klitchevo/code-council"],
   "env": {
     "OPENROUTER_API_KEY": "your-openrouter-api-key"
   }
@@ -97,7 +97,7 @@ For any MCP client that supports environment variables:
 If you prefer to install globally:
 
 ```bash
-npm install -g code-council
+npm install -g @klitchevo/code-council
 ```
 
 Then configure without npx:
@@ -106,7 +106,7 @@ Then configure without npx:
 {
   "mcpServers": {
     "code-council": {
-      "command": "code-council",
+      "command": "@klitchevo/code-council",
       "env": {
         "OPENROUTER_API_KEY": "your-api-key-here"
       }
@@ -124,17 +124,49 @@ Then configure without npx:
 
 ## Security Best Practices
 
-⚠️ **IMPORTANT**: Always provide your API key via environment variables in the MCP configuration, NOT in a `.env` file or hardcoded in config files.
+⚠️ **CRITICAL SECURITY WARNING**: Never commit your OpenRouter API key to git!
 
-### ✅ DO:
-- Store the API key in the `env` section of your MCP client configuration
-- The key stays in your local config file and is never committed to version control
-- Each MCP client isolates environment variables per server
+### MCP Config File Locations (Safe - Not in Git)
 
-### ❌ DON'T:
-- Don't put the API key directly in `.mcp.json` or similar config files
-- Don't commit API keys to git repositories
+MCP client configurations are stored **outside your project directory** and won't be committed:
+
+- **Claude Desktop**:
+  - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
+  - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
+  - Linux: `~/.config/Claude/claude_desktop_config.json`
+- **Cursor**: Global settings (not in project)
+- **Other MCP Clients**: Typically in user config directories
+
+These files are **safe to put your API key in** because they're not in your git repository.
+
+### ✅ SAFE:
+- Putting the API key in MCP client config files (they're outside git)
+- Using system environment variables and referencing them
+- Keeping configs in user directories (`~/.config/`, `~/Library/`, etc.)
+
+### ❌ NEVER DO:
+- Don't create `.mcp.json` or config files **inside your project directory**
+- Don't commit any file containing your API key to git
 - Don't share config files containing API keys
+- Don't hardcode API keys in code
+
+### Using Environment Variables (Extra Security)
+
+For added security, store the key in your shell environment:
+
+```bash
+# Add to ~/.zshrc or ~/.bashrc
+export OPENROUTER_API_KEY="sk-or-v1-..."
+```
+
+Then reference it in your MCP config:
+```json
+{
+  "env": {
+    "OPENROUTER_API_KEY": "${OPENROUTER_API_KEY}"
+  }
+}
+```
 
 ## Available Tools
 
@@ -224,7 +256,7 @@ You can customize which AI models are used for reviews by setting environment va
   "mcpServers": {
     "code-council": {
       "command": "npx",
-      "args": ["-y", "code-council"],
+      "args": ["-y", "@klitchevo/code-council"],
       "env": {
         "OPENROUTER_API_KEY": "your-api-key",
         "CODE_REVIEW_MODELS": ["anthropic/claude-3.5-sonnet", "openai/gpt-4-turbo", "google/gemini-pro"],

package/dist/index.d.ts

@@ -1,7 +1 @@
 #!/usr/bin/env node
-/**
- * Code Council MCP Server
- * Multi-model AI code review server using OpenRouter API
- */
-import "dotenv/config";
-//# sourceMappingURL=index.d.ts.map