Improve README.md

Author: bnkwsk

DEVELOPMENT.md

@@ -0,0 +1,26 @@
+# Development
+
+This document outlines the development setup and workflow for the Readwise MCP server. Below you'll find instructions for setting up your development environment and configuring Claude for local development.
+
+## Getting started
+1. Install Git hooks: `uvx pre-commit install`.
+2. Run `npm run dev`.
+3. Use the following Claude config:
+```
+{
+  "mcpServers": {
+    "Readwise MCP": {
+      "command": "node",
+      "args": [
+        "/path/to/your/readwise-mcp/build/index.js"
+      ],
+      "env": {
+        "BASE_URL": "https://local.readwise.io:8000",
+        "NODE_TLS_REJECT_UNAUTHORIZED": "0",
+        "ACCESS_TOKEN": "XXXXXXXXX"
+      }
+    }
+  }
+}
+```
+4. Remember to restart Claude after each modification to the code.

README.md

@@ -10,6 +10,7 @@ This project is a local [MCP server](https://spec.modelcontextprotocol.io) desig
 
 ## Installation in Claude
 
+0. Please make sure you have [Node](https://nodejs.org/en/download) installed.
 1. Open Claude desktop app.
 2. Navigate to Settings > Developer.
 3. Click `Edit Config`.
@@ -31,27 +32,6 @@ This project is a local [MCP server](https://spec.modelcontextprotocol.io) desig
 }
 ```
 
-## Development
+### Known Issues
 
-### Getting started
-1. Install Git hooks: `uvx pre-commit install`.
-2. Run `npm run dev`.
-3. Use the following Claude config:
-```
-{
-  "mcpServers": {
-    "Readwise MCP": {
-      "command": "node",
-      "args": [
-        "/path/to/your/readwise-mcp/build/index.js"
-      ],
-      "env": {
-        "BASE_URL": "https://local.readwise.io:8000",
-        "NODE_TLS_REJECT_UNAUTHORIZED": "0",
-        "ACCESS_TOKEN": "XXXXXXXXX"
-      }
-    }
-  }
-}
-```
-4. Remember to restart Claude after each modification to the code.
+When using this MCP server, you may occasionally encounter MCP errors during your conversations with Claude. If you experience such errors, we recommend trying to switch between different Claude models (e.g., from Claude 3.5 Haiku to Claude 3.7 Sonnet) as this often resolves the issue.

build/index.js

@@ -8,7 +8,7 @@ class ReadwiseMcp {
     constructor() {
         this.server = new McpServer({
             name: "Readwise MCP",
-            version: "0.0.3"
+            version: "0.0.4"
         });
         this.axios = axios.create({
             baseURL: process.env.BASE_URL ?? "https://readwise.io",

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@readwise/readwise-mcp",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Readwise MCP",
   "homepage": "https://readwise.io",
   "private": false,

package.json

@@ -11,7 +11,7 @@ class ReadwiseMcp {
   constructor() {
     this.server = new McpServer({
       name: "Readwise MCP",
-      version: "0.0.3"
+      version: "0.0.4"
     });
 
     this.axios = axios.create({