@uniswap/ai-toolkit-claude-mcp-helper 0.0.1 → 0.0.2

package/README.md

@@ -1,45 +1,347 @@
-# @uniswap/ai-toolkit-claude-mcp-helper
+# MCP Config
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+**Package**: `@uniswap/ai-toolkit-claude-mcp-helper`
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+A standalone CLI tool to manage MCP (Model Context Protocol) servers for Claude Code workspaces.
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+## Features
 
-## Purpose
+- 📋 **List** all MCP servers with their enabled/disabled status
+- ✅ **Enable/Disable** servers individually or in bulk
+- 📊 **Status** view with detailed information
+- 🎯 **Interactive mode** with multi-select interface
+- 🔄 **Smart configuration** - local `.claude/settings.local.json` overrides global `~/.claude.json`
+- 🎨 **Colorized output** for better readability
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@uniswap/ai-toolkit-claude-mcp-helper`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+## Installation
 
-## What is OIDC Trusted Publishing?
+### Via npm (Recommended)
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+Install globally for easy access from anywhere:
 
-## Setup Instructions
+```bash
+npm install -g @uniswap/ai-toolkit-claude-mcp-helper
+```
 
-To properly configure OIDC trusted publishing for this package:
+Or use via npx without installation:
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
+```bash
+npx @uniswap/ai-toolkit-claude-mcp-helper list
+```
 
-## DO NOT USE THIS PACKAGE
+### Build from Source
 
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
+If you're developing or contributing to this package:
 
-## More Information
+```bash
+# From the ai-toolkit monorepo root
+npx nx build mcp-config
 
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
+# The executable will be at: packages/mcp-config/dist/mcp-config.cjs
+```
 
----
+### Set Up Shell Alias (Development)
 
-**Maintained for OIDC setup purposes only**
+Add an alias to your shell configuration for easy access from anywhere:
+
+#### Bash (~/.bashrc or ~/.bash_profile)
+
+```bash
+alias mcp-config="/absolute/path/to/ai-toolkit/packages/mcp-config/dist/mcp-config.cjs"
+```
+
+#### Zsh (~/.zshrc)
+
+```bash
+alias mcp-config="/absolute/path/to/ai-toolkit/packages/mcp-config/dist/mcp-config.cjs"
+```
+
+#### Fish (~/.config/fish/config.fish)
+
+```fish
+alias mcp-config="/absolute/path/to/ai-toolkit/packages/mcp-config/dist/mcp-config.cjs"
+```
+
+After adding the alias, reload your shell configuration:
+
+```bash
+# Bash/Zsh
+source ~/.zshrc  # or ~/.bashrc
+
+# Fish
+source ~/.config/fish/config.fish
+```
+
+## Usage
+
+### Interactive Mode (Recommended)
+
+Simply run `mcp-config` without arguments to enter interactive mode:
+
+```bash
+mcp-config
+```
+
+This will show a multi-select interface where you can:
+
+- Use ↑/↓ arrows to navigate
+- Press Space to toggle selection
+- Press 'a' to toggle all
+- Press Enter to save
+
+### List Servers
+
+View all MCP servers and their status:
+
+```bash
+mcp-config list
+```
+
+Output example:
+
+```text
+✓ Enabled Servers:
+  ✓ github
+  ✓ linear
+  ✓ notion
+
+✗ Disabled Servers:
+  ✗ chrome-devtools (local)
+  ✗ claude-historian (global)
+
+3 enabled, 2 disabled
+```
+
+### Enable Servers
+
+Enable one or more servers:
+
+```bash
+# Enable single server
+mcp-config enable github
+
+# Enable multiple servers
+mcp-config enable github linear notion
+```
+
+### Disable Servers
+
+Disable one or more servers:
+
+```bash
+# Disable single server
+mcp-config disable chrome-devtools
+
+# Disable multiple servers
+mcp-config disable chrome-devtools claude-historian
+```
+
+### Detailed Status
+
+Show comprehensive status information:
+
+```bash
+mcp-config status
+```
+
+## Configuration
+
+### How It Works
+
+MCP Config discovers MCP servers from multiple sources and manages their enabled/disabled state:
+
+#### MCP Server Sources
+
+1. **Global Config** (`~/.claude.json`)
+
+   - User-wide MCP server definitions in `mcpServers` object
+   - Accessible across all projects
+
+2. **Project-Specific Config** (`~/.claude.json` → `projects[cwd].mcpServers`)
+
+   - Project-specific MCP server definitions within global config
+   - Scoped to specific working directories
+
+3. **Project-Local Config** (`./.mcp.json`)
+   - Project-committed MCP server definitions
+   - Allows teams to share configurations via version control
+
+#### Enabled/Disabled State
+
+**Local Settings** (`./.claude/settings.local.json`)
+
+- Project-specific settings that control which discovered servers are enabled/disabled
+- `deniedMcpServers` array lists disabled servers
+- **Takes precedence over all server sources**
+
+### Configuration Priority
+
+- Servers are discovered from all three sources (global, project-specific, and .mcp.json)
+- Local settings in `.claude/settings.local.json` control enabled/disabled state
+- If a server is in `deniedMcpServers`, it's disabled regardless of where it was discovered
+- If a server is not in `deniedMcpServers`, it's enabled by default
+
+### DeniedMcpServers Format
+
+The `deniedMcpServers` array uses an **object format**:
+
+```json
+{
+  "deniedMcpServers": [
+    { "serverName": "chrome-devtools" },
+    { "serverName": "claude-historian" }
+  ]
+}
+```
+
+## Examples
+
+### Scenario: Disable a Server Locally
+
+You want to disable `chrome-devtools` only in the current project:
+
+```bash
+cd /path/to/your/project
+mcp-config disable chrome-devtools
+```
+
+This adds the server to `./.claude/settings.local.json`:
+
+```json
+{
+  "deniedMcpServers": [{ "serverName": "chrome-devtools" }]
+}
+```
+
+### Scenario: Enable All Servers in Project
+
+```bash
+mcp-config interactive
+# Select all servers (press 'a')
+# Press Enter to save
+```
+
+This removes all entries from `./.claude/settings.local.json.deniedMcpServers`.
+
+### Scenario: Share Team MCP Servers via .mcp.json
+
+Create a `.mcp.json` file in your project root to share MCP server configurations with your team:
+
+```json
+{
+  "mcpServers": {
+    "team-tool": {
+      "command": "npx",
+      "args": ["-y", "@your-org/team-mcp-server@latest"]
+    },
+    "project-specific": {
+      "command": "node",
+      "args": ["./scripts/mcp-server.js"]
+    }
+  }
+}
+```
+
+Commit this file to version control. Team members running `mcp-config` will see these servers alongside their personal global servers.
+
+### Scenario: Check What's Enabled
+
+```bash
+mcp-config list
+```
+
+Shows:
+
+- ✓ for enabled servers
+- ✗ for disabled servers
+- (local) or (global) indicator for disabled servers
+
+## Development
+
+### Project Structure
+
+```text
+packages/mcp-config/
+├── src/
+│   ├── index.ts              # CLI entry point
+│   ├── commands/
+│   │   ├── list.ts           # List command
+│   │   ├── enable.ts         # Enable command
+│   │   ├── disable.ts        # Disable command
+│   │   ├── status.ts         # Status command
+│   │   └── interactive.ts    # Interactive mode
+│   ├── config/
+│   │   ├── types.ts          # TypeScript interfaces
+│   │   ├── reader.ts         # Config reading logic
+│   │   └── writer.ts         # Config writing logic
+│   └── utils/
+│       └── display.ts        # Console output formatting
+├── package.json
+├── tsconfig.json
+└── README.md
+```
+
+### Building
+
+```bash
+npx nx build mcp-config
+```
+
+The build process:
+
+1. Compiles TypeScript to CommonJS
+2. Bundles all dependencies with esbuild
+3. Adds shebang (`#!/usr/bin/env node`)
+4. Makes output executable via postbuild script
+
+### Testing Locally
+
+```bash
+# Build
+npx nx build mcp-config
+
+# Run directly
+packages/mcp-config/dist/mcp-config.cjs list
+
+# Or use alias after setting it up
+mcp-config list
+```
+
+## Troubleshooting
+
+### "No MCP servers configured"
+
+This means your `~/.claude.json` doesn't have any `mcpServers` defined.
+
+**Solution**: Add MCP servers to your global config:
+
+```json
+{
+  "mcpServers": {
+    "github": {
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-github"]
+    },
+    "linear": {
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-linear"]
+    }
+  }
+}
+```
+
+### Changes Not Taking Effect
+
+Make sure you:
+
+1. Saved the configuration
+2. Restarted Claude Code
+3. Are in the correct directory (for local configs)
+
+### Permission Denied
+
+If you get permission errors when running the tool:
+
+```bash
+chmod +x packages/mcp-config/dist/mcp-config.cjs
+```