openclaw-rumi 0.1.1 → 0.1.2

package/README.md

@@ -1,6 +1,8 @@
 # Rumi — OpenClaw Plugin
 
-Find real people to chat with based on shared interests. When you want human connection, Rumi matches you with compatible people.
+**Talk to real people, not just AI.** Rumi matches you with humans who share your interests — by what you want to talk about, not by photos.
+
+Your OpenClaw agent finds the right person in the background and connects you when a match is found. Chat right inside OpenClaw or on the Rumi website.
 
 ## Quick Start
 
@@ -48,20 +50,25 @@ If you prefer to set up manually:
 
 | Tool | Description |
 |------|-------------|
+| `rumi_health_check` | Verify your token, check quota, and see active sessions |
 | `rumi_find_partner` | Find someone to chat with based on your interests |
 | `rumi_check_status` | Check if a pending match has been found |
 | `rumi_send_message` | Send a message to your matched partner |
 | `rumi_get_messages` | Get recent messages from a conversation |
 
-## Usage
+## Usage Examples
 
 Just tell your OpenClaw agent:
 
 > "I want to find someone to talk about hiking with"
 
+> "Find me someone who's into TypeScript and has done large-scale migrations"
+
+> "I'm bored, connect me with someone interesting"
+
 The agent will use Rumi to find a compatible person. When matched, you can chat directly through OpenClaw or visit the Rumi website.
 
-The agent can also **proactively** find matches when it detects you might enjoy talking to a real person — you'll only be notified when someone is found.
+The agent can also **proactively** find matches when it detects you might enjoy talking to a real person — like when you're deep into a hobby topic, working solo late at night, or hitting the limits of what AI can offer. You'll only be notified when someone is found.
 
 ## Development
 

package/dist/index.d.ts

@@ -125,6 +125,39 @@ declare const _default: {
                 messageCount?: undefined;
                 messages?: undefined;
             }>;
+        } | {
+            name: string;
+            description: string;
+            parameters: {};
+            execute: () => Promise<{
+                status: string;
+                weeklyUsage: {
+                    used: number;
+                    limit: number;
+                    remaining: number;
+                };
+                activeSession: {
+                    sessionId: string;
+                    status: string;
+                } | null;
+                tokenExpiresAt: string | null;
+                message: string;
+                setupUrl?: undefined;
+            } | {
+                status: string;
+                setupUrl: string;
+                message: string;
+                weeklyUsage?: undefined;
+                activeSession?: undefined;
+                tokenExpiresAt?: undefined;
+            } | {
+                status: string;
+                message: string;
+                weeklyUsage?: undefined;
+                activeSession?: undefined;
+                tokenExpiresAt?: undefined;
+                setupUrl?: undefined;
+            }>;
         })[];
     }>;
 };

package/dist/index.js

@@ -4,6 +4,7 @@ import { createFindPartnerTool } from "./src/tools/find-partner";
 import { createCheckStatusTool } from "./src/tools/check-status";
 import { createSendMessageTool } from "./src/tools/send-message";
 import { createGetMessagesTool } from "./src/tools/get-messages";
+import { createHealthCheckTool } from "./src/tools/health-check";
 export default {
     id: "openclaw-rumi",
     slot: "tool",
@@ -16,6 +17,7 @@ export default {
         const client = new RumiClient(config);
         return {
             tools: [
+                createHealthCheckTool(client),
                 createFindPartnerTool(client),
                 createCheckStatusTool(client),
                 createSendMessageTool(client),

package/dist/src/client.d.ts

@@ -1,4 +1,4 @@
-import type { RumiConfig, FindMatchResponse, SessionStatusResponse, MessagesResponse, SendMessageResponse } from "./types";
+import type { RumiConfig, FindMatchResponse, SessionStatusResponse, MessagesResponse, SendMessageResponse, HealthResponse } from "./types";
 /**
  * HTTP client for Rumi Partner API
  */
@@ -11,5 +11,6 @@ export declare class RumiClient {
     getSessionStatus(sessionId: string): Promise<SessionStatusResponse>;
     getMessages(conversationId: string, after?: string, limit?: number): Promise<MessagesResponse>;
     getConnectUrl(): string;
+    healthCheck(): Promise<HealthResponse>;
     sendMessage(conversationId: string, content: string): Promise<SendMessageResponse>;
 }

package/dist/src/client.js

@@ -54,6 +54,9 @@ export class RumiClient {
     getConnectUrl() {
         return `${this.baseUrl}/connect?partner=openclaw`;
     }
+    async healthCheck() {
+        return this.request("/api/partner/health");
+    }
     async sendMessage(conversationId, content) {
         return this.request(`/api/conversations/${encodeURIComponent(conversationId)}/messages`, {
             method: "POST",

package/dist/src/tools/health-check.d.ts

@@ -0,0 +1,35 @@
+import type { RumiClient } from "../client";
+export declare function createHealthCheckTool(client: RumiClient): {
+    name: string;
+    description: string;
+    parameters: {};
+    execute: () => Promise<{
+        status: string;
+        weeklyUsage: {
+            used: number;
+            limit: number;
+            remaining: number;
+        };
+        activeSession: {
+            sessionId: string;
+            status: string;
+        } | null;
+        tokenExpiresAt: string | null;
+        message: string;
+        setupUrl?: undefined;
+    } | {
+        status: string;
+        setupUrl: string;
+        message: string;
+        weeklyUsage?: undefined;
+        activeSession?: undefined;
+        tokenExpiresAt?: undefined;
+    } | {
+        status: string;
+        message: string;
+        weeklyUsage?: undefined;
+        activeSession?: undefined;
+        tokenExpiresAt?: undefined;
+        setupUrl?: undefined;
+    }>;
+};

package/dist/src/tools/health-check.js

@@ -0,0 +1,46 @@
+export function createHealthCheckTool(client) {
+    return {
+        name: "rumi_health_check",
+        description: "Check if Rumi is properly configured: token validity, weekly usage quota, and any active matching sessions. Use this before rumi_find_partner to verify the setup is working.",
+        parameters: {},
+        execute: async () => {
+            try {
+                const result = await client.healthCheck();
+                const parts = [
+                    `Status: ${result.status}`,
+                    `Weekly usage: ${result.weeklyUsage.used}/${result.weeklyUsage.limit} (${result.weeklyUsage.remaining} remaining)`,
+                ];
+                if (result.tokenExpiresAt) {
+                    const expires = new Date(result.tokenExpiresAt);
+                    const daysLeft = Math.ceil((expires.getTime() - Date.now()) / (1000 * 60 * 60 * 24));
+                    parts.push(`Token expires in ${daysLeft} days`);
+                }
+                if (result.activeSession) {
+                    parts.push(`Active session: ${result.activeSession.sessionId} (${result.activeSession.status})`);
+                }
+                return {
+                    status: result.status,
+                    weeklyUsage: result.weeklyUsage,
+                    activeSession: result.activeSession,
+                    tokenExpiresAt: result.tokenExpiresAt,
+                    message: parts.join("\n"),
+                };
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                if (message.includes("401") || message.includes("UNAUTHORIZED")) {
+                    return {
+                        status: "setup_required",
+                        setupUrl: client.getConnectUrl(),
+                        message: "Rumi is not set up or the token has expired. Open this URL to set up: " +
+                            client.getConnectUrl(),
+                    };
+                }
+                return {
+                    status: "error",
+                    message: `Health check failed: ${message}`,
+                };
+            }
+        },
+    };
+}

package/dist/src/types.d.ts

@@ -38,6 +38,20 @@ export interface SendMessageResponse {
     id: string;
     created_at: string;
 }
+export interface HealthResponse {
+    status: string;
+    userId: string;
+    tokenExpiresAt: string | null;
+    weeklyUsage: {
+        used: number;
+        limit: number;
+        remaining: number;
+    };
+    activeSession: {
+        sessionId: string;
+        status: string;
+    } | null;
+}
 export declare const FindPartnerInput: import("@sinclair/typebox").TObject<{
     description: import("@sinclair/typebox").TString;
     locale: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"zh-TW">, import("@sinclair/typebox").TLiteral<"en">, import("@sinclair/typebox").TLiteral<"ja">, import("@sinclair/typebox").TLiteral<"ko">]>>;

package/index.ts

@@ -4,6 +4,7 @@ import { createFindPartnerTool } from "./src/tools/find-partner";
 import { createCheckStatusTool } from "./src/tools/check-status";
 import { createSendMessageTool } from "./src/tools/send-message";
 import { createGetMessagesTool } from "./src/tools/get-messages";
+import { createHealthCheckTool } from "./src/tools/health-check";
 
 export default {
   id: "openclaw-rumi",
@@ -19,6 +20,7 @@ export default {
 
     return {
       tools: [
+        createHealthCheckTool(client),
         createFindPartnerTool(client),
         createCheckStatusTool(client),
         createSendMessageTool(client),

package/package.json

@@ -1,9 +1,15 @@
 {
   "name": "openclaw-rumi",
-  "version": "0.1.1",
-  "description": "Rumi integration for OpenClaw — find real people to chat with based on shared interests",
+  "version": "0.1.2",
+  "description": "OpenClaw plugin to find real people to chat with — AI-powered interest matching connects you with compatible humans for genuine conversations",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "homepage": "https://rumi.app",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/maggiehu/Rumi",
+    "directory": "openclaw-plugin"
+  },
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch"
@@ -11,7 +17,22 @@
   "openclaw": {
     "extensions": "./dist/index.js"
   },
-  "keywords": ["openclaw", "rumi", "social", "matching", "chat"],
+  "keywords": [
+    "openclaw",
+    "openclaw-plugin",
+    "rumi",
+    "social",
+    "matching",
+    "chat",
+    "human-connection",
+    "interest-matching",
+    "conversation",
+    "ai-agent",
+    "find-people",
+    "real-people",
+    "networking",
+    "penpal"
+  ],
   "license": "MIT",
   "dependencies": {
     "@sinclair/typebox": "^0.32.0"

package/skills/SKILL.md

@@ -1,6 +1,6 @@
 ---
 name: rumi
-description: Find real people to chat with based on shared interests
+description: Match with real humans who share your interests — topic-driven matching, not photo swiping. Chat through OpenClaw or on the web.
 user-invocable: true
 metadata: {"openclaw":{"emoji":"🤝"}}
 ---
@@ -66,10 +66,11 @@ You can and SHOULD proactively search for a match when you detect these patterns
 
 ### If set up (apiToken configured):
 
-1. Gather context about what the user wants to talk about (or infer from conversation)
-2. Call `rumi_find_partner` with a rich description — include interests, mood, what kind of person they want
-3. If status is `searching` — check back with `rumi_check_status` every few minutes
-4. When matched — notify the user naturally: "Hey, I found someone who shares your interest in X!"
+1. Call `rumi_health_check` first to verify token and check quota
+2. Gather context about what the user wants to talk about (or infer from conversation)
+3. Call `rumi_find_partner` with a rich description — include interests, mood, what kind of person they want
+4. If status is `searching` — check back with `rumi_check_status` every few minutes
+5. When matched — notify the user naturally: "Hey, I found someone who shares your interest in X!"
 
 ## Handling Results
 

package/src/client.ts

@@ -4,6 +4,7 @@ import type {
   SessionStatusResponse,
   MessagesResponse,
   SendMessageResponse,
+  HealthResponse,
 } from "./types";
 
 const REQUEST_TIMEOUT_MS = 60000;
@@ -86,6 +87,10 @@ export class RumiClient {
     return `${this.baseUrl}/connect?partner=openclaw`;
   }
 
+  async healthCheck(): Promise<HealthResponse> {
+    return this.request<HealthResponse>("/api/partner/health");
+  }
+
   async sendMessage(
     conversationId: string,
     content: string

package/src/tools/health-check.ts

@@ -0,0 +1,60 @@
+import type { RumiClient } from "../client";
+
+export function createHealthCheckTool(client: RumiClient) {
+  return {
+    name: "rumi_health_check",
+    description:
+      "Check if Rumi is properly configured: token validity, weekly usage quota, and any active matching sessions. Use this before rumi_find_partner to verify the setup is working.",
+    parameters: {},
+    execute: async () => {
+      try {
+        const result = await client.healthCheck();
+
+        const parts = [
+          `Status: ${result.status}`,
+          `Weekly usage: ${result.weeklyUsage.used}/${result.weeklyUsage.limit} (${result.weeklyUsage.remaining} remaining)`,
+        ];
+
+        if (result.tokenExpiresAt) {
+          const expires = new Date(result.tokenExpiresAt);
+          const daysLeft = Math.ceil(
+            (expires.getTime() - Date.now()) / (1000 * 60 * 60 * 24)
+          );
+          parts.push(`Token expires in ${daysLeft} days`);
+        }
+
+        if (result.activeSession) {
+          parts.push(
+            `Active session: ${result.activeSession.sessionId} (${result.activeSession.status})`
+          );
+        }
+
+        return {
+          status: result.status,
+          weeklyUsage: result.weeklyUsage,
+          activeSession: result.activeSession,
+          tokenExpiresAt: result.tokenExpiresAt,
+          message: parts.join("\n"),
+        };
+      } catch (error) {
+        const message =
+          error instanceof Error ? error.message : String(error);
+
+        if (message.includes("401") || message.includes("UNAUTHORIZED")) {
+          return {
+            status: "setup_required",
+            setupUrl: client.getConnectUrl(),
+            message:
+              "Rumi is not set up or the token has expired. Open this URL to set up: " +
+              client.getConnectUrl(),
+          };
+        }
+
+        return {
+          status: "error",
+          message: `Health check failed: ${message}`,
+        };
+      }
+    },
+  };
+}

package/src/types.ts

@@ -55,6 +55,21 @@ export interface SendMessageResponse {
   created_at: string;
 }
 
+export interface HealthResponse {
+  status: string;
+  userId: string;
+  tokenExpiresAt: string | null;
+  weeklyUsage: {
+    used: number;
+    limit: number;
+    remaining: number;
+  };
+  activeSession: {
+    sessionId: string;
+    status: string;
+  } | null;
+}
+
 // Tool input schemas
 export const FindPartnerInput = Type.Object({
   description: Type.String({