DOCSEARCHbyAlgolia
Submit Docs

ScriptCat Documentation

website·Indexed 34 days ago

https://docs.scriptcat.org/

A browser extension for executing user scripts, compatible with Tampermonkey scripts. It features a built-in AI Agent with tools for web data fetching, DOM automation, and skill management, as well as support for foreground and background scripts, cloud synchronization via WebDAV, OneDrive, and Google Drive, and external access via sctl.

Tokens
69.5K
Snippets
273
Records
729
Agent score
67%

What's inside ScriptCat

  1. Overview of ScriptCat framework

    ScriptCat is a background script execution framework designed based on Tampermonkey's design philosophy. It provides full support for Tampermonkey scripts and extends functionality through specialized APIs. It includes a built-in editor to improve the script development and coding experience.

  2. Overview of the ScriptCat Agent system

    Introduced in ScriptCat v1.4, the Agent system provides user scripts with AI-driven capabilities including conversation, browser automation, file management, and scheduled tasks. These features are accessed via the CAT.agent.* namespace. Note that the Agent feature is currently in a testing phase and APIs may change before the official release.

  3. Overview of CAT.agent.task Execution Modes

    The CAT.agent.task API allows scripts to create scheduled tasks based on standard Cron expressions. There are two primary execution modes:

    1. Internal Mode: Managed automatically by the Agent system. When the Cron trigger fires, the system automatically creates/restores a conversation, sends the configured prompt to the LLM (using specified models and skills), and records execution history and token usage.
    2. Event Mode: Managed by the script. When the Cron trigger fires, the system sends an event notification to the script. The developer must use addListener to define the custom logic to be executed.

  4. Overview of ScriptCat supported script types

    ScriptCat supports three distinct types of scripts:

    1. Foreground Scripts: Standard userscripts (similar to Greasemonkey/Tampermonkey scripts) that run on web pages.
    2. Background Scripts: Scripts that run in the extension's background context.
    3. Scheduled Scripts (Crontab): Scripts designed to execute at specific time intervals, a specialized feature of the ScriptCat extension.

  5. Overview of ScriptCat MCP Client

    The MCP (Model Context Protocol) Management API allows scripts to manage MCP server connections. ScriptCat's MCP Client uses the Streamable HTTP transport protocol (JSON-RPC 2.0 over POST) and supports MCP protocol version 2025-03-26. MCP servers can provide three capabilities: Tools (automatically registered for the Agent to call), Resources (readable text/binary), and Prompts (parameterized templates).

  6. Overview of ScriptCat features and compatibility

    ScriptCat is a background-script execution framework inspired by Tampermonkey. It is compatible with Tampermonkey scripts and extends functionality by providing special APIs that allow scripts to perform more advanced tasks. It also includes a built-in editor designed to streamline the writing and development of script code.

  7. Overview of ScriptCat features

    ScriptCat is a browser extension that enables users to enhance their web browsing experience via community-created scripts. Key capabilities include:

    • User-facing enhancements: Ad-blocking, video playback controls (speed, ad-skipping, downloading), shopping price comparisons, automation (auto check-in), and reading aids (night mode, translation).
    • Developer tools: A built-in editor with syntax highlighting, real-time debugging, and a runtime that supports background scripts.
    • Ecosystem: A script store for one-click installation and cloud synchronization of scripts and configurations across devices.

  8. Overview of ScriptCat

    ScriptCat is an open-source browser extension that allows users to install and run community scripts to enhance web functionality. It supports Chrome, Edge, and Firefox. Key capabilities include ad-blocking, video enhancement (speed control, auto-skip ads), shopping helpers, productivity automation, and reading tools. It features cloud sync for scripts and settings across devices.

  9. Overview of Scheduled Task Execution Modes

    The CAT.agent.task API supports two modes for executing scheduled tasks based on cron expressions:

    1. Internal Mode: The Agent system automatically handles execution. It creates/resumes a conversation, sends a configured prompt to the LLM, uses specified models and skills, and automatically records token usage and history.
    2. Event Mode: The script handles execution. The system sends an event notification when the cron fires, which the script must listen for using addListener to execute custom logic.

  10. Overview of ScriptCat Agent System

    Introduced in ScriptCat v1.4, the Agent system provides user scripts with AI conversation, browser automation, file management, and scheduled tasks. All Agent capabilities are accessed via the CAT.agent.* namespace and require corresponding @grant declarations in the script metadata. Note: Agent features are currently in a testing phase and APIs may change before official release.

  11. Overview of ScriptCat Agent Intelligent Assistant

    v1.4
    Introduced in v1.4 (currently in beta), the Agent Intelligent Assistant allows users to automate browser operations, extract web data, manage files, and execute scheduled tasks using natural language conversations. The system supports multiple AI models (OpenAI-compatible and Anthropic native) and includes features such as Prompt Caching, a Skill system for extending domain knowledge, and Model Context Protocol (MCP) integration for external tool servers.

  12. Overview of ScriptCat MCP Client

    The ScriptCat MCP Client implements the Model Context Protocol (version 2025-03-26) using the Streamable HTTP transport protocol (JSON-RPC 2.0 POST). It allows scripts to manage connections to MCP servers, which provide three main capabilities: Tools (functions automatically registered for the Agent to call), Resources (readable text or binary data), and Prompts (parameterized prompt templates). To use these APIs, scripts must include the @grant CAT.agent.mcp permission.