lexic-mcp 0.1.9 → 0.1.11

package/README.md

@@ -25,7 +25,21 @@ npm install
 npm run build
 ```
 
-### 2. Get a PAT from Lexic
+### 2. Authenticate
+
+**Option A: OAuth (Recommended)**
+
+The simplest way to authenticate - no tokens to manage:
+
+```bash
+lexic-mcp login
+```
+
+This opens your browser to authenticate with Lexic. Your credentials are stored securely and refreshed automatically.
+
+**Option B: Personal Access Token (PAT)**
+
+For CI/CD or environments without browser access:
 
 1. Log into [Lexic](https://lexic.io)
 2. Go to Settings → API Tokens
@@ -34,28 +48,25 @@ npm run build
 
 ### 3. Configure Claude Code
 
-Add to your Claude Code settings (`~/.config/claude/settings.json`):
+**With OAuth (after running `lexic-mcp login`):**
 
 ```json
 {
   "mcpServers": {
     "lexic": {
-      "command": "lexic-mcp",
-      "env": {
-        "LEXIC_PAT": "pat_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-      }
+      "command": "lexic-mcp"
     }
   }
 }
 ```
 
-Or if running from source:
+**With PAT:**
+
 ```json
 {
   "mcpServers": {
     "lexic": {
-      "command": "node",
-      "args": ["/path/to/lexic-mcp/dist/index.js"],
+      "command": "lexic-mcp",
       "env": {
         "LEXIC_PAT": "pat_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
       }
@@ -171,15 +182,29 @@ Lexic API side. This server's responsibilities are:
 2. Forward tool calls to API
 3. Return responses unchanged (preserving _meta)
 
+## CLI Commands
+
+```bash
+lexic-mcp login     # Authenticate via browser OAuth flow
+lexic-mcp logout    # Clear stored credentials
+lexic-mcp status    # Show authentication status
+lexic-mcp version   # Show version
+lexic-mcp           # Start MCP server (default)
+```
+
 ## Environment Variables
 
 | Variable | Required | Default | Description |
 |----------|----------|---------|-------------|
-| `LEXIC_PAT` | Yes | - | Personal Access Token |
+| `LEXIC_PAT` | No* | - | Personal Access Token (alternative to OAuth) |
 | `LEXIC_API_URL` | No | `https://api.lexic.io/api` | Lexic API base URL |
 | `LOG_LEVEL` | No | `info` | Logging level (debug, info, warn, error) |
 
-> **Note**: Domains are determined by the API based on your PAT permissions. No local domain configuration is needed.
+\* Either OAuth credentials (via `lexic-mcp login`) or `LEXIC_PAT` is required.
+
+> **Note**: Domains are determined by the API based on your authentication. No local domain configuration is needed.
+
+For advanced OAuth deployment options (HTTP transport, remote servers), see [docs/oauth.md](docs/oauth.md).
 
 ## Customizing Templates
 
@@ -209,7 +234,8 @@ npm run dev
 
 ### "Invalid or expired token"
 
-Your PAT has expired (max 30 days). Generate a new one in Lexic.
+- **With OAuth**: Run `lexic-mcp login` to re-authenticate
+- **With PAT**: Generate a new token in Lexic (PATs expire after 30 days)
 
 ### "Failed to connect to Lexic"
 
@@ -220,6 +246,14 @@ Check that the Lexic API is accessible. If using a self-hosted instance, verify
 1. Restart Claude Code after changing settings
 2. Check server logs: `LOG_LEVEL=debug lexic-mcp`
 
+### Check authentication status
+
+```bash
+lexic-mcp status
+```
+
+This shows your current authentication method and whether credentials are valid.
+
 ## License
 
 MIT