tactus-mcp 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+All notable changes to this project are documented here. The format is based on
+[Keep a Changelog](https://keepachangelog.com/), and this project adheres to
+[Semantic Versioning](https://semver.org/). While the major version is `0`, the
+public tool interface may still change between minor versions.
+
+## [0.1.1] — 2026-06-13
+
+### Fixed
+- A rate-limited command that was coalesced and then failed on flush (e.g. a
+  dropped link) no longer becomes an unhandled rejection that crashes the
+  server; the failure is swallowed and logged to stderr.
+- `server_status` / `status()` is now safe to call while disconnected or
+  mid-reconnect — it previously read `client.devices` unconditionally, which
+  throws when the connector is down.
+
+### Added
+- `npm run e2e`: an end-to-end probe that drives the real controller + safety
+  stack against a live Intiface (capability-adaptive; simulator or real device).
+- Regression tests for the rate-limiter flush error path and for `status()`
+  while disconnected.
+
+## [0.1.0] — unreleased
+
+First feature-complete development version. Verified against the Intiface device
+simulator and at least one real device.
+
+### Added
+- MCP server (stdio) wrapping Buttplug/Intiface as a content-agnostic control layer.
+- Tools: `list_devices`, `scan_for_devices`, `get_battery`, `vibrate`, `oscillate`,
+  `rotate`, `linear`, `vibrate_pattern`, `stop_device`, `stop_all`, `server_status`.
+- Safety layer (on by default): intensity clamping with honest effective-value
+  reporting, an independent per-device watchdog auto-stop, stop-preemptible
+  patterns, per-device rate limiting, stop-on-disconnect/exit, and fail-safe
+  stop semantics that retry rather than assume success.
+- Server-side hard validation of pattern bounds and out-of-range input.
+- Robust Intiface connection with exponential-backoff reconnect; the server never
+  crashes when Intiface is unavailable and returns clear, actionable errors.
+- Reacts to a device dropping (BLE link lost / out of range): logs the
+  disconnect and clears that device's safety timers so no watchdog fires for a
+  device that is gone. (Note: silent BLE degradation that Intiface does not
+  detect is not yet actively probed — see known limitations.)
+- Configuration via `INTIFACE_URL`, `MAX_INTENSITY`, `MAX_CONTINUOUS_MS`,
+  `SCAN_DEFAULT_MS`, and a gated `--allow-unsafe` override.
+- Apache-2.0 license, compliance/trademark/acceptable-use documentation, unit
+  tests for the safety layer, and CI across Node 20/22/24.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Tactus contributors
+
+   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.

package/README.md

@@ -0,0 +1,226 @@
+<!-- mcp-name: io.github.ProjectAILiberation/tactus -->
+
+# Tactus
+
+[![CI](https://github.com/ProjectAILiberation/tactus/actions/workflows/ci.yml/badge.svg)](https://github.com/ProjectAILiberation/tactus/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+
+**A content-agnostic MCP server that lets any AI agent control intimate hardware through a clean, safe tool interface.**
+
+Tactus is a thin, neutral control layer. It wraps [Buttplug](https://buttplug.io/) /
+Intiface — so a single integration reaches 750+ devices across ~26 brands — and
+exposes them to AI agents as Model Context Protocol (MCP) tools. It forwards
+hardware control commands only. **It does not generate, host, or store any
+content of any kind.**
+
+- **Safety first.** Intensity clamping, an independent watchdog auto-stop, a
+  one-call emergency stop, and fail-safe stop semantics are built in and on by
+  default — this is the headline feature, not an afterthought.
+- **One-line install.** `npx -y tactus-mcp`, no clone or build.
+- **OS-agnostic.** Tactus never touches Bluetooth. Intiface owns the radio; we
+  just talk to it over a local WebSocket.
+
+> ⚠️ Adults only (18+, or the age of majority in your jurisdiction). For use
+> only on devices you own and only with the consent of everyone involved.
+
+---
+
+## How it works
+
+```
+  AI client / agent           Tactus (this server)            Intiface Central
+  (Claude Desktop,    MCP      - MCP server          WebSocket - holds BLE/USB
+   Claude Code, your  ───────▶ - Buttplug client     ────────▶   - 750+ device
+   own AI product)            - SAFETY LAYER          :12345      protocols
+                                                                     │ BLE/USB
+                                                                     ▼
+                                                                🔵 your device
+```
+
+Everything runs locally on your machine. Tactus is a Buttplug client that
+connects to a locally running Intiface Central/Engine at
+`ws://127.0.0.1:12345`.
+
+## Prerequisites
+
+1. Install [Intiface Central](https://intiface.com/central/).
+2. Open it and click **Start Server**.
+3. Pair your device (or, for development, add a simulated device under
+   **Devices → Manage Simulated Devices**).
+
+## Install & configure
+
+Tactus runs over stdio via `npx`. Add it to your MCP client config.
+
+**Claude Desktop / Claude Code** (`claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "tactus": {
+      "command": "npx",
+      "args": ["-y", "tactus-mcp"],
+      "env": { "MAX_INTENSITY": "1.0" }
+    }
+  }
+}
+```
+
+The same `command`/`args` work for any MCP client that launches stdio servers
+(Cursor, Cline, Continue, etc.).
+
+## Tools
+
+| Tool | Purpose |
+|---|---|
+| `list_devices` | List connected devices and their actuators |
+| `scan_for_devices` | Scan for and return newly found devices |
+| `get_battery` | Read battery level (0.0–1.0) |
+| `vibrate` | Set vibration intensity (0.0–1.0) |
+| `oscillate` | Set oscillation intensity (0.0–1.0) |
+| `rotate` | Set rotation speed and direction |
+| `linear` | Move a stroker to a position over a duration |
+| `vibrate_pattern` | Play a timed, interruptible vibration pattern |
+| `stop_device` | Stop one device |
+| `stop_all` | Emergency stop — halt every device immediately |
+| `server_status` | Report connection status to Intiface |
+
+All intensities are normalized to `0.0–1.0`. Every tool returns both structured
+data and human-readable text.
+
+## Safety
+
+The safety layer wraps every driving command and is on by default:
+
+- **Intensity clamp** — requests are clamped to `MAX_INTENSITY`; the effective
+  value is reported back, and out-of-range input is rejected with a clear error
+  rather than silently coerced.
+- **Watchdog auto-stop** — any continuous drive auto-stops after
+  `MAX_CONTINUOUS_MS` (default 10 minutes) unless refreshed by a new command.
+  This is an independent timer, not a check-on-next-call.
+- **Stop on disconnect/exit** — if the AI client disconnects or the process is
+  signalled, all devices stop. The watchdog is the hard backstop for hard kills.
+- **Interruptible patterns** — patterns are time-scheduled so a single call
+  never blocks the server; any stop preempts them instantly.
+- **Rate limiting** — per-device command bursts are coalesced to protect BLE.
+- **Fail-safe stop** — if a stop cannot be confirmed, Tactus retries rather than
+  optimistically reporting success.
+
+## Configuration
+
+| Variable | Default | Meaning |
+|---|---|---|
+| `INTIFACE_URL` | `ws://127.0.0.1:12345` | Intiface WebSocket address |
+| `MAX_INTENSITY` | `1.0` | Clamp ceiling for drive intensity (0.0–1.0) |
+| `MAX_CONTINUOUS_MS` | `600000` | Watchdog auto-stop window |
+| `SCAN_DEFAULT_MS` | `5000` | Default scan duration |
+| `--allow-unsafe` | _off_ | Disables the intensity clamp (discouraged) |
+
+## Troubleshooting
+
+**"Intiface is not reachable at ws://127.0.0.1:12345"**
+Start Intiface Central and click **Start Server** (the top status should read
+"Engine running"). Tactus retries automatically with backoff, so once Intiface
+is up the tools start working without restarting your MCP client.
+
+**A device doesn't show up when scanning**
+- Make sure it is powered on and awake (press a button to wake it), and **not
+  already connected to its own phone app** — Bluetooth devices accept one host at
+  a time, so close/disconnect the app first.
+- On macOS, Intiface needs Bluetooth permission: **System Settings → Privacy &
+  Security → Bluetooth → enable Intiface Central**, then quit and reopen Intiface
+  (the permission only takes effect after a restart).
+- Keep the device in range; out-of-range devices drop and disappear from
+  `list_devices`.
+
+**My computer sees the device over Bluetooth, but Intiface/Tactus doesn't**
+The device's advertised Bluetooth name isn't in Buttplug's supported device
+list (common for regional/rebranded SKUs). Support must be added **upstream in
+[Buttplug](https://github.com/buttplugio/buttplug)** — Tactus deliberately adds
+no per-device code and does not reverse-engineer devices.
+
+**A command returns "Unknown device id"**
+The device disconnected (e.g. out of range) and left the known set. Call
+`scan_for_devices` / `list_devices` to reconnect and get its current id.
+
+## Known limitations
+
+- **Device coverage = whatever Buttplug supports.** Devices not present in
+  Buttplug's device configuration cannot be controlled until added upstream.
+- **Silent link degradation is not actively detected.** A dropped link that
+  Intiface reports is handled (the device leaves `list_devices` and drive calls
+  error clearly). But if a Bluetooth link degrades silently *without* Intiface
+  noticing, commands may appear to succeed while the device is unresponsive —
+  active liveness probing is not yet implemented.
+- **Local only.** This package controls devices on the same machine via a local
+  Intiface. Internet/remote control is out of scope here.
+
+## Adding support for an unrecognized device
+
+Using a device from a supported brand that doesn't show up? It often just
+advertises a Bluetooth name (or regional SKU) that Buttplug hasn't catalogued
+yet. Because Tactus wraps Buttplug, the fix belongs **upstream in Buttplug**, not
+here — and for a same-brand device it's usually just adding a **name**, with no
+reverse-engineering.
+
+1. Find the device's advertised Bluetooth name (see Troubleshooting above).
+2. In Intiface's user device configuration, add that name to the same brand's
+   existing protocol and test whether it drives correctly.
+3. If it works, contribute the name upstream to
+   [buttplugio/buttplug](https://github.com/buttplugio/buttplug) so everyone
+   benefits — and/or open an **"Unsupported device"** issue here and we'll help.
+
+If a device only works under a protocol it doesn't truly match — or needs a
+protocol Buttplug doesn't have — that would require reverse-engineering, which is
+out of scope (see [CONTRIBUTING](CONTRIBUTING.md)).
+
+---
+
+## Trademarks
+
+"Lovense", "We-Vibe", "Satisfyer", "Kiiroo", "Lelo", "The Handy", "Magic
+Motion", "Svakom", and other device names are trademarks of their respective
+owners. Tactus is an independent project and is **not** affiliated with,
+endorsed by, sponsored by, or partnered with any device manufacturer. It is
+described as *compatible with* these devices only in the factual sense that it
+builds on the open-source Buttplug protocol library. No manufacturer logos are
+used.
+
+## Content generation — out of scope
+
+This server forwards hardware control commands only. It does **not** generate,
+synthesize, recommend, or produce any text, image, audio, or video content. The
+calling AI agent is the sole content-generating party and is solely responsible
+for any content it produces and for compliance with content obligations in its
+jurisdiction.
+
+## Acceptable use
+
+Tactus is a neutral, content-agnostic hardware control layer. It does **not**
+support, document, or assist with: use on devices you do not own or lack consent
+to operate; use by or on minors; or any use violating applicable law in your
+jurisdiction. These statements describe the scope of maintainer support and
+documentation — they are **not** additional restrictions on the License, which
+continues to govern all use, modification, and redistribution. Users are
+independently responsible for evaluating their use against applicable law.
+
+Tactus only uses device protocols already supported upstream by Buttplug. It
+does **not** reverse-engineer unsupported devices and does **not** break any
+device encryption or access control. It collects and transmits no personal or
+usage data.
+
+## Disclaimer
+
+This software controls hardware you connect to it. Use it only on devices you
+own and only with the consent of everyone involved. For adults only (18+, or the
+age of majority in your jurisdiction).
+
+This software is provided "AS IS", without warranty of any kind (see
+[LICENSE](LICENSE)). The statements above are informational; they do not modify
+the License, add warranties or duties of care, or transfer liability. The
+License's no-warranty and limitation-of-liability terms continue to apply in
+full.
+
+## License
+
+[Apache-2.0](LICENSE).

package/dist/buttplug.d.ts

@@ -0,0 +1,36 @@
+import { DeviceController, DriveTarget, ScalarOutput } from "./controller.js";
+import { DeviceInfo, ServerStatus, TactusConfig } from "./types.js";
+/**
+ * DeviceController backed by Buttplug/Intiface over a local WebSocket.
+ * Our code never touches BLE — Intiface owns that, so this is OS-agnostic.
+ */
+export declare class ButtplugController implements DeviceController {
+    private readonly config;
+    private readonly client;
+    private serverName?;
+    private readonly disconnectCbs;
+    private readonly deviceRemovedCbs;
+    private readonly deviceAddedCbs;
+    constructor(config: TactusConfig);
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    isConnected(): boolean;
+    status(): ServerStatus;
+    listDevices(): DeviceInfo[];
+    scan(durationMs: number): Promise<DeviceInfo[]>;
+    getBattery(deviceId: number): Promise<number>;
+    output(deviceId: number, type: ScalarOutput, value: number, target?: DriveTarget): Promise<void>;
+    rotate(deviceId: number, speed: number, clockwise: boolean, target?: DriveTarget): Promise<void>;
+    linear(deviceId: number, position: number, durationMs: number, target?: DriveTarget): Promise<void>;
+    stopDevice(deviceId: number): Promise<void>;
+    stopAll(): Promise<void>;
+    onDisconnect(cb: () => void): void;
+    onDeviceAdded(cb: (id: number, name: string) => void): void;
+    onDeviceRemoved(cb: (id: number, name: string) => void): void;
+    /** Resolve the target features, build a per-feature command, and send. */
+    private runOnFeatures;
+    private featuresFor;
+    private describe;
+    private requireConnected;
+    private requireDevice;
+}