viviscape-mcp 1.0.0 → 2.0.0

package/README.md

@@ -16,14 +16,36 @@ Or install globally:
 npm install -g viviscape-mcp
 ```
 
-## Configuration
+## Sign in
+
+Authentication is per-user, the same browser flow the ViviScape CLI uses — no
+API keys. Sign in once:
+
+```bash
+npx viviscape-mcp login
+```
+
+A browser tab opens on ViviScape Work; confirm **Allow access** and the session
+is stored in Windows Credential Manager (or `~/.viviscape/mcp-credentials.json`
+on macOS/Linux). Every tool call then runs as *you*: your user id, account,
+role, and plan come from the session, so tools see exactly the data you can see
+in the app.
 
-Set the following environment variables:
+```bash
+npx viviscape-mcp status    # who am I, which account, role, plan
+npx viviscape-mcp logout    # clear the stored session
+```
+
+If you already ran `vs auth login` with the [ViviScape CLI](https://viviscape.io),
+that session is picked up automatically. Inside an MCP client you can also call
+the `auth_login`, `auth_status`, and `auth_logout` tools. Sessions expire; when
+one does, tools report it and you re-run `login`.
+
+## Configuration
 
 | Variable | Required | Default | Description |
 |----------|----------|---------|-------------|
-| `VIVISCAPE_API_KEY` | yes | — | Your ViviScape API key |
-| `VIVISCAPE_API_URL` | no | `https://api.viviscape.io` | API base URL |
+| `VIVISCAPE_BASE_URL` | no | `https://work.viviscape.io` | ViviScape Work base URL |
 
 ## Claude Desktop / Claude Code
 
@@ -34,15 +56,46 @@ Add to your MCP client config (e.g. `claude_desktop_config.json` or `.mcp.json`)
   "mcpServers": {
     "viviscape": {
       "command": "npx",
-      "args": ["-y", "viviscape-mcp"],
-      "env": {
-        "VIVISCAPE_API_KEY": "your-api-key-here"
-      }
+      "args": ["-y", "viviscape-mcp"]
     }
   }
 }
 ```
 
+## OpenAI Codex CLI
+
+Codex accepts stdio MCP servers directly. Add to `~/.codex/config.toml`:
+
+```toml
+[mcp_servers.viviscape]
+command = "npx"
+args = ["-y", "viviscape-mcp"]
+```
+
+## ChatGPT (Developer Mode / Apps SDK)
+
+ChatGPT only accepts **remote HTTP** MCP servers — it does not run local stdio
+processes. Bridge this server to an HTTP endpoint with
+[`mcp-remote`](https://www.npmjs.com/package/mcp-remote) or
+[`supergateway`](https://www.npmjs.com/package/supergateway), then expose it
+publicly (Cloudflare Tunnel, ngrok, or deploy to a host).
+
+Example with `supergateway`:
+
+```bash
+npx viviscape-mcp login   # once, on the host running the gateway
+npx -y supergateway --stdio "npx -y viviscape-mcp" --port 8000
+```
+
+The gateway shares the host's stored session, so everyone reaching that endpoint
+acts as the signed-in user — put your own auth in front of it.
+
+Expose `http://localhost:8000/sse` publicly, then in ChatGPT:
+
+**Settings → Connectors → Create → Custom MCP server**
+- **URL:** `https://your-public-host/sse`
+- **Auth:** none (or bearer, depending on your gateway)
+
 ## Tools
 
 The server exposes tools across these domains:
@@ -56,6 +109,7 @@ The server exposes tools across these domains:
 - **Notes** — `note_add`, `note_get`, `note_update`, `note_remove`, `notes_mine`, `notes_query`
 - **Insights** — hours by person/service/project, AI summary, person stats, time totals
 - **Account** — `account_info`, `account_services`, `account_users`
+- **Auth** — `auth_login`, `auth_status`, `auth_logout`
 
 ## Development
 

package/dist/api-client.d.ts

@@ -1,8 +1,28 @@
+import { Credentials } from './auth/credentials.js';
+/** Raised when the stored session is rejected or bounced to the login page. */
+export declare class SessionExpiredError extends Error {
+    constructor();
+}
+export declare class ApiError extends Error {
+    status: number;
+    constructor(status: number, message: string);
+}
+/**
+ * Client for the ViviScape Work core API. Authenticates exactly like the
+ * ViviScape CLI: the signed-in user's bearer token plus the user_id / pid
+ * context headers the core API falls back to.
+ */
 export declare class ViviScapeClient {
+    private creds;
     private baseUrl;
-    private apiKey;
-    constructor(baseUrl: string, apiKey: string);
+    constructor(creds: Credentials);
+    get userId(): number;
+    get accountId(): number;
+    get session(): Credentials;
+    private get ctx();
     private request;
+    private get;
+    private post;
     addProspect(data: Record<string, unknown>): Promise<unknown>;
     updateProspect(data: Record<string, unknown>): Promise<unknown>;
     getProspect(prospectId: number): Promise<unknown>;
@@ -30,6 +50,8 @@ export declare class ViviScapeClient {
     getActiveProjects(): Promise<Record<string, unknown>[]>;
     getProjectById(projectId: number): Promise<unknown>;
     getProjectStaff(projectId: number): Promise<unknown>;
+    getProjectsByCompany(userId: number, companyId: number): Promise<unknown>;
+    getActiveProjectsByUser(userId: number): Promise<unknown>;
     addTask(data: Record<string, unknown>): Promise<unknown>;
     updateTask(data: Record<string, unknown>): Promise<unknown>;
     getProjectTasks(projectId: number): Promise<unknown>;
@@ -39,15 +61,13 @@ export declare class ViviScapeClient {
     getTasksByMilestone(milestoneId: number): Promise<unknown>;
     getTasksByGroupAndUser(groupId: number, userId: number): Promise<unknown>;
     getCompanyTasks(companyId: number): Promise<unknown>;
-    getProjectsByCompany(userId: number, companyId: number): Promise<unknown>;
-    getActiveProjectsByUser(userId: number): Promise<unknown>;
     addTimeLog(data: Record<string, unknown>): Promise<unknown>;
     updateTimeLog(data: Record<string, unknown>): Promise<unknown>;
     getMyNotes(): Promise<unknown>;
-    getNoteById(noteId: number): Promise<unknown>;
+    getNoteById(noteId: number | string): Promise<unknown>;
     addNote(data: Record<string, unknown>): Promise<unknown>;
     updateNote(data: Record<string, unknown>): Promise<unknown>;
-    removeNote(noteId: number): Promise<unknown>;
+    removeNote(noteId: number | string): Promise<unknown>;
     queryNotes(data: Record<string, unknown>): Promise<unknown>;
     getAccountInfo(): Promise<unknown>;
     getActiveServices(): Promise<unknown>;