hunch-sdk 0.3.0__tar.gz

hunch_sdk-0.3.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.pyc
+*.pyo
+.venv/
+venv/
+dist/
+build/
+*.egg-info/
+.DS_Store
+.pytest_cache/
+*.backup

hunch_sdk-0.3.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

hunch_sdk-0.3.0/PKG-INFO

@@ -0,0 +1,283 @@
+Metadata-Version: 2.4
+Name: hunch-sdk
+Version: 0.3.0
+Summary: Drive your Mac focus-free over MCP: OS APIs, AppleScript, CDP, and Accessibility.
+Project-URL: Homepage, https://github.com/prithviseran/hunch-mcp
+Project-URL: Issues, https://github.com/prithviseran/hunch-mcp/issues
+Author-email: Prithvi Seran <prithviseran0@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: accessibility,agent,automation,computer-use,macos,mcp
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: MacOS X
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.11
+Requires-Dist: mcp>=1.2
+Requires-Dist: pyobjc-framework-applicationservices>=10.0
+Requires-Dist: pyobjc-framework-cocoa>=10.0
+Requires-Dist: pyobjc-framework-quartz>=10.0
+Requires-Dist: websocket-client>=1.6
+Provides-Extra: agent
+Requires-Dist: anthropic>=0.80; extra == 'agent'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="src/hunch/assets/hunch.png" alt="Hunch" width="128">
+</p>
+
+# Hunch
+
+**Drive your Mac with any LLM: focus-free, in the background, over [MCP](https://modelcontextprotocol.io).**
+
+Hunch is an MCP server that gives an LLM agent hands on *your* Mac: your installed apps, your
+logged-in sessions, your files, without taking over your screen. While you keep working in the
+foreground, an agent can read a background app's UI, click its buttons, drive Mail or Music by
+AppleScript, fill a web form, or move files. It works on real native apps, not just a browser.
+
+> **Works best with modern LLMs.** Hunch ships a detailed playbook as MCP server instructions;
+> capable tool-using models (Claude Sonnet/Opus-class and up) follow it well. Smaller models may
+> pick clumsier paths (screenshots and keystrokes instead of tree reads and clicks).
+
+## The four layers
+
+Hunch always prefers the most direct layer. It's faster, more reliable, and (except the last)
+never touches your screen:
+
+| Layer | Tools | What it's for |
+|---|---|---|
+| **OS-API** | `trash` `file_op` `open_file` `clipboard_*` `launch_app` … | files, clipboard, app lifecycle, via direct API calls |
+| **AppleScript** | `applescript` | scriptable apps: Mail, Messages, Notes, Calendar, Music, Finder, Safari … |
+| **Web / CDP** | `web_open` `web_snapshot` `web_act` `web_login` … | any browser page or Electron app, driven in the background |
+| **Accessibility** | `snapshot` `act` | any native app's UI: read the tree, click/select/type by reference |
+
+A gated last resort (`screenshot` + coordinate clicks/keystrokes) exists for apps whose
+accessibility tree is truly empty. It steals focus, so it asks you first.
+
+## How it works (no server, no cloud)
+
+"MCP server" undersells how local this is. `hunch serve` is a plain Python process that your
+MCP host (Claude Desktop, Cursor, …) spawns as a **child process** and talks to over
+**JSON-RPC on stdin/stdout** (MCP's stdio transport). There is no HTTP endpoint, no port
+Hunch listens on, no daemon, and no telemetry. When your host quits, Hunch is gone.
+
+The tools are direct macOS API calls in-process: the Accessibility framework via pyobjc,
+`osascript` for AppleScript, OS APIs for files/clipboard, and, for the web layer, a local
+WebSocket to Chrome's DevTools port on `127.0.0.1`. The only thing that ever touches the
+network is Chrome itself, doing ordinary browsing. What the model sees is whatever the tools
+return through your host; nothing else leaves the machine.
+
+## Install
+
+macOS 13+. Via Homebrew (installs Python and all dependencies in an isolated env):
+
+```
+brew install prithviseran/hunch/hunch
+```
+
+(PyPI/pipx publication is planned; today Homebrew is the supported path.)
+
+Then, one time:
+
+```
+hunch setup      # walk the macOS permission grants + create the browser profile
+hunch doctor     # verify every layer; fix anything it flags
+hunch connect claude-desktop   # or: claude-code, cursor
+```
+
+Restart your MCP host and ask it to *"use hunch to …"*.
+
+### The permissions, honestly
+
+macOS trust attaches to the **app that runs the server**, meaning your MCP host (Claude Desktop,
+Cursor, your terminal), not "hunch" itself. `hunch setup` walks you through it:
+
+- **Accessibility** (required): lets Hunch read app UIs and click focus-free. Grant it to your MCP
+  host app in System Settings → Privacy & Security → Accessibility.
+- **Automation** (per-app, automatic): the first time Hunch scripts an app, macOS shows a one-time
+  "allow control" prompt.
+- **Screen Recording** (optional): only for the screenshot/vision fallback.
+
+`hunch doctor` reports what's granted. Note: its Accessibility line reflects the *terminal* you ran
+it from; the server inherits the *host's* grant.
+
+## Python SDK (library use)
+
+Hunch is also an importable library — the same focus-free primitives as the MCP tools, driven
+deterministically from your own Python (a cron job, a test harness, your own agent loop), no LLM
+required. The distribution is `hunch-sdk`; the import is `hunch`:
+
+```python
+from hunch import Hunch
+
+mac = Hunch()                              # your machine, your logged-in apps
+print(mac.snapshot("Mail"))                # accessibility tree, focus-free
+mac.act([{"action": "click", "ref": "e12"}])
+mac.web.open(url="https://github.com")     # real persistent Chrome profile over CDP
+print(mac.web.snapshot())
+mac.files.trash(["~/Downloads/old.zip"])   # reversible delete, no Finder
+mac.applescript('tell application "Music" to play')
+```
+
+Constructor knobs: `app` (initial snapshot target), `confirm="dialog"|"off"` (see below),
+`check_permissions` (Accessibility check up front), `simultaneous` (never touch the
+foreground/cursor/keyboard), `cdp_port`.
+
+- **Permissions**: for library use it's *whatever runs your script* — your terminal or IDE — that
+  needs Accessibility (the MCP server instead uses the host app's grant). The constructor checks
+  and raises `AccessibilityNotGranted` with instructions. `screenshot()` additionally needs
+  Screen Recording.
+- **Safety gates default ON**: the same one-click "Go ahead" dialogs and `~/.hunch/config.json`
+  gates as the MCP server. `Hunch(confirm="off")` auto-approves for that instance only — for
+  unattended scripts, with the same caveats as `auto_approve_all`.
+- **Errors**: methods return status strings (check for `REFUSED`); the SDK raises only
+  `ApprovalDenied` (user declined a dialog), `AccessibilityNotGranted`, `WebNotOpen`
+  (`.web` before `.web.open()`), `StaleRef` (re-snapshot), and `HunchError` when a CDP
+  browser can't be opened (`web.restart()` recovers a stale instance).
+- **Credentials**: `mac.web.fill_login(service)` / `fill_secret(service, ref)` type Keychain
+  values straight into the page and never return them; domain binding is enforced.
+- **Coexistence**: the SDK and the MCP server share the CDP port (9337) and the persistent Hunch
+  browser profile — whichever opened it first is reused, but `web.restart()`/`web.login()` kill
+  whatever holds the port.
+
+Runnable scripts live in [`examples/`](examples/).
+
+## Agent loop (`mac.agent`)
+
+The instance SDK gives you deterministic primitives. The **agent loop** puts an LLM in the driver's seat:
+you hand it a task in plain English and Claude drives the Mac through those same primitives —
+Scrapybara's `act()`, but on *your* machine with *your* logged-in apps. It's an optional extra
+(keeps the base install free of the model SDK):
+
+```bash
+pip install 'hunch-sdk[agent]'
+export ANTHROPIC_API_KEY=sk-ant-...     # or: ant auth login
+```
+
+```python
+from hunch import Hunch
+
+mac = Hunch()
+result = mac.agent.run("reply to Sarah's latest email, but don't send it")
+print(result.text)          # Claude's final summary
+print(result.turns, result.usage)
+```
+
+- **Watch it work** with an `on_event(kind, data)` callback — `kind` is one of `text` (Claude's
+  reasoning), `tool` (`{name, input}`), `tool_result` (preview), `done` (final text), `error`.
+- **Continuation**: follow-up `act()` calls keep the conversation (Claude still knows which email
+  is Sarah's); `mac.agent.reset()` starts a fresh task.
+- **Mix layers freely**: call `mac.snapshot(...)` / `mac.clipboard.get()` deterministically around
+  `mac.agent.run(...)` — the thing a cloud sandbox can't do on your real machine.
+- **Knobs**: `run(task, model="claude-opus-4-8", max_turns=40, effort=None, on_event=None,
+  system_suffix="")`. `AgentResult` has `text`, `turns`, `stop_reason`, `usage`, `aborted`.
+- **Safety**: the instance's gate config governs the loop. The default `confirm="dialog"` pops a
+  real "Go ahead?" dialog before any focus-stealing or risky step — good when you're at the
+  machine, but a gated action can stall an unattended run for the dialog's timeout. For cron jobs
+  use `Hunch(confirm="off")` and accept the risk; Claude still asks *you* (via `notify_user`)
+  before irreversible or outward actions like sending a message. A declined gate comes back to the
+  model as a `REFUSED` result, so the loop adapts instead of crashing.
+- **Cost**: each turn resends the tree-heavy history; prompt caching is on by default, so cached
+  input is ~10× cheaper — but long autonomous runs still add up. `max_turns` caps it.
+
+Other models: the agent loop is Claude-only, but the instance-SDK primitives are provider-agnostic —
+wire `mac.snapshot()` / `mac.act()` into your own OpenAI/Gemini/etc. agent loop as tools.
+
+## Credentials: agents use them, never see them
+
+```
+hunch creds add github --domain github.com
+hunch creds list
+```
+
+Values go straight into the **macOS Keychain**. An agent signs in by calling
+`web_fill_login("github")` with only the service *name*; Hunch reads the secret from the Keychain
+and types it into the page over CDP. The value never enters the model's context, its logs, or its
+provider's servers.
+
+**Domain binding**: a credential added with `--domain github.com` will only ever be typed into
+`github.com` (and its subdomains). If a confused or prompt-injected agent lands on a look-alike
+page, the fill is refused. Bind every credential; blank (any-site) exists only for compatibility.
+
+No stored credential? Agents fall back to `web_login`, which opens a tagged browser window where
+*you* sign in yourself; the session then persists in Hunch's dedicated browser profile.
+
+## Confirmation gates
+
+Your MCP host's tool approvals are the primary permission layer. Hunch adds a content-aware second
+gate, a one-click macOS dialog, for the catastrophic cases:
+
+| Gate | Fires on |
+|---|---|
+| `gates.focus_steal` | actions that take over your keyboard/cursor (`key`, `click_xy`, ref-less typing) |
+| `gates.app_to_front` | an app being brought to the front (a focus switch, even mid-fullscreen) |
+| `gates.shell` | AppleScript containing `do shell script` |
+| `gates.destructive_applescript` | delete / send / empty trash / shut down / … |
+
+One approval covers its follow-through: clicking "Go ahead" (on `request_focus`, a gated `act`,
+or the app-to-front dialog) authorizes the switch it announced for ~15 s: no second dialog, and
+the focus-switch notification is suppressed. A switch is either *asked about* or *announced*,
+never both, and never silent (turn `gates.app_to_front` off and switches fall back to the
+notification).
+
+All on by default. `hunch config show` / `hunch config set gates.shell off` to adjust;
+changes apply immediately, even to a running server. `auto_approve_all` disables everything and
+makes you confirm you understand the [risk](SECURITY.md).
+
+Hunch also refuses to let the agent edit anything under `~/.hunch/` (its own policy and credential
+metadata) via its file tools; permission changes are for humans in a terminal.
+
+## Env vars
+
+| Var | Effect |
+|---|---|
+| `HUNCH_NO_INTERNAL_GATE=1` | suppress all internal dialogs (for host apps that run their own approval UX) |
+| `HUNCH_FORCE_SANDBOX=1` | web layer uses a throwaway, logged-out browser profile |
+| `HUNCH_NOTIFY_FOCUS=0` | silence the "Hunch is switching apps" notifications (they fire only for switches no dialog asked about) |
+
+## FAQ
+
+**Every tree read returns "(no window for …)" and AppleScript fails with "-25211 not allowed
+assistive access".** One cause: the app hosting Hunch is missing the **Accessibility** grant.
+Without it the AX API silently returns nothing, so apps look windowless even when they're open.
+Grant it to the *host* (see next question), and if it's already listed, toggle it off and on:
+macOS silently invalidates grants when an app updates. Restart the host afterwards.
+
+**Which app do I grant permissions to?** The one that *launches* `hunch serve`: Claude Desktop,
+Cursor, or your terminal app (for Claude Code). Grants attach to that app's identity, never to
+"hunch" itself. This is also why `hunch doctor` can be misleading: it reports the grants of the
+terminal you ran it in, which may differ from your MCP host's.
+
+**Only `screenshot` fails; everything else works.** That's the **Screen Recording** permission,
+which only the screenshot/vision fallback needs. Grant it to the host in System Settings →
+Privacy & Security → Screen Recording, or just let agents use `snapshot`, which doesn't need it.
+
+**It worked yesterday and broke today.** An update to your host app (or macOS) likely reset its
+permission grants. Toggle the host off and on under Accessibility (and Screen Recording, if you
+use it), then restart the host.
+
+**An app's tree reads empty or shows only a sidebar.** Two different situations. Electron/CEF
+apps (Discord, Slack, Spotify, VS Code) need an accessibility flag; `snapshot` relaunches them
+once, in the background, to set it. Master-detail and Catalyst apps (WhatsApp, Mail) expose only
+the pane you're in: the agent should click into an item by ref and re-snapshot; the detail pane
+then appears. Also check the app actually has a window open.
+
+**The web layer won't connect.** Chrome 136+ blocks CDP on your default profile by design. Hunch
+uses its own profile at `~/.hunch/chrome-cdp`; run `hunch setup` to create it and sign into your
+sites there.
+
+**My host shows the server instructions truncated.** Cosmetic: some host UIs shorten the playbook
+in their server-info display; the model receives it in full.
+
+## Security
+
+Read [SECURITY.md](SECURITY.md): threat model (prompt injection, mainly), what the gates do and
+don't cover, and how to report vulnerabilities.
+
+## License
+
+Apache-2.0; see [LICENSE](LICENSE).