affine-mcp-server 1.2.0 → 1.2.2

package/README.md

@@ -2,7 +2,7 @@
 
 A Model Context Protocol (MCP) server that integrates with AFFiNE (self‑hosted or cloud). It exposes AFFiNE workspaces and documents to AI assistants over stdio.
 
-[![Version](https://img.shields.io/badge/version-1.2.0-blue)](https://github.com/dawncr0w/affine-mcp-server/releases)
+[![Version](https://img.shields.io/badge/version-1.2.2-blue)](https://github.com/dawncr0w/affine-mcp-server/releases)
 [![MCP SDK](https://img.shields.io/badge/MCP%20SDK-1.17.2-green)](https://github.com/modelcontextprotocol/typescript-sdk)
 [![License](https://img.shields.io/badge/license-MIT-yellow)](LICENSE)
 
@@ -12,9 +12,9 @@ A Model Context Protocol (MCP) server that integrates with AFFiNE (self‑hosted
 - Transport: stdio only (Claude Desktop / Codex compatible)
 - Auth: Token, Cookie, or Email/Password (priority order)
 - Tools: 30+ tools plus WebSocket-based document editing
-- Status: Production Ready (v1.2.0)
-
-> New in v1.2.0: Document create/edit/delete is now supported via WebSocket sync. Use `create_doc`, `append_paragraph`, and `delete_doc` to manage real AFFiNE docs.
+- Status: Production Ready (v1.2.1)
+ 
+> New in v1.2.2: Fixed CLI binary to always run via Node (no shell mis-execution). Startup remains non-blocking for email/password login by default; set `AFFINE_LOGIN_AT_START=sync` to block at startup.
 
 ## Features
 
@@ -37,35 +37,21 @@ A Model Context Protocol (MCP) server that integrates with AFFiNE (self‑hosted
 # Global install (recommended)
 npm i -g affine-mcp-server
 
-# Or run ad-hoc with npx
-npx affine-mcp-server
+# Or run ad‑hoc via npx (no install)
+npx -y -p affine-mcp-server affine-mcp -- --version
 ```
 
 The package installs a CLI named `affine-mcp` that runs the MCP server over stdio.
 
-> Available on npm: install in seconds with `npm i -g affine-mcp-server` and use `affine-mcp` anywhere. No manual build or path setup required.
+Note: From v1.2.2 the CLI wrapper (`bin/affine-mcp`) ensures Node runs the ESM entrypoint, preventing shell from misinterpreting JS.
 
 ## Configuration
 
-Create a `.env` file or set environment variables:
-
-```env
-# AFFiNE server URL (required)
-AFFINE_BASE_URL=https://your-affine-instance.com
+Configure via environment variables (shell or app config). `.env` files are no longer recommended.
 
-# Authentication (choose one method):
-# 1) Bearer Token (highest priority)
-AFFINE_API_TOKEN=your_personal_access_token
-# 2) Session Cookie
-AFFINE_COOKIE=affine_session=xxx; affine_csrf=yyy
-# 3) Email/Password (fallback)
-AFFINE_EMAIL=your@email.com
-AFFINE_PASSWORD=your_password
-
-# Optional settings
-AFFINE_GRAPHQL_PATH=/graphql           # Default: /graphql
-AFFINE_WORKSPACE_ID=workspace-uuid     # Default workspace for operations
-```
+- Required: `AFFINE_BASE_URL`
+- Auth (choose one): `AFFINE_API_TOKEN` | `AFFINE_COOKIE` | `AFFINE_EMAIL` + `AFFINE_PASSWORD`
+- Optional: `AFFINE_GRAPHQL_PATH` (default `/graphql`), `AFFINE_WORKSPACE_ID`, `AFFINE_LOGIN_AT_START` (`async` default, `sync` to block)
 
 Authentication priority:
 1) `AFFINE_API_TOKEN` → 2) `AFFINE_COOKIE` → 3) `AFFINE_EMAIL` + `AFFINE_PASSWORD`
@@ -87,29 +73,38 @@ Add to your Claude Desktop configuration:
       "command": "affine-mcp",
       "env": {
         "AFFINE_BASE_URL": "https://your-affine-instance.com",
-        "AFFINE_COOKIE": "affine_session=...; affine_csrf=..."
+        "AFFINE_EMAIL": "you@example.com",
+        "AFFINE_PASSWORD": "secret!",
+        "AFFINE_LOGIN_AT_START": "async"
       }
     }
   }
 }
 ```
 
+Tips
+- Prefer `AFFINE_COOKIE` or `AFFINE_API_TOKEN` for zero‑latency startup.
+- If your password contains `!` (zsh history expansion), wrap it in single quotes in shells or use the JSON config above.
+
 ### Codex CLI
 
-Codex attaches MCP servers by executing commands over stdio. Depending on your Codex version, use one of these patterns:
+Register the MCP server with Codex:
 
-- Direct flag example:
-  - `codex --mcp affine=affine-mcp --env AFFINE_BASE_URL=https://your-affine-instance.com --env AFFINE_COOKIE='affine_session=...; affine_csrf=...'`
+- Global install path (fastest)
+  - `npm i -g affine-mcp-server`
+  - `codex mcp add affine --env AFFINE_BASE_URL=https://your-affine-instance.com --env 'AFFINE_EMAIL=you@example.com' --env 'AFFINE_PASSWORD=secret!' --env AFFINE_LOGIN_AT_START=async -- affine-mcp`
 
-- Profile/config based registration (conceptual):
-  - name: `affine`, command: `affine-mcp`, env: `AFFINE_*`
+- Use npx (no global install)
+  - `codex mcp add affine --env AFFINE_BASE_URL=https://your-affine-instance.com --env 'AFFINE_EMAIL=you@example.com' --env 'AFFINE_PASSWORD=secret!' --env AFFINE_LOGIN_AT_START=async -- npx -y -p affine-mcp-server affine-mcp`
 
-General rules:
+- Token or cookie (no startup login)
+  - Token: `codex mcp add affine --env AFFINE_BASE_URL=https://... --env AFFINE_API_TOKEN=... -- affine-mcp`
+  - Cookie: `codex mcp add affine --env AFFINE_BASE_URL=https://... --env "AFFINE_COOKIE=affine_session=...; affine_csrf=..." -- affine-mcp`
+
+Notes
 - MCP name: `affine`
 - Command: `affine-mcp`
-- Env: `AFFINE_BASE_URL` and one auth method (`AFFINE_COOKIE` or `AFFINE_API_TOKEN` or `AFFINE_EMAIL`/`AFFINE_PASSWORD`)
-
-Refer to your Codex CLI docs for the exact config keys/paths.
+- Environment: `AFFINE_BASE_URL` + one auth method (`AFFINE_API_TOKEN` | `AFFINE_COOKIE` | `AFFINE_EMAIL`/`AFFINE_PASSWORD`)
 
 ## Available Tools
 
@@ -150,14 +145,19 @@ Refer to your Codex CLI docs for the exact config keys/paths.
 ### Advanced
 - `apply_doc_updates` – apply CRDT updates to documents
 
-## Run locally (dev)
+## Use Locally (clone)
 
 ```bash
 git clone https://github.com/dawncr0w/affine-mcp-server.git
 cd affine-mcp-server
 npm install
 npm run build
-npm start
+# Run directly
+node dist/index.js
+
+# Or expose as a global CLI for Codex/Claude without publishing
+npm link
+# Now use `affine-mcp` like a global binary
 ```
 
 ## Troubleshooting
@@ -166,6 +166,7 @@ Authentication
 - Email/Password: ensure your instance allows password auth and credentials are valid
 - Cookie: copy cookies (e.g., `affine_session`, `affine_csrf`) from the browser DevTools after login
 - Token: generate a personal access token; verify it hasn’t expired
+- Startup timeouts: v1.2.2 includes a CLI wrapper fix and the default async login to avoid blocking the MCP handshake. Set `AFFINE_LOGIN_AT_START=sync` only if needed.
 
 Connection
 - Confirm `AFFINE_BASE_URL` is reachable
@@ -182,6 +183,16 @@ Connection
 
 ## Version History
 
+### 1.2.2 (2025‑09‑18)
+- CLI wrapper added to ensure Node runs ESM entry (`bin/affine-mcp`), preventing shell mis-execution
+- Docs cleaned: use env vars via shell/app config; `.env` file no longer recommended
+- MCP startup behavior unchanged from 1.2.1 (async login by default)
+
+### 1.2.1 (2025‑09‑17)
+- Default to asynchronous email/password login after MCP stdio handshake
+- New `AFFINE_LOGIN_AT_START` env (`async` default, `sync` to block at startup)
+- Expanded docs for Codex/Claude using npm, npx, and local clone
+
 ### 1.2.0 (2025‑09‑16)
 - WebSocket-based document tools: `create_doc`, `append_paragraph`, `delete_doc` (create/edit/delete now supported)
 - Tool aliases: both `affine_*` and non‑prefixed names

package/bin/affine-mcp

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+// Lightweight CLI wrapper to ensure Node runs the ESM entry
+// Resolves to the compiled ESM entrypoint in dist
+import '../dist/index.js';
+

package/dist/config.js

@@ -1,5 +1,3 @@
-import dotenv from "dotenv";
-dotenv.config();
 const defaultEndpoints = {
     listWorkspaces: { method: "GET", path: "/api/workspaces" },
     listDocs: { method: "GET", path: "/api/workspaces/:workspaceId/docs" },

package/dist/index.js

@@ -16,24 +16,42 @@ import { loginWithPassword } from "./auth.js";
 import { registerAuthTools } from "./tools/auth.js";
 const config = loadConfig();
 async function buildServer() {
-    const server = new McpServer({ name: "affine-mcp", version: "1.1.0" });
+    const server = new McpServer({ name: "affine-mcp", version: "1.2.2" });
     // Initialize GraphQL client with authentication
     const gql = new GraphQLClient({
         endpoint: `${config.baseUrl}${config.graphqlPath}`,
         headers: config.headers,
         bearer: config.apiToken
     });
-    // Try email/password authentication if no other auth method is configured
+    // Try email/password authentication if no other auth method is configured.
+    // To avoid startup timeouts in MCP clients, default to async login after the stdio handshake.
     if (!gql.isAuthenticated() && config.email && config.password) {
-        console.error("No token or cookie provided, attempting email/password authentication...");
-        try {
-            const { cookieHeader } = await loginWithPassword(config.baseUrl, config.email, config.password);
-            gql.setCookie(cookieHeader);
-            console.error("Successfully authenticated with email/password");
+        const mode = (process.env.AFFINE_LOGIN_AT_START || "async").toLowerCase();
+        if (mode === "sync") {
+            console.error("No token/cookie; performing synchronous email/password authentication at startup...");
+            try {
+                const { cookieHeader } = await loginWithPassword(config.baseUrl, config.email, config.password);
+                gql.setCookie(cookieHeader);
+                console.error("Successfully authenticated with email/password");
+            }
+            catch (e) {
+                console.error("Failed to authenticate with email/password:", e);
+                console.error("WARNING: Continuing without authentication - some operations may fail");
+            }
         }
-        catch (e) {
-            console.error("Failed to authenticate with email/password:", e);
-            console.error("WARNING: Continuing without authentication - some operations may fail");
+        else {
+            console.error("No token/cookie; deferring email/password authentication (async after connect)...");
+            // Fire-and-forget async login so stdio handshake is not delayed.
+            (async () => {
+                try {
+                    const { cookieHeader } = await loginWithPassword(config.baseUrl, config.email, config.password);
+                    gql.setCookie(cookieHeader);
+                    console.error("Successfully authenticated with email/password (async)");
+                }
+                catch (e) {
+                    console.error("Failed to authenticate with email/password (async):", e);
+                }
+            })();
         }
     }
     // Log authentication status

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "affine-mcp-server",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "private": false,
   "type": "module",
   "description": "Model Context Protocol server for AFFiNE - enables AI assistants to interact with AFFiNE workspaces, documents, and collaboration features.",
@@ -8,7 +8,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/dawncr0w/affine-mcp-server.git"
+    "url": "git+https://github.com/dawncr0w/affine-mcp-server.git"
   },
   "keywords": [
     "mcp",
@@ -20,7 +20,7 @@
   ],
   "main": "dist/index.js",
   "bin": {
-    "affine-mcp": "dist/index.js"
+    "affine-mcp": "bin/affine-mcp"
   },
   "scripts": {
     "build": "tsc -p tsconfig.json",
@@ -29,6 +29,7 @@
     "prepublishOnly": "npm run build"
   },
   "files": [
+    "bin",
     "dist",
     "README.md",
     "LICENSE"
@@ -41,7 +42,6 @@
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.17.2",
-    "dotenv": "^16.6.1",
     "form-data": "^4.0.4",
     "node-fetch": "^3.3.2",
     "socket.io-client": "^4.8.1",