Resources

The QuikGIF MCP server exposes five resources that provide documentation, examples, configuration schema, and live status information.

Reading a Resource

Use the standard MCP resources/read method:

{
  "method": "resources/read",
  "params": { "uri": "quikgif://docs/scripting-reference" }
}

---

quikgif://docs/scripting-reference

Complete .qgif scripting DSL reference — all commands, settings, and variables.

Property	Value
Name	Scripting Reference
MIME Type	text/markdown
URI	quikgif://docs/scripting-reference

Example request:

{
  "method": "resources/read",
  "params": { "uri": "quikgif://docs/scripting-reference" }
}

Response: A Markdown document containing all commands, settings, variables, pace presets, and syntax examples for the .qgif scripting language.

---

quikgif://examples/{name}

Example .qgif scripts demonstrating various features.

Property	Value
Name	Example Scripts
MIME Type	text/plain
URI Pattern	quikgif://examples/{name}

Available examples:

Name	Description
hello	Minimal single-window recording demo
git-workflow	Multi-step git demo with spotlight effects
multi-window	Recording across multiple windows with crossfade transitions
spotlight-demo	Visual effects showcase (spotlight, spotlight-shift, clear-fx)
polish-demo	Timing presets, auto-pacing, keystroke badges, intro/outro title cards

Example request:

{
  "method": "resources/read",
  "params": { "uri": "quikgif://examples/hello" }
}

Response: The complete .qgif script source for the requested example.

tip

AI clients can read example scripts to learn the DSL syntax before writing their own scripts.

---

quikgif://schema/settings

All .qgif settings with types, defaults, and valid values.

Property	Value
Name	Settings Schema
MIME Type	application/json
URI	quikgif://schema/settings

Example request:

{
  "method": "resources/read",
  "params": { "uri": "quikgif://schema/settings" }
}

Response:

{
  "settings": [
    {"name": "fps", "type": "integer", "default": 30, "enum": [12, 24, 30, 60]},
    {"name": "output", "type": "string", "default": "output.gif"},
    {"name": "max-width", "type": "integer", "default": 800},
    {"name": "loop-count", "type": "integer", "default": 0},
    {"name": "transition", "type": "number", "default": 0.3},
    {"name": "show-cursor", "type": "boolean", "default": true},
    {"name": "cursor-smoothing", "type": "boolean", "default": false},
    {"name": "click-indicators", "type": "boolean", "default": false},
    {"name": "type-smoothing", "type": "boolean", "default": false},
    {"name": "keystroke-badges", "type": "boolean", "default": false},
    {"name": "include-title-bar", "type": "boolean", "default": false},
    {"name": "idle-strategy", "type": "string", "default": null, "enum": ["fade", "cut", "ramp"]},
    {"name": "idle-threshold", "type": "number", "default": 2.0},
    {"name": "palette-strategy", "type": "string", "default": "auto", "enum": ["auto", "global", "perFrame"]},
    {"name": "cleanup", "type": "boolean", "default": true},
    {"name": "strict", "type": "boolean", "default": true},
    {"name": "run-timeout", "type": "number", "default": 30},
    {"name": "pace", "type": "string", "default": null, "enum": ["tutorial", "demo", "cinematic"]},
    {"name": "typing-delay", "type": "number", "default": 0.05},
    {"name": "auto-pace", "type": "boolean", "default": false},
    {"name": "auto-pace-delay", "type": "number", "default": 0.8}
  ]
}

---

quikgif://status/permissions

Live permission check for Screen Recording and Accessibility.

Property	Value
Name	Permission Status
MIME Type	application/json
URI	quikgif://status/permissions

Example request:

{
  "method": "resources/read",
  "params": { "uri": "quikgif://status/permissions" }
}

Response (all granted):

{
  "screen_recording": true,
  "accessibility": true,
  "screen_recording_note": "Granted",
  "accessibility_note": "Granted"
}

Response (not granted):

{
  "screen_recording": false,
  "accessibility": false,
  "screen_recording_note": "Not granted — required for recording. Grant in System Settings > Privacy & Security > Screen Recording.",
  "accessibility_note": "Not granted — optional, enables cursor smoothing, click indicators, keystroke badges."
}

---

quikgif://recordings

GIF files generated in the current MCP session.

Property	Value
Name	Recent Recordings
MIME Type	application/json
URI	quikgif://recordings

Example request:

{
  "method": "resources/read",
  "params": { "uri": "quikgif://recordings" }
}

Response (with recordings):

{
  "recordings": [
    {
      "path": "/Users/you/demo.gif",
      "size_mb": 1.24,
      "dimensions": "800x450",
      "date": "2026-03-29T10:30:00Z"
    }
  ]
}

Response (empty session):

{
  "recordings": [],
  "note": "No GIFs generated yet in this session."
}