yoke-mcp 0.1.0

package/dist/mcp-server.d.ts

@@ -0,0 +1,370 @@
+export declare const SERVER_NAME = "yoke";
+export declare const SERVER_VERSION = "0.1.0";
+export declare const PROTOCOL_VERSION = "2024-11-05";
+/**
+ * The label on the group holding tabs yoke opened.
+ *
+ * Decided here rather than in the extension because it is policy, and policy
+ * belongs where it can be changed and tested without reloading a browser. The
+ * extension keeps the same value as a fallback, for a caller that names nothing.
+ */
+export declare const DEFAULT_GROUP_TITLE = "yoke";
+export interface ToolResult {
+    content: Array<{
+        type: 'text';
+        text: string;
+    }>;
+    /** Present only for tools that return an image, such as screenshot. */
+    images?: Array<{
+        format: string;
+        base64: string;
+    }>;
+    isError?: boolean;
+}
+interface JsonRpcRequest {
+    jsonrpc?: string;
+    id?: string | number;
+    method: string;
+    params?: {
+        name?: string;
+        arguments?: Record<string, unknown>;
+    };
+}
+/** origin and path only, so a tab listing never leaks a token in a query string. */
+export declare function shownUrl(url: string, full?: boolean): string;
+export declare const TOOLS: readonly [{
+    readonly name: "list_tabs";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly full_urls: {
+                readonly type: "boolean";
+                readonly default: false;
+                readonly description: "Return raw URLs instead of origin and path.";
+            };
+        };
+    };
+}, {
+    readonly name: "list_tab_groups";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {};
+    };
+}, {
+    readonly name: "navigate";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id", "url"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+                readonly description: "From list_tabs.";
+            };
+            readonly url: {
+                readonly type: "string";
+                readonly description: "http and https only.";
+            };
+            readonly timeout_ms: {
+                readonly type: "number";
+                readonly description: "How long to wait for the load. Default 20000.";
+            };
+        };
+    };
+}, {
+    readonly name: "open_tab";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly url: {
+                readonly type: "string";
+            };
+            readonly active: {
+                readonly type: "boolean";
+                readonly default: false;
+                readonly description: "Focus the new tab.";
+            };
+            readonly group_title: {
+                readonly type: "string";
+                readonly default: "yoke";
+                readonly description: "The label on the group. Defaults to yoke, so the tab strip names what is driving it.";
+            };
+        };
+    };
+}, {
+    readonly name: "close_tab";
+    readonly description: "Close one tab by id.";
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+            };
+        };
+    };
+}, {
+    readonly name: "read_page";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+            };
+            readonly max_elements: {
+                readonly type: "number";
+                readonly description: "Default 200.";
+            };
+        };
+    };
+}, {
+    readonly name: "find";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id", "text"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+            };
+            readonly text: {
+                readonly type: "string";
+            };
+        };
+    };
+}, {
+    readonly name: "click";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id", "ref"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+            };
+            readonly ref: {
+                readonly type: "string";
+                readonly description: "From read_page.";
+            };
+            readonly button: {
+                readonly type: "string";
+                readonly enum: readonly ["left", "right", "middle"];
+                readonly default: "left";
+            };
+            readonly click_count: {
+                readonly type: "number";
+                readonly default: 1;
+                readonly description: "2 for a double click.";
+            };
+        };
+    };
+}, {
+    readonly name: "type_text";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id", "text"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+            };
+            readonly text: {
+                readonly type: "string";
+            };
+            readonly ref: {
+                readonly type: "string";
+                readonly description: "Focus this element first.";
+            };
+            readonly press_enter: {
+                readonly type: "boolean";
+                readonly default: false;
+            };
+        };
+    };
+}, {
+    readonly name: "press_key";
+    readonly description: "Press one named key: Enter, Tab, Escape, Backspace or an arrow.";
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id", "key"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+            };
+            readonly key: {
+                readonly type: "string";
+            };
+            readonly ref: {
+                readonly type: "string";
+                readonly description: "Focus this element first.";
+            };
+        };
+    };
+}, {
+    readonly name: "scroll";
+    readonly description: "Scroll a page, or scroll an element into view by ref.";
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+            };
+            readonly dy: {
+                readonly type: "number";
+                readonly default: 400;
+                readonly description: "Positive scrolls down.";
+            };
+            readonly dx: {
+                readonly type: "number";
+                readonly default: 0;
+            };
+            readonly ref: {
+                readonly type: "string";
+            };
+        };
+    };
+}, {
+    readonly name: "screenshot";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+            };
+            readonly format: {
+                readonly type: "string";
+                readonly enum: readonly ["png", "jpeg"];
+                readonly default: "png";
+            };
+            readonly quality: {
+                readonly type: "number";
+                readonly description: "JPEG only, 0 to 100.";
+            };
+        };
+    };
+}, {
+    readonly name: "run_javascript";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id", "expression"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+            };
+            readonly expression: {
+                readonly type: "string";
+            };
+        };
+    };
+}, {
+    readonly name: "read_console";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+            };
+            readonly limit: {
+                readonly type: "number";
+                readonly default: 100;
+            };
+        };
+    };
+}, {
+    readonly name: "read_network";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+            };
+            readonly limit: {
+                readonly type: "number";
+                readonly default: 100;
+            };
+        };
+    };
+}, {
+    readonly name: "group_tabs";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_ids"];
+        readonly properties: {
+            readonly tab_ids: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "number";
+                };
+            };
+            readonly title: {
+                readonly type: "string";
+                readonly description: "The group label. Defaults to yoke.";
+            };
+            readonly color: {
+                readonly type: "string";
+                readonly enum: readonly ["grey", "blue", "red", "yellow", "green", "pink", "purple", "cyan", "orange"];
+            };
+        };
+    };
+}, {
+    readonly name: "ungroup_tabs";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_ids"];
+        readonly properties: {
+            readonly tab_ids: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "number";
+                };
+            };
+        };
+    };
+}, {
+    readonly name: "release_tab";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+            };
+        };
+    };
+}, {
+    readonly name: "get_page_text";
+    readonly description: string;
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly required: readonly ["tab_id"];
+        readonly properties: {
+            readonly tab_id: {
+                readonly type: "number";
+            };
+            readonly max_chars: {
+                readonly type: "number";
+                readonly description: "Truncate beyond this. Default 200000.";
+            };
+        };
+    };
+}];
+export declare function callTool(name: string, args: Record<string, unknown>): Promise<ToolResult>;
+export declare function handle(request: JsonRpcRequest): Promise<unknown>;
+export declare function main(): void;
+export {};