{
  "markdown": "# <img src=\"./assets/logo.svg\" width=\"35\" align=\"center\" alt=\"Kobiton Logo\" /> Kobiton Automate\n\n[![Discord](https://img.shields.io/discord/1486036652685267055?color=7289DA&label=Discord&logo=discord&logoColor=white)](https://discord.gg/uHvBFDZVP)\n[![Cloud](https://img.shields.io/badge/Cloud-☁️-blue)](https://kobiton.com)\n[![Twitter Follow](https://img.shields.io/twitter/follow/KobitonMobile?style=social)](https://x.com/KobitonMobile)\n\nPlugin for the [Kobiton](https://kobiton.com) mobile testing platform. Works with [Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview), [GitHub Copilot CLI](https://docs.github.com/en/copilot/github-copilot-in-the-cli), [Gemini CLI](https://github.com/google-gemini/gemini-cli), [Codex CLI](https://github.com/openai/codex), and [Cursor](https://cursor.com) (CLI and IDE). Manage devices, upload apps, run automation sessions, and view test results directly from your AI coding assistant.\n\n## Contents\n\n- [Before You Begin](#before-you-begin)\n- [Installation](#installation)\n  - [Claude Code](#claude-code)\n  - [GitHub Copilot CLI](#github-copilot-cli)\n  - [Gemini CLI](#gemini-cli)\n  - [Codex CLI](#codex-cli)\n  - [Cursor CLI](#cursor-cli)\n  - [Cursor IDE](#cursor-ide)\n  - [Other MCP Clients](#other-mcp-clients)\n  - [Claude Surface Compatibility](#claude-surface-compatibility)\n- [Login](#login)\n  - [API Key Authentication (Alternative)](#api-key-authentication-alternative)\n- [Getting Started](#getting-started)\n  - [Your First Session](#your-first-session)\n  - [Which Skill Do I Want?](#which-skill-do-i-want)\n  - [Concepts](#concepts)\n  - [Prerequisites](#prerequisites)\n- [What You Can Do](#what-you-can-do)\n- [Tools](#tools)\n- [Skills](#skills)\n- [Commands](#commands)\n- [Running Automation Tests](#running-automation-tests)\n- [Interactive Device Testing](#interactive-device-testing)\n- [Examples](#examples)\n- [Troubleshooting](#troubleshooting)\n- [Privacy & Data](#privacy--data)\n- [Development](#development)\n- [License](#license)\n\n## Before You Begin\n\nMake sure you have:\n\n- **A Kobiton account** - sign up at [kobiton.com](https://kobiton.com) if you don't have one\n- **A supported AI assistant** - install [Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview), [Copilot CLI](https://docs.github.com/en/copilot/github-copilot-in-the-cli), [Gemini CLI](https://github.com/google-gemini/gemini-cli), [Codex CLI](https://github.com/openai/codex), or [Cursor](https://cursor.com) (CLI or IDE)\n- **A project directory** - your AI assistant must launch from a workspace, not from your home folder\n\n## Installation\n\n### Claude Code\n\nOpen your project and start a Claude Code session:\n\n```bash\ncd my-project\nclaude\n```\n\nInside the session, add the Kobiton marketplace and install the plugin:\n\n```\n/plugin marketplace add kobiton/automate\n/plugin install automate@kobiton\n```\n\n### GitHub Copilot CLI\n\nOpen your project and start a Copilot CLI session:\n\n```bash\ncd my-project\ncopilot\n```\n\nInside the session, add the Kobiton marketplace and install the plugin:\n\n```\n/plugin marketplace add kobiton/automate\n/plugin install automate@kobiton\n```\n\n### Gemini CLI\n\nFrom your project directory, install the extension directly from GitHub:\n\n```bash\ncd my-project\ngemini extensions install https://github.com/kobiton/automate\n```\n\nThen launch Gemini CLI:\n\n```bash\ngemini\n```\n\nThe `kobiton` MCP server and bundled skills are auto-discovered. Confirm the extension is active with `/extensions list` and the MCP server with `/mcp`.\n\n### Codex CLI\n\nAdd the Kobiton marketplace and install the plugin from the in-session browser. Codex opens a browser for Kobiton OAuth login on the first tool call.\n\n```bash\ncodex plugin marketplace add kobiton/automate\ncodex\n```\n\nInside Codex:\n\n1. Type `/plugins` to open the plugin browser\n2. Select the **kobiton** marketplace, then install the **automate** plugin\n3. The system browser should open for Kobiton OAuth login. After sign-in, tokens are cached in the OS keychain (macOS Keychain / Linux Secret Service / Windows Credential Manager) with automatic refresh.\n4. Run `/mcp` to confirm `kobiton` is **Connected**.\n\n<details>\n<summary><strong>Fallback: manual <code>config.toml</code> setup</strong></summary>\n\nIf you prefer not to use the marketplace, register the MCP server directly in `~/.codex/config.toml`:\n\n```toml\n[mcp_servers.kobiton]\nurl = \"https://api.kobiton.com/mcp\"\n```\n\nThen copy `AGENTS.md` into your workspace so Codex picks up the tool list and skill reference:\n\n```bash\ncurl -sLO https://raw.githubusercontent.com/kobiton/automate/main/AGENTS.md\n```\n\nLaunch `codex` and run `/mcp` to confirm. The OAuth flow still applies on the first tool call.\n</details>\n\n### Cursor CLI\n\nOpen your project and start a Cursor CLI session:\n\n```bash\ncd my-project\nagent\n```\n\nInside the session, add the Kobiton marketplace:\n\n```\n/plugin marketplace add github.com/kobiton/automate\n```\n\nCursor parses the repository for a few seconds; when the **automate** entry appears, press <kbd>Enter</kbd> to install (pick the installation scope that suits you). The installation brings in the bundled skills, the `kobiton` MCP server, and the slash commands.\n\nThen exit and relaunch `agent`. Cursor CLI currently loads plugin skills only at session start, so the skills won't appear until a fresh session.\n\nRun `/mcp list`, select **Kobiton**, and choose **Login** to complete Kobiton OAuth in the browser.\n\nRun `/setup` once to install the `~/.kobiton/bin/kobiton` CLI wrapper used by the `run-interactive-session` skill. Cursor registers plugin commands without a namespace prefix, so the plugin's setup and doctor commands appear as `/setup` and `/doctor` — pick the one with the Kobiton description to tell them apart from Cursor's built-ins.\n\nIf you also use the Cursor IDE, install the plugin only once. Installs are shared between the CLI and the IDE (see the note in the next section).\n\n### Cursor IDE\n\nThe Cursor desktop editor installs the plugin from its built-in plugin browser:\n\n1. Open **Cursor Settings** > **Plugins** and paste `https://github.com/kobiton/automate` into the search box\n2. Click the **automate** result, then **Add to Cursor**, then **Install**\n\nTo authenticate with the Kobiton MCP server: open **Tool & MCPs**, search for **kobiton**, click **Authenticate**, and complete the OAuth login in the browser.\n\n> **Using both Cursor CLI and the Cursor IDE?** They share plugin installs: a plugin installed from the `agent` CLI shows up in the IDE, and vice versa. Install the plugin **once** in either one, installing it in both registers the skills, commands, and MCP server twice.\n\n<details>\n<summary><strong>Alternative: project-only MCP config (MCP server only, no skills or commands)</strong></summary>\n\nFor a lightweight per-project setup that registers just the `kobiton` MCP server, drop `.cursor/mcp.json` from this repo into your project's `.cursor/` directory:\n\n```bash\ncd my-project\nmkdir -p .cursor\ncurl -sLO --output-dir .cursor https://raw.githubusercontent.com/kobiton/automate/main/.cursor/mcp.json\n```\n\nWorks for both the Cursor IDE and the `agent` CLI. You won't get the bundled skills, the setup and doctor commands, or the CLI wrapper.\n</details>\n\n### Other MCP Clients\n\nKobiton's MCP server is built on the open [Model Context Protocol](https://modelcontextprotocol.io), so **any MCP-compatible client can connect to it**. Same endpoint (`https://api.kobiton.com/mcp`), same browser-based OAuth login as the clients above.\n\n> **Good to know:** End-to-end tested only on Claude Code, Copilot CLI, Gemini CLI, Codex CLI, Cursor CLI, and the Cursor IDE; entries below are configs we expect to work but have not yet validated. Please [open an issue](https://github.com/kobiton/automate/issues/new?template=bug_report.yml) if any do not work for your setup. We're happy to help.\n\n#### ChatGPT (Apps SDK)\n\nChatGPT consumes MCP servers via an HTTPS endpoint registered in ChatGPT developer mode. Point ChatGPT at:\n\n```\nhttps://api.kobiton.com/mcp\n```\n\nThe Apps SDK does not require a separate manifest file; tool descriptors, OAuth flow, and `_meta.ui` widget hints flow through the MCP protocol itself. Reference: [developers.openai.com/apps-sdk/build/mcp-server](https://developers.openai.com/apps-sdk/build/mcp-server).\n\n#### Continue / Cline / other generic MCP clients\n\nRegister the `kobiton` server in your client's MCP config. Most clients read a JSON block like:\n\n```json\n{\n  \"mcpServers\": {\n    \"kobiton\": {\n      \"url\": \"https://api.kobiton.com/mcp\"\n    }\n  }\n}\n```\n\nAdjust to your client's specific format. The server URL and OAuth handshake are the same; if your client doesn't support OAuth, fall back to the API-key auth path (see [API Key Authentication](#api-key-authentication-alternative) below) - most clients accept custom `headers` blocks.\n\n### Claude Surface Compatibility\n\nEvery Claude surface that supports MCP can call the Kobiton [tools](#tools). The guided [skills](#skills) install automatically only in Claude Code today; other surfaces need a manual skill upload.\n\n| Claude surface | [Atomic MCP tools](#tools) | [Orchestrated skills](#skills) ¹ | How to connect |\n|---|:--------------------------:|:--------------------------------:|---|\n| **Claude Code** (CLI / IDE) |           ✅ Yes            |              ✅ Yes               | [Install the plugin](#claude-code) |\n| **Claude Cowork** (macOS / Windows) |           ✅ Yes            |        ⚠️ Manual upload ²        | Add `https://api.kobiton.com/mcp` as a connector under **Connectors** |\n| **claude.ai web · Claude Desktop · Claude mobile** |           ✅ Yes            |        ⚠️ Manual upload ²        | Add `https://api.kobiton.com/mcp` as a Custom Connector at [claude.ai](https://claude.ai); for mobile, configure it on the web first and it syncs to the app |\n\n¹ `run-interactive-session` also requires the downloaded `kobiton` CLI binary (macOS on Apple Silicon, Linux x64, or Windows x64 under Git Bash; Intel Macs unsupported) - see the [platform support note](#skills).\n² This plugin is not listed in the [Claude directory](https://support.claude.com/en/articles/14328846-browse-skills-connectors-and-plugins-in-one-directory) yet, so these surfaces can't install it as a plugin. As a workaround, zip a skill folder from this repo (e.g. `skills/run-automation-suite/`) and upload it as a [custom skill](https://support.claude.com/en/articles/12512198-how-to-create-custom-skills).\n\n## Login\n\nThe first time your AI assistant calls a Kobiton tool, a browser window opens for OAuth login. Sign in with your Kobiton credentials, tokens are then managed automatically by the assistant.\n\nYou can also trigger or inspect authentication explicitly:\n\n- **Claude Code**: type `/mcp` and select **kobiton** to start the OAuth flow\n- **GitHub Copilot CLI**: type `/mcp auth kobiton` to start the OAuth flow; use `/mcp` (or `/mcp show`) to inspect server status\n- **Gemini CLI**: type `/mcp auth kobiton` to start the OAuth flow; use `/mcp` to inspect server status\n- **Codex CLI**: browser opens automatically on the first MCP tool call (e.g. *\"List my Kobiton devices\"*) after plugin install. Tokens are cached in the OS keychain with automatic refresh. Use `/mcp` (or `/mcp verbose`) to inspect server status\n- **Cursor CLI**: run `/mcp list`, select **Kobiton**, and choose **Login** to start the OAuth flow; tokens are stored by Cursor in the OS keychain\n- **Cursor IDE**: open **Cursor Settings** > **Tool & MCPs**, search for **kobiton**, and click **Authenticate** to start the OAuth flow\n\nBehind the scenes, `.mcp.json` points to the Kobiton MCP server and authentication uses OAuth 2.1:\n\n```json\n{\n  \"mcpServers\": {\n    \"kobiton\": {\n      \"type\": \"http\",\n      \"url\": \"https://api.kobiton.com/mcp\"\n    }\n  }\n}\n```\n\nAfter login, verify the plugin loaded by asking your assistant: *\"List my Kobiton devices\"*. If tools aren't recognized, see [Troubleshooting](#troubleshooting).\n\n<a id=\"api-key-authentication-alternative\"></a>\n<details>\n<summary><strong>API Key Authentication (Alternative)</strong></summary>\n\nFor CI/CD pipelines or headless environments that cannot open a browser, use API key auth instead:\n\n1. Copy `.mcp.apikey-example.json` to `.mcp.json`\n2. Generate an API key at **Kobiton Portal > Settings > API Keys**\n3. Set the environment variable:\n\n   ```bash\n   # Add to ~/.zshrc, ~/.bashrc, or ~/.bash_profile\n   export KOBITON_AUTH=\"Basic $(echo -n 'username:apikey' | base64)\"\n   ```\n\n4. Reload your shell and restart your AI CLI.\n\n> **Note:** OAuth and API key auth cannot coexist in a single `.mcp.json` (the API key config sets an `Authorization` header that OAuth must not have). To switch, replace `.mcp.json` with the appropriate format from `.mcp.apikey-example.json`.\n>\n> **`/automate:setup` does not work under API key auth.** It fetches your credentials through an *OAuth-authenticated* MCP session to write `~/.kobiton/.credentials`. Per the [skill compatibility matrix](CLAUDE.md#skill-compatibility-matrix), three skills read that file directly and have no MCP fallback, so they are unavailable on API key auth: `run-interactive-session`, `drive-automation-session`, and `monitor-test-run`. The MCP tools, `run-automation-suite` (your script carries its own credentials), and `create-test-run` (pure MCP) are unaffected.\n>\n> **Gemini CLI:** API key auth requires editing `gemini-extension.json` instead of `.mcp.json`. Add a `headers` block under `mcpServers.kobiton` with `\"Authorization\": \"${KOBITON_AUTH}\"`.\n>\n> **Cursor (CLI and IDE):** API key auth requires editing `.cursor/mcp.json` instead of `.mcp.json` - that is the file the plugin manifest points `mcpServers` at. Cursor expands `${env:NAME}`, not the bare `${NAME}` other clients use, so start from `.cursor/mcp.apikey-example.json` rather than another client's config:\n>\n> ```bash\n> mkdir -p .cursor\n> curl -sL -o .cursor/mcp.json https://raw.githubusercontent.com/kobiton/automate/main/.cursor/mcp.apikey-example.json\n> ```\n>\n> A project-level `.cursor/mcp.json` survives plugin updates; the plugin's own copy lives in the version-pinned plugin cache and is replaced on reinstall.\n>\n> **Codex CLI:** OAuth is the default. For CI/headless environments where a browser cannot open, switch to API key auth by adding an `env_http_headers` block to the plugin's `.mcp.json`, then export `KOBITON_AUTH` in the shell that launches `codex`:\n>\n> ```\n> \"env_http_headers\": { \"Authorization\": \"KOBITON_AUTH\" }\n> ```\n>\n> **Recommended:** maintain a fork of `kobiton/automate` with this change committed, then install from your fork - survives plugin reinstalls and Codex upgrades. **Last resort:** edit the installed copy under `~/.codex/.tmp/marketplaces/kobiton/.codex/.mcp.json` directly (this is Codex cache; the edit is overwritten on every reinstall).\n\n</details>\n\n## Getting Started\n\nAfter installation, run setup to fetch your credentials and write them to `~/.kobiton/.credentials`:\n\n```\n/automate:setup\n```\n\nThe plugin uses your already-authenticated MCP session (OAuth) to fetch your username and API key - no manual file editing required.\n\nTo verify everything is wired correctly, run the diagnostic:\n\n```\n/automate:doctor\n```\n\n`/automate:doctor` is read-only. It checks the CLI installation (wrapper + target), the credentials file, the active profile, required fields, and CLI version drift (the plugin's pinned version vs the installed binary vs the newest published build), and prints actionable remediation hints for any failures.\n\n> **On Cursor (CLI and IDE)** the plugin's commands carry no `automate:` prefix. Run `/setup` and `/doctor` instead, picking the entry with the Kobiton description next to it to tell it apart from Cursor's built-in command of the same name.\n\n**CLI install behavior across CLIs:** The `run-interactive-session` skill depends on a `~/.kobiton/bin/kobiton` wrapper (a symlink on macOS/Linux, an exec shim on Windows). The same install script also downloads the plugin's pinned CLI build into `~/.kobiton/cli/` the first time it runs (sha256-verified; cache hits skip the network entirely).\n\n- **Claude Code, Codex CLI**: run automatically by a bundled SessionStart hook on every session start. On Codex CLI, the first session prompts you to trust the hook once via `/hooks`; subsequent sessions run it silently. Running `/automate:setup` also re-runs the installer on demand.\n- **GitHub Copilot CLI, Gemini CLI, Cursor CLI**: no SessionStart hook runs, so run the setup command once after install: `/automate:setup` on Copilot and Gemini, `/setup` (the one with the Kobiton description) on Cursor (Copilot reads Claude-format Markdown commands; Gemini reads bundled TOML at `commands/automate/setup.toml`). Re-run it if the wrapper goes missing.\n\nManual fallback - if the SessionStart hook was denied on Codex, or you need to install without an active session:\n\n```bash\nbash \"$(find ~/.codex -name install-cli.sh -path '*automate*' 2>/dev/null | head -1)\"\n```\n\nThe script is idempotent - safe to re-run.\n\n### Your First Session\n\nNew to Kobiton? This is the whole journey, start to finish. Each step is one thing you say to your assistant:\n\n1. **Set up credentials** — run `/automate:setup` once (see above).\n2. **Find a device** — \"List my available Android devices.\" Kobiton's cloud devices are real phones and tablets; pick one and note its name or UDID.\n3. **Reserve it** — \"Reserve the Pixel 8.\" A reservation holds the device exclusively for you.\n4. **Do one thing on it** — \"Open the browser and search for kobiton\" (the `drive-automation-session` skill auto-pilots it), or drive it step by step yourself with `run-interactive-session`.\n5. **Save it as a test case** — \"Save that session as a test case named smoke-search.\" Now the flow is repeatable.\n6. **(Optional) Run it at scale** — \"Create a test run for smoke-search on 3 devices and watch it.\" The `create-test-run` and `monitor-test-run` skills take it from here.\n\nThat's the full loop: device → session → test case → test run. Every skill in this plugin is a step on that path.\n\n### Which Skill Do I Want?\n\n| Reach for this when… | Skill |\n|----------------------|-------|\n| You have local Appium test scripts (Node.js, Python, .NET, Java) to run on Kobiton devices | `run-automation-suite` |\n| You want a clean, hands-off run of a described flow that you'll SAVE as a test case and rerun | `drive-automation-session` |\n| You want quick inspection or troubleshooting when something breaks — poke at the device, pull logs, push files | `run-interactive-session` |\n| You have a test case or suite and want to kick off a test run from it | `create-test-run` |\n| A test run is already going and you want to watch it and catch blockers | `monitor-test-run` |\n\nSay it your way — your assistant routes by meaning, not keyword: \"rerun / revisit / replay **a test case** on other devices\" goes to `create-test-run`; \"rerun **a session**\" means saving it as a test case first (sessions aren't rerun directly); \"replay **the recording**\" just opens the session's artifacts, no new run. And if your prompt names a goal but not a method (\"test the login screen of app ABC\"), the assistant asks one short question — run your scripts, let it drive the flow, or explore hands-on — defaulting to `drive-automation-session` so the result stays saveable as a test case.\n\n### Concepts\n\n| Term | Meaning |\n|------|---------|\n| Session | One connection to a device — everything you did (commands, video, logs) is recorded under a session id. |\n| Session type | How the session was driven, as the `type` field of `getSession` / `listSessions`: `AUTO` (script or agent via Appium), `UIAUTOMATOR` / `XCUITEST` (native instrumentation — `startNativeSession` or the CLI's `test run`), `CLI` (the bundled CLI wrapper), `MANUAL` (you, in the portal live view), `MIXED` (you interacted in the live view while an automation session ran); rarer: `SCRIPTLESS`, `GAMEDRIVER`. |\n| Test case | A saved, replayable sequence of steps, created by saving a completed session (`saveTestCase`). Automation sessions are saveable; CLI sessions are not. |\n| Revisit | What a test run does: re-executes a test case's saved steps on each selected device — one \"revisit execution\" per device. |\n| Test run | An execution of a test case or test suite across one or more devices, with per-device results. |\n| Test suite | An ordered collection of test cases run together. |\n| Reservation | An exclusive hold on a device so nothing else can use it while you work. |\n| Device UDID | The unique identifier of a specific device — the unambiguous way to target one. |\n| Live remediation | When a test run execution hits a blocker, Kobiton lets you take over the device in the browser, fix the step live, and let the run continue. |\n\n### Prerequisites\n\nBefore your first session, you need:\n\n- **A Kobiton account** — [sign up](https://kobiton.com) or use your organization's account.\n- **A supported host CLI** — Claude Code, GitHub Copilot CLI, Gemini CLI, Codex CLI, or Cursor (see [Installation](#installation)).\n- **Credentials configured** — run `/automate:setup` once after install.\n- **Your app build** (`.apk` / `.ipa`), if you're testing your own app rather than a system app or website.\n- **Platform note:** the `run-interactive-session` skill's CLI runs on **macOS (Apple Silicon), Linux (x64), and Windows (x64 under Git Bash)**. The binary is downloaded on install — a version pinned by the plugin release, sha256-verified, cached under `~/.kobiton/cli/` — so the first install needs network access once. Intel Macs are not supported (no macos-x64 build is published); there, use `run-automation-suite` or `drive-automation-session` instead — no dead end.\n\n**One worked example, end to end** — paste these to your assistant one at a time:\n\n```\nUpload ./builds/my-app.apk to Kobiton\nList my available Android devices and reserve a Pixel\nOpen my app on the reserved device, log in, and add the first item to the cart\nSave that session as a test case named smoke-add-to-cart\nCreate a test run for smoke-add-to-cart on 3 Android devices and watch it\n```\n\nEvery step above uses only what this plugin ships: the app tools (`uploadAppToStore`, `confirmAppUpload`), device tools (`listDevices`, `reserveDevice`), the `drive-automation-session` skill, the `saveTestCase` tool, and the `create-test-run` / `monitor-test-run` skills.\n\n## What You Can Do\n\n**Ask your assistant naturally:**\n\n- \"List my available Android devices\"\n- \"Upload my-app.apk and run tests on the Pixel 6\"\n- \"Show me the results for session 502\"\n- \"Run my Appium test script on the Pixel 6\"\n\n## Tools\n\n31 MCP tools across 5 domains.\n\n### Devices\n\n| Tool | Description |\n|------|-------------|\n| `listDevices` | List available devices filtered by platform, availability, or group |\n| `getDeviceStatus` | Get real-time status of a specific device |\n| `reserveDevice` | Reserve a device for exclusive testing |\n| `terminateReservation` | Release a reserved device by terminating its reservation |\n\n### Sessions\n\n| Tool | Description |\n|------|-------------|\n| `listSessions` | List test sessions with filters for status, device, platform |\n| `getSession` | Get session details including commands, capabilities, metadata |\n| `getSessionArtifacts` | Get download URLs for video, logs, screenshots, reports |\n| `getUserInputEvents` | Get the touch/swipe gestures a human made on the device-only live view during a session |\n| `terminateSession` | Stop a running test session |\n| `startNativeSession` | Start an XCUITest / UIAutomator / GameDriver native automation session on a device |\n\n### Apps\n\n| Tool | Description |\n|------|-------------|\n| `listApps` | List uploaded app builds in your organization |\n| `uploadAppToStore` | Upload an app to Kobiton Store (permanent, visible in portal) |\n| `confirmAppUpload` | Confirm an uploaded file so Kobiton creates the app record (parsing runs asynchronously) |\n| `getAppParsingStatus` | Check the async parse status of an uploaded app version until it reaches a terminal state |\n| `getApp` | Get app details and version history |\n\n### Test Management\n\n| Tool | Description |\n|------|-------------|\n| `saveTestCase` | Convert a finished manual session into a reusable test case |\n| `listTestCases` | List test cases with team and keyword filters |\n| `getTestCase` | Get test case details including its steps |\n| `updateTestCase` | Update a test case's metadata and steps |\n| `deleteTestCase` | Delete a test case |\n| `createTestRun` | Create a test run from a test suite or selected test cases (re-executes *recorded* steps — not the CLI's `kobiton test run`, which runs your own UIAutomator/XCUITest bundle; see `run-interactive-session`) |\n| `listTestRuns` | List test runs with team, keyword, and platform filters |\n| `getTestRun` | Get test run details including its sessions |\n| `terminateTestRun` | Stop a running test run |\n| `listTestSuites` | List test suites with team and keyword filters |\n| `getTestSuite` | Get test suite details including member test cases |\n| `createTestSuite` | Create a test suite from existing test cases |\n| `updateTestSuite` | Update a test suite's metadata and membership |\n| `deleteTestSuite` | Delete a test suite (member test cases are kept) |\n\n### Account\n\n| Tool | Description |\n|------|-------------|\n| `getCredential` | Return the authenticated user's username, API key, and portal URL — backs `/automate:setup` |\n| `getOrgSettings` | Return your organization's feature flags and preferences (e.g. live remediation) — read up front by `create-test-run` and `monitor-test-run` |\n\n## Skills\n\n| Skill | Description |\n|-------|-------------|\n| **run-automation-suite** | Guided workflow for app upload, device selection, local Appium script execution (Node.js, Python, .NET, Java), and result collection. |\n| **run-interactive-session** | Guided workflow for interactive testing using natural language. WebDriver actions, device operations (adb shell, logs, screen), file management (push/pull), and more. Renamed from `run-interactive-cli-session` in 1.8.0. |\n| **drive-automation-session** | Drives an already-reserved device from a natural-language intent via a direct Appium HTTP session (observe-decide-act loop). Returns a session id consumable by `saveTestCase`. Complements `run-interactive-session` — it uses the automation session type rather than the CLI. |\n| **create-test-run** | Creates a test run from a test case or suite — fills sensible defaults from the `createTestRun` schema when details are omitted, confirms a summary, then offers to monitor it and hands off to `monitor-test-run`. |\n| **monitor-test-run** | Watches a running test run and narrates it: reads the live-remediation flag up front, surfaces the live-remediation URL the moment an execution is blocked (optionally auto-opening the window), and post-mortems so a `BLOCKER_ENCOUNTERED` execution is never reported as passed. Quiet between real state changes. |\n\n> **Platform support note:** all MCP tools and the `run-automation-suite` skill work on every platform the host CLI supports. The `run-interactive-session` skill downloads its CLI binary on install (a version pinned by the plugin release, sha256-verified, cached under `~/.kobiton/cli/`) and runs on **macOS (Apple Silicon), Linux (x64), and Windows (x64 under Git Bash)**. Intel Macs are not supported — no macos-x64 build is published; there, use `run-automation-suite` or the MCP tools directly. For the full per-skill picture — which skills need a persistent local filesystem, which need the `~/.kobiton/.credentials` file that `/automate:setup` writes, and which run on an MCP connection alone — see the Skill compatibility matrix in [`CLAUDE.md`](CLAUDE.md#skill-compatibility-matrix).\n\n## Commands\n\n| Command | Description |\n|---------|-------------|\n| `/automate:setup` | Fetch credentials from the authenticated MCP server and write them to `~/.kobiton/.credentials` |\n| `/automate:doctor` | Read-only diagnostic for CLI installation, credentials file, active profile, and required fields |\n\nOn Cursor (CLI and IDE) these register without the `automate:` prefix — as `/setup` and `/doctor`, distinguishable from Cursor's built-ins by the Kobiton description.\n\n## Running Automation Tests\n\nUse the **run-automation-suite** skill to run local Appium test scripts. Your AI assistant reads your script, extracts capabilities, confirms the target device, and executes the script locally. Supports Node.js (`.js`), Python (`.py`), .NET (`.cs`), and Java (`.java`) scripts.\n\n## Interactive Device Testing\n\nUse the **run-interactive-session** skill to interact with devices using natural language. Describe what you want — \"tap the login button\", \"type hello in the search field\", \"swipe down\" — and your assistant translates your intent into CLI commands.\n\nBeyond WebDriver, the skill also supports device operations (adb shell, logs, screen capture), file management (push/pull files to device), and app management.\n\n## Examples\n\nSee [docs/examples.md](docs/examples.md) for prompt examples covering every tool and skill - device management, session management, app management, automation, and interactive testing.\n\n## Troubleshooting\n\n### Updating the Plugin\n\nAfter the plugin is updated upstream, pull the latest version:\n\n- **Claude Code / Copilot CLI:** run `/plugin install automate@kobiton` again\n- **Gemini CLI:** run `gemini extensions update kobiton-automate` from your shell\n- **Codex CLI:** run `codex plugin marketplace upgrade` to refresh the marketplace catalog, then reinstall the plugin from the browser to pull the latest manifest\n- **Cursor CLI:** re-run `/plugin marketplace add github.com/kobiton/automate` and reinstall the **automate** plugin - Cursor CLI has no dedicated update command yet (`/plugin marketplace list` only lists what's installed). Restart `agent` so the new manifest is picked up.\n\nTo make sure the assistant picks up the changes with no stale cache, reload per CLI:\n\n- **Claude Code:** run `/reload-plugins` in-session. If tools still behave unexpectedly, `/clear` resets the session context.\n- **GitHub Copilot CLI:** exit and relaunch the session (`exit`, then `copilot`). No in-session reload command.\n- **Gemini CLI:** exit and relaunch (`exit`, then `gemini`). Confirm with `gemini extensions list`.\n- **Codex CLI:** exit and relaunch. Confirm with `codex plugin list`.\n\nIf the issue persists after relaunch, quit the terminal entirely and start a fresh session.\n\n### Common Issues\n\n<details>\n<summary><strong>MCP server doesn't appear in <code>/mcp</code> after install</strong></summary>\n\nAll four CLIs cache plugin state when the session starts. After installing or updating the plugin, the `kobiton` MCP server may not show up in the server list immediately. Force a reload:\n\n**Claude Code** — reload plugins in the current session:\n\n```\n/reload-plugins\n```\n\n**GitHub Copilot CLI** — exit and relaunch the session:\n\n```bash\nexit\ncopilot\n```\n\n**Gemini CLI** — exit and relaunch; if still missing, verify the extension is enabled:\n\n```bash\nexit\ngemini extensions list\ngemini\n```\n\n**Codex CLI** — exit and relaunch; if still missing, verify the marketplace was added and the plugin was installed:\n\n```bash\nexit\ncodex plugin marketplace list\ncodex plugin list\ncodex\n```\n\nIf using the manual fallback config, also check `grep -A 4 \"mcp_servers.kobiton\" ~/.codex/config.toml`.\n\nThen check the server list (`/mcp` in Claude Code, Gemini CLI, and Codex CLI, `/mcp show` in Copilot CLI). `kobiton` should now appear.\n</details>\n\n<details>\n<summary><strong>\"Device not found\"</strong></summary>\n\nThe device may be offline, reserved by another user, or no longer in your device list. Use `listDevices` with `available: true` to find currently online devices.\n</details>\n\n<details>\n<summary><strong>\"Upload timeout\"</strong></summary>\n\nLarge app files or slow connections can cause uploads to time out. Retry the upload — pre-signed URLs expire after 30 minutes, so a new URL will be generated automatically.\n</details>\n\n### Claude Code\n\n<details>\n<summary><strong>Plugin features not working or behaving unexpectedly</strong></summary>\n\nSome older versions of Claude Code don't support the plugin features this plugin relies on. Make sure you're on the latest version:\n\n```bash\nnpm install -g @anthropic-ai/claude-code@latest\n```\n\nThen restart Claude Code and try again.\n</details>\n\n<details>\n<summary><strong>\"It keeps asking me to open a folder\"</strong></summary>\n\nClaude Code requires a working directory. Launch it from inside a project folder:\n\n```bash\ncd my-project\nclaude\n```\n\nIf you see this prompt repeatedly, make sure you are not running `claude` from your home directory or root (`/`).\n</details>\n\n<details>\n<summary><strong>\"Plugin not found in marketplace\"</strong></summary>\n\nThe Kobiton marketplace must be added before installing:\n\n```bash\n/plugin marketplace add kobiton/automate\n/plugin install automate@kobiton\n```\n\nIf it still isn't found, check your internet connection and ensure you're running the latest version of Claude Code (`claude update`).\n</details>\n\n<details>\n<summary><strong>\"claude: command not found\"</strong></summary>\n\nClaude Code is not installed or not in your PATH.\n\n- **Install:** follow the [official install guide](https://docs.anthropic.com/en/docs/claude-code/overview)\n- **PATH issue:** if you installed via npm, make sure your npm global bin directory is in your PATH:\n\n  ```bash\n  npm install -g @anthropic-ai/claude-code\n  ```\n\n  Then open a new terminal window and try `claude` again.\n</details>\n\n<details>\n<summary><strong>\"Nothing happens after install\"</strong></summary>\n\nThe plugin installed but tools don't appear or Claude doesn't recognize Kobiton commands.\n\n1. Run `/reload-plugins` to force Claude to pick up the new plugin\n2. Try asking: *\"List my Kobiton devices\"*\n3. If still not working, quit Claude Code entirely and start a fresh session\n4. Verify `.mcp.json` exists in the plugin directory — it tells Claude where the Kobiton MCP server lives\n</details>\n\n### Copilot CLI\n\n<details>\n<summary><strong>MCP tools not available after plugin install</strong></summary>\n\nVerify the plugin is installed and the MCP server is configured:\n\n```bash\n# Check installed plugins\ncopilot plugin list\n\n# Check MCP server status\n/mcp show\n```\n\nIf the `kobiton` MCP server doesn't appear, add it manually by running `/mcp add` and entering the following when prompted:\n\n- **Server name:** `kobiton`\n- **Type:** `http`\n- **URL:** `https://api.kobiton.com/mcp`\n\nAlternatively, edit `~/.copilot/mcp-config.json` directly:\n\n```json\n{\n  \"mcpServers\": {\n    \"kobiton\": {\n      \"type\": \"http\",\n      \"url\": \"https://api.kobiton.com/mcp\"\n    }\n  }\n}\n```\n</details>\n\n<details>\n<summary><strong>Tool calls are blocked</strong></summary>\n\nCopilot CLI requires explicit tool permissions. Allow Kobiton tools:\n\n```bash\n# Allow all Kobiton MCP tools\ncopilot --allow-tool='kobiton'\n\n# Or allow specific tools\ncopilot --allow-tool='kobiton(listDevices)' --allow-tool='kobiton(getSession)'\n```\n</details>\n\n### Gemini CLI\n\n<details>\n<summary><strong>Extension installed but tools or skills don't appear</strong></summary>\n\nVerify the extension is registered and enabled:\n\n```bash\ngemini extensions list\n```\n\nIf `kobiton-automate` is missing, reinstall:\n\n```bash\ngemini extensions install https://github.com/kobiton/automate\n```\n\nIf listed but disabled, enable it:\n\n```bash\ngemini extensions enable kobiton-automate\n```\n\nThen relaunch `gemini` and check `/mcp` for the `kobiton` server. The `run-automation-suite` skill is auto-discovered from `skills/` at the extension root, no separate registration needed.\n</details>\n\n<details>\n<summary><strong><code>/mcp</code> shows <code>kobiton</code> as Disconnected (OAuth not authenticated)</strong></summary>\n\nThe extension is installed but you haven't completed OAuth yet. Trigger the flow manually:\n\n```\n/mcp auth kobiton\n```\n\nA browser window opens for Kobiton login. After signing in, run `/mcp` again — the status should change to 🟢 Connected.\n\nNote: `kobiton` here is the **MCP server name** (declared inside the extension), not the extension name `kobiton-automate`. `/mcp` commands always take the server name.\n</details>\n\n<details>\n<summary><strong>OAuth doesn't open a browser on first tool call</strong></summary>\n\nGemini CLI's extension uses dynamic OAuth discovery by default. The Kobiton MCP server advertises OAuth metadata at a standard well-known endpoint, so the browser flow should kick in automatically the first time a tool needs auth.\n\nIf nothing happens, try `/mcp auth kobiton` to trigger it explicitly. Check that your terminal can launch a browser. For headless environments, switch to API key auth by editing `gemini-extension.json` directly (see the **API Key Authentication** section above).\n</details>\n\n### Codex CLI\n\n<details>\n<summary><strong>Tools not appearing or \"MCP server kobiton not initialized\"</strong></summary>\n\nVerify each step:\n\n1. **Plugin installed** — open `/plugins` inside Codex and confirm `automate` is listed under the `kobiton` marketplace as **Installed**. If missing, run `codex plugin marketplace add kobiton/automate` and reinstall from the plugin browser.\n2. **Codex version recent enough** — update with `npm install -g @openai/codex@latest`.\n\nAfter fixing, exit Codex and relaunch; the server should show in `/mcp` (or `/mcp verbose`).\n</details>\n\n<details>\n<summary><strong>Browser does not open for OAuth login</strong></summary>\n\nCodex tries to launch your system browser when Kobiton requires sign-in. If nothing opens, check:\n\n1. **Default browser is set** — your OS needs a default browser. SSH sessions without X forwarding cannot open one.\n2. **Localhost ports not blocked** — Codex listens on a local port to receive the login callback. Firewall rules that block all localhost ports will break the flow.\n3. **Headless environment** — switch to API key auth (see the **API Key Authentication** section above). Easiest: fork this repo, commit the `env_http_headers` change to `.codex/.mcp.json`, install from your fork.\n</details>\n\n<details>\n<summary><strong>OAuth login completes but <code>/mcp</code> still shows Disconnected</strong></summary>\n\nThis usually means the cached token is stale and refresh failed. Force a re-login by clearing the OS keychain entry and reconnecting:\n\n- **macOS:** open Keychain Access, search for `codex-mcp` or `kobiton`, delete the entry, then trigger a tool call to re-run OAuth.\n- **Linux:** `secret-tool clear service codex-mcp` (or use Seahorse to remove the entry).\n- **Windows:** open Credential Manager, find the Codex entry under Generic Credentials, remove it.\n\nAfter clearing, run any Kobiton tool prompt; the browser should reopen for fresh login.\n</details>\n\n### Cursor CLI\n\n<details>\n<summary><strong>Skills or slash commands don't appear (or show stale names) after install</strong></summary>\n\nCursor CLI caches plugin state per session, and older builds didn't load plugin-bundled skills at all:\n\n1. **Fully restart the session** — exit and re-run `agent`. Right after an install or update, the command list can render stale entries from the previous install; a fresh launch fixes it.\n2. **Update the CLI** — plugin skills only register in CLI builds from `2026.05.05` onward. Run `agent update`, then relaunch.\n3. **Reinstall if still missing** — `/plugin marketplace add github.com/kobiton/automate`, wait for the **automate** entry to appear, then press <kbd>Enter</kbd> to install.\n</details>\n\n<details>\n<summary><strong><code>kobiton</code> shows Disconnected or MCP tool calls silently fail</strong></summary>\n\n- **Not logged in yet** — run `/mcp list`, select **kobiton**, and choose **Login** to start the browser OAuth flow. Tokens are stored in the OS keychain.\n- **Known CLI regressions** — a few CLI builds listed MCP tools but never executed the calls. Run `agent update` to get the latest build, then relaunch `agent`.\n</details>\n\n<details>\n<summary><strong><code>~/.kobiton/bin/kobiton</code> CLI wrapper missing (interactive testing fails)</strong></summary>\n\nCursor CLI does not run the plugin's SessionStart hook, so the CLI wrapper isn't created automatically like on Claude Code or Codex. Run `/setup` (the plugin's command with the Kobiton description, not Cursor's built-in) once after install; re-run it if the wrapper goes missing.\n</details>\n\n### Still Stuck?\n\nFor additional help, open an issue at [github.com/kobiton/automate/issues](https://github.com/kobiton/automate/issues/new?template=bug_report.yml) or ask in [#general-discussion](https://discord.com/channels/1486036652685267055/1488189710248710327) on Discord. Feel free to share [feature requests](https://github.com/kobiton/automate/issues/new?template=feature_request.md). We welcome product feedback and will consider it as we continue to improve the platform.\n\n## Privacy & Data\n\nThis plugin connects to the Kobiton cloud API (`api.kobiton.com`) over HTTPS (TLS 1.2+).\n\n**Authentication:**\n\n- **OAuth 2.1 (default):** Your AI assistant opens a browser for Kobiton login. Short-lived access tokens are stored securely in the system keychain. No credentials are stored in the project.\n- **API Key (alternative):** The `KOBITON_AUTH` environment variable is sent via the `Authorization` header on each request. The value is stored only in your shell profile, never committed to the repo.\n\n**Data handling:**\n\n- The plugin does not store any data locally beyond what your AI assistant retains in its conversation context.\n- Tool responses (device lists, session details, test results) pass through your assistant's context window and are subject to [Anthropic's Privacy Policy](https://www.anthropic.com/privacy), [GitHub Copilot's Privacy Statement](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement), [Google's Gemini Privacy Notice](https://ai.google.dev/gemini-api/terms), or [OpenAI's Privacy Policy](https://openai.com/policies/privacy-policy), depending on which assistant you use.\n- App binaries uploaded via `uploadAppToStore` are sent directly to Kobiton's pre-signed S3 URLs, not through your AI assistant.\n\nFor details on how Kobiton handles your data, see the [Kobiton Privacy Policy](https://kobiton.com/privacy-policy) and [Trust Center](https://kobiton.com/trust-center/).\n\n## Development\n\nThe `tools/` directory contains reference YAML schemas that mirror the MCP server's tool definitions. They are published to S3 for the backend but are not consumed by the plugin at runtime.\n\n```bash\n# Install dependencies\npnpm install\n\n# Validate manifests and schemas\npnpm run validate\n\n# Run tests\npnpm test\n\n# Refresh the .codex/ mirror after editing skills/ or assets/\npnpm run build:codex\n\n# Build combined tool definitions (for S3 publishing)\npnpm run build\n```\n\n## License\n\n[MIT](https://opensource.org/license/mit)\n",
  "bytes": 42777,
  "sha": "61bf8f7bc4e88e79c533c583b6275c2369d7f0680edd349dad7890489e429cbf",
  "repo_slug": "kobiton/automate",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/plg_kobiton_automate_0173cfe3/readme"
}