@mjquinlan2000/lawmatics-mcp 0.1.3 → 0.1.4

package/README.md

@@ -1,41 +1,39 @@
 # @mjquinlan2000/lawmatics-mcp
 
-MCP server for the [Lawmatics](https://www.lawmatics.com/) legal CRM API. Exposes Lawmatics' REST API as MCP tools so AI assistants (Claude Desktop, etc.) can read data from Lawmatics accounts.
+MCP server for the [Lawmatics](https://www.lawmatics.com/) legal CRM API. Exposes Lawmatics' REST API as read-only MCP tools so AI assistants (Claude Desktop, etc.) can read data from Lawmatics accounts.
 
-## Installation
+## Quick Start
 
 ```sh
-npm install @mjquinlan2000/lawmatics-mcp
-# or run directly
-npx @mjquinlan2000/lawmatics-mcp
+LM_ACCESS_TOKEN=your_token npx @mjquinlan2000/lawmatics-mcp
 ```
 
-## Setup
+## Authentication
 
-### 1. Obtain API credentials
+### Option 1: Access token (simplest)
 
-Register an application in Lawmatics to get a client ID and secret.
+If you already have a Lawmatics access token, set it as an environment variable:
 
-### 2. Set environment variables
+```sh
+export LM_ACCESS_TOKEN=your_token
+```
+
+### Option 2: OAuth flow
+
+If you have OAuth2 client credentials, you can use the built-in auth CLI to obtain tokens:
 
 ```sh
 export LM_CLIENT_ID=your_client_id
 export LM_CLIENT_SECRET=your_client_secret
 export LM_REDIRECT_URI=http://127.0.0.1:8081/callback
-```
 
-### 3. Authenticate
-
-```sh
-# OAuth2 authorization (opens browser)
-yarn auth
+# Opens a browser for OAuth2 authorization
+npx @mjquinlan2000/lawmatics-mcp auth
 ```
 
-Tokens are persisted to `~/.config/lawmatics-mcp/tokens.json`.
-
-Alternatively, set `LM_ACCESS_TOKEN` directly to skip the OAuth flow.
+Tokens are saved to `~/.config/lawmatics-mcp/tokens.json`.
 
-> **Note:** Lawmatics does not support refresh tokens. When a token expires, run `yarn auth` again.
+> **Note:** Lawmatics does not support refresh tokens. When a token expires, you must re-run the `auth` command.
 
 ## MCP Client Configuration
 
@@ -48,25 +46,7 @@ Add to your MCP client config (e.g. Claude Desktop `claude_desktop_config.json`)
       "command": "npx",
       "args": ["@mjquinlan2000/lawmatics-mcp"],
       "env": {
-        "LM_CLIENT_ID": "your_client_id",
-        "LM_CLIENT_SECRET": "your_client_secret"
-      }
-    }
-  }
-}
-```
-
-For local development with `tsx`:
-
-```json
-{
-  "mcpServers": {
-    "lawmatics": {
-      "command": "tsx",
-      "args": ["src/server.ts"],
-      "env": {
-        "LM_CLIENT_ID": "${LM_CLIENT_ID}",
-        "LM_CLIENT_SECRET": "${LM_CLIENT_SECRET}"
+        "LM_ACCESS_TOKEN": "your_token"
       }
     }
   }
@@ -115,22 +95,52 @@ The server registers 86 read-only tools covering all Lawmatics GET endpoints. Re
 | Activities | `list_activities`, `get_activity` |
 | Users | `list_users`, `get_user`, `get_me` |
 
-## Development
+## Local Development
 
 ```sh
-yarn start          # Run server locally (stdio transport)
-yarn build          # Bundle with tsup
-yarn typecheck      # Type-check with tsc --noEmit
-yarn auth           # Run OAuth2 flow
-yarn generate       # Sanitize spec + regenerate typed client
+git clone https://github.com/mjquinlan2000/node-mcps.git
+cd node-mcps
+yarn install
+yarn build
+
+# Run the server locally
+yarn workspace @mjquinlan2000/lawmatics-mcp start
+
+# Run tests
+yarn workspace @mjquinlan2000/lawmatics-mcp test
+yarn workspace @mjquinlan2000/lawmatics-mcp test:watch
+
+# Regenerate typed client from API spec
+yarn workspace @mjquinlan2000/lawmatics-mcp generate
+```
+
+For local dev with an MCP client, use `tsx` directly:
+
+```json
+{
+  "mcpServers": {
+    "lawmatics": {
+      "command": "tsx",
+      "args": ["/path/to/node-mcps/lawmatics-mcp/src/server.ts"],
+      "env": {
+        "LM_ACCESS_TOKEN": "your_token"
+      }
+    }
+  }
+}
 ```
 
 ## Project Structure
 
 ```
 src/
-├── server.ts       # MCP server entry point — registers all tools
-├── auth.ts         # OAuth2 config (delegates to shared oauth utility)
-├── lm.ts           # Configures generated HTTP client with base URL + auth
-└── client/         # Auto-generated typed API client (do not edit)
+├── server.ts              # Entry point — CLI dispatch (server vs auth)
+├── create-server.ts       # MCP server setup — registers all tools
+├── tool-handler.ts        # Generic tool handler factory
+├── helpers.ts             # Utility functions
+├── auth.ts                # OAuth2 config (delegates to shared oauth utility)
+├── lm.ts                  # Configures generated HTTP client with base URL + auth
+├── client/                # Auto-generated typed API client (do not edit)
+├── *.test.ts              # Tests
+└── ...
 ```