frpdeck 1.0.0__tar.gz

frpdeck-1.0.0/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 [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.

frpdeck-1.0.0/PKG-INFO

@@ -0,0 +1,260 @@
+Metadata-Version: 2.4
+Name: frpdeck
+Version: 1.0.0
+Summary: Lightweight FRP deployment and maintenance CLI with structured proxy management, audit logging, and MCP support for LLM-assisted operations.
+Author-email: Hanwen Zheng <eserie.fox@outlook.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/eserie-fox/frpdeck
+Project-URL: Repository, https://github.com/eserie-fox/frpdeck
+Project-URL: Issues, https://github.com/eserie-fox/frpdeck/issues
+Keywords: frp,proxy,deployment,ops,mcp,llm
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: Proxy Servers
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jinja2<4,>=3.1
+Requires-Dist: mcp<2,>=1.26
+Requires-Dist: pydantic<3,>=2.7
+Requires-Dist: PyYAML<7,>=6.0
+Requires-Dist: typer<1,>=0.12
+Provides-Extra: dev
+Requires-Dist: pytest<9,>=8.0; extra == "dev"
+Dynamic: license-file
+
+# frpdeck
+
+`frpdeck` is a lightweight Python 3.11+ CLI for managing FRP instances from structured source files. It focuses on practical single-host operations: initialize instance directories, validate configuration, render runtime files, apply changes locally, inspect state, and maintain structured proxy definitions without introducing a larger control plane.
+
+It is also MCP-friendly. `frpdeck` includes a local stdio MCP thin wrapper so an LLM can assist with structured proxy maintenance against one bound instance directory at a time.
+
+## Highlights
+
+- Lightweight FRP deployment and maintenance workflows for client and server instances.
+- Structured proxy management backed by `proxies.yaml`, with preview and apply support.
+- Stable JSON outputs for automation and scripting.
+- Append-only audit logging and revision snapshots for write operations.
+- Local stdio MCP support for LLM-assisted proxy maintenance.
+
+## Installation
+
+Install from source:
+
+```bash
+python3.11 -m venv .venv
+. .venv/bin/activate
+python -m pip install .
+```
+
+For development:
+
+```bash
+python3.11 -m venv .venv
+. .venv/bin/activate
+python -m pip install -e '.[dev]'
+```
+
+## Features
+
+- `init` creates a new client or server instance directory.
+- `render` generates FRP TOML, proxy includes, and systemd units under `rendered/`.
+- `validate` checks schema, placeholder values, token sources, path resolution, and simple proxy conflicts.
+- `apply` validates, renders, installs binaries if needed, syncs runtime files, installs the systemd unit, and restarts the service.
+- `reload` calls `frpc reload -c ...` for client instances.
+- `restart` and `status` operate on the configured systemd service.
+- `check-update` and `upgrade` support GitHub latest releases and offline archives.
+- `doctor` checks Linux/systemd availability, instance files, and basic write permissions.
+- `python -m frpdeck.mcp.server` starts a local stdio MCP server that exposes proxy-management tools and read-only status resources.
+
+## Current scope
+
+`frpdeck` is a focused operations tool, not a full FRP control platform. It currently centers on structured instance management, proxy maintenance, local apply workflows, auditing, and MCP-assisted maintenance. HTTP control planes, remote auth layers, and web dashboards are intentionally out of scope for now.
+
+## Non-goals
+
+- Remote HTTP transport for MCP
+- Authentication or authorization for remote MCP access
+- Web dashboard or visualization service
+- Remote centralized control
+- Interactive TOML editing
+
+## Quick start
+
+Running `frpdeck` with no arguments now shows the built-in command help, including common entry points such as `init`, `apply`, `proxy`, `status`, and `python -m frpdeck.mcp.server`.
+
+Initialize a client instance:
+
+```bash
+frpdeck init client my-client
+```
+
+Edit the generated configuration and secret material:
+
+```bash
+${EDITOR:-vi} ./my-client/node.yaml
+${EDITOR:-vi} ./my-client/proxies.yaml
+mkdir -p ./my-client/secrets
+printf 'replace-me\n' > ./my-client/secrets/token.txt
+```
+
+Validate the source configuration:
+
+```bash
+frpdeck validate --instance ./my-client
+```
+
+Render generated files:
+
+```bash
+frpdeck render --instance ./my-client
+```
+
+Apply an instance to the configured runtime paths:
+
+```bash
+sudo frpdeck apply --instance ./my-client
+```
+
+Inspect runtime state:
+
+```bash
+frpdeck status --instance ./my-client
+```
+
+Apply emits stage-by-stage progress in text mode so it is clear when validation, rendering, runtime sync, systemd install, and restart are happening.
+
+Uninstall installed artifacts while keeping source configuration:
+
+```bash
+frpdeck uninstall --instance ./my-client
+```
+
+Delete the instance directory as well:
+
+```bash
+frpdeck uninstall --instance ./my-client --purge
+```
+
+## Typical workflows
+
+### Client instance
+
+1. Run `frpdeck init client your-client`.
+2. Replace `PLEASE_FILL_SERVER_ADDR` and domain placeholders in `node.yaml` and `proxies.yaml`.
+3. Create `secrets/token.txt` with the real token.
+4. Run `frpdeck validate --instance ./your-client`.
+5. Run `frpdeck render --instance ./your-client`.
+6. Run `sudo frpdeck apply --instance ./your-client`.
+7. Run `frpdeck status --instance ./your-client`.
+
+### Server instance
+
+1. Run `frpdeck init server your-server`.
+2. Replace `PLEASE_FILL_DOMAIN` and create `secrets/token.txt`.
+3. Run `frpdeck validate --instance ./your-server`.
+4. Run `frpdeck render --instance ./your-server`.
+5. Run `sudo frpdeck apply --instance ./your-server`.
+
+## MCP
+
+`frpdeck` ships with a local stdio MCP thin wrapper over structured proxy tools and read-only status resources. It is designed to bind to one instance directory at a time and is best used through a generated wrapper script.
+
+Recommended workflow: generate a bound wrapper script with `frpdeck mcp install-stdio-wrapper` and point your MCP client at that script. Prefer the generated wrapper over writing your own unless you have a specific reason to customize startup behavior. The wrapper binds to your chosen instance directory and embeds the Python interpreter detected when the script is created.
+
+In practice, wrapper scripts are most commonly generated for client instances, because proxy configuration is usually managed on the client side. That is a usage pattern rather than a hard restriction: the MCP wrapper is tied to an instance directory, not to a separate client-only mode in the documentation.
+
+### Recommended MCP setup
+
+On the FRP machine, change into your instance directory and generate the wrapper:
+
+```bash
+cd /path/to/your-instance
+frpdeck mcp install-stdio-wrapper
+```
+
+This is equivalent to:
+
+```bash
+frpdeck mcp install-stdio-wrapper --instance /path/to/your-instance
+```
+
+The command writes `/path/to/your-instance/start-mcp-stdio.sh`, binds that script to the resolved absolute instance path, and embeds the Python interpreter that is running `frpdeck` at generation time. Replace the example path with your own instance directory.
+
+If you need to start the server manually without the wrapper, you can still use:
+
+```bash
+python -m frpdeck.mcp.server
+```
+
+For a bound one-instance server, the direct form is:
+
+```bash
+python -m frpdeck.mcp.server --instance-dir /path/to/your-instance
+```
+
+Before configuring Claude Code, manually verify the SSH command from the Claude Code machine. Replace the host name and path with your own SSH destination and instance directory:
+
+```bash
+ssh your-ssh-host /path/to/your-instance/start-mcp-stdio.sh
+```
+
+That command should normally stay attached and wait for stdin/stdout traffic because the MCP stdio server is waiting for client messages. If it exits immediately or prints an error, fix the remote Python environment, instance path, or SSH setup first.
+
+Once the manual SSH command works, add the MCP entry in Claude Code:
+
+```bash
+claude mcp add --scope user --transport stdio frpdeck -- \
+  ssh your-ssh-host /path/to/your-instance/start-mcp-stdio.sh
+```
+
+Current MCP scope is intentionally small:
+
+- Local stdio MCP server only.
+- No HTTP transport.
+- No remote auth layer.
+- No web UI.
+
+## Audit and safety notes
+
+Write operations append audit records under `state/audit/audit.jsonl`, and proxy mutations also create revision snapshots under `state/revisions/`. This is intended to make changes traceable and manually recoverable without turning the tool into a full control plane.
+
+### SSH and BatchMode
+
+`BatchMode yes` is useful for unattended or scripted SSH sessions because it disables interactive password prompts and host-key confirmation. Do not treat it as the first step.
+
+Recommended order:
+
+1. Manually run the SSH wrapper command until it works without prompts.
+2. Confirm that host keys are trusted and key-based auth is already working.
+3. Only then consider enabling `BatchMode yes` in `~/.ssh/config`.
+
+Example SSH config shape:
+
+```sshconfig
+Host your-frp-host
+    HostName <host-or-ip>
+    User <user>
+    IdentityFile ~/.ssh/id_ed25519
+    # Add BatchMode yes only after manual SSH testing succeeds
+    # BatchMode yes
+```
+
+## Test fixtures
+
+Repository fixtures now live under `tests/fixtures/instances/`. They exist for tests and development reference only. Daily usage should start from `frpdeck init ...`, not by editing fixture directories directly.
+
+## Notes on paths
+
+- Relative paths in YAML are resolved against the instance directory, not the shell working directory.
+- Rendered systemd units always use absolute runtime paths.
+- By default, runtime files are installed under `runtime/` inside the instance directory, while the systemd unit is written to `/etc/systemd/system`.

frpdeck-1.0.0/README.md

@@ -0,0 +1,226 @@
+# frpdeck
+
+`frpdeck` is a lightweight Python 3.11+ CLI for managing FRP instances from structured source files. It focuses on practical single-host operations: initialize instance directories, validate configuration, render runtime files, apply changes locally, inspect state, and maintain structured proxy definitions without introducing a larger control plane.
+
+It is also MCP-friendly. `frpdeck` includes a local stdio MCP thin wrapper so an LLM can assist with structured proxy maintenance against one bound instance directory at a time.
+
+## Highlights
+
+- Lightweight FRP deployment and maintenance workflows for client and server instances.
+- Structured proxy management backed by `proxies.yaml`, with preview and apply support.
+- Stable JSON outputs for automation and scripting.
+- Append-only audit logging and revision snapshots for write operations.
+- Local stdio MCP support for LLM-assisted proxy maintenance.
+
+## Installation
+
+Install from source:
+
+```bash
+python3.11 -m venv .venv
+. .venv/bin/activate
+python -m pip install .
+```
+
+For development:
+
+```bash
+python3.11 -m venv .venv
+. .venv/bin/activate
+python -m pip install -e '.[dev]'
+```
+
+## Features
+
+- `init` creates a new client or server instance directory.
+- `render` generates FRP TOML, proxy includes, and systemd units under `rendered/`.
+- `validate` checks schema, placeholder values, token sources, path resolution, and simple proxy conflicts.
+- `apply` validates, renders, installs binaries if needed, syncs runtime files, installs the systemd unit, and restarts the service.
+- `reload` calls `frpc reload -c ...` for client instances.
+- `restart` and `status` operate on the configured systemd service.
+- `check-update` and `upgrade` support GitHub latest releases and offline archives.
+- `doctor` checks Linux/systemd availability, instance files, and basic write permissions.
+- `python -m frpdeck.mcp.server` starts a local stdio MCP server that exposes proxy-management tools and read-only status resources.
+
+## Current scope
+
+`frpdeck` is a focused operations tool, not a full FRP control platform. It currently centers on structured instance management, proxy maintenance, local apply workflows, auditing, and MCP-assisted maintenance. HTTP control planes, remote auth layers, and web dashboards are intentionally out of scope for now.
+
+## Non-goals
+
+- Remote HTTP transport for MCP
+- Authentication or authorization for remote MCP access
+- Web dashboard or visualization service
+- Remote centralized control
+- Interactive TOML editing
+
+## Quick start
+
+Running `frpdeck` with no arguments now shows the built-in command help, including common entry points such as `init`, `apply`, `proxy`, `status`, and `python -m frpdeck.mcp.server`.
+
+Initialize a client instance:
+
+```bash
+frpdeck init client my-client
+```
+
+Edit the generated configuration and secret material:
+
+```bash
+${EDITOR:-vi} ./my-client/node.yaml
+${EDITOR:-vi} ./my-client/proxies.yaml
+mkdir -p ./my-client/secrets
+printf 'replace-me\n' > ./my-client/secrets/token.txt
+```
+
+Validate the source configuration:
+
+```bash
+frpdeck validate --instance ./my-client
+```
+
+Render generated files:
+
+```bash
+frpdeck render --instance ./my-client
+```
+
+Apply an instance to the configured runtime paths:
+
+```bash
+sudo frpdeck apply --instance ./my-client
+```
+
+Inspect runtime state:
+
+```bash
+frpdeck status --instance ./my-client
+```
+
+Apply emits stage-by-stage progress in text mode so it is clear when validation, rendering, runtime sync, systemd install, and restart are happening.
+
+Uninstall installed artifacts while keeping source configuration:
+
+```bash
+frpdeck uninstall --instance ./my-client
+```
+
+Delete the instance directory as well:
+
+```bash
+frpdeck uninstall --instance ./my-client --purge
+```
+
+## Typical workflows
+
+### Client instance
+
+1. Run `frpdeck init client your-client`.
+2. Replace `PLEASE_FILL_SERVER_ADDR` and domain placeholders in `node.yaml` and `proxies.yaml`.
+3. Create `secrets/token.txt` with the real token.
+4. Run `frpdeck validate --instance ./your-client`.
+5. Run `frpdeck render --instance ./your-client`.
+6. Run `sudo frpdeck apply --instance ./your-client`.
+7. Run `frpdeck status --instance ./your-client`.
+
+### Server instance
+
+1. Run `frpdeck init server your-server`.
+2. Replace `PLEASE_FILL_DOMAIN` and create `secrets/token.txt`.
+3. Run `frpdeck validate --instance ./your-server`.
+4. Run `frpdeck render --instance ./your-server`.
+5. Run `sudo frpdeck apply --instance ./your-server`.
+
+## MCP
+
+`frpdeck` ships with a local stdio MCP thin wrapper over structured proxy tools and read-only status resources. It is designed to bind to one instance directory at a time and is best used through a generated wrapper script.
+
+Recommended workflow: generate a bound wrapper script with `frpdeck mcp install-stdio-wrapper` and point your MCP client at that script. Prefer the generated wrapper over writing your own unless you have a specific reason to customize startup behavior. The wrapper binds to your chosen instance directory and embeds the Python interpreter detected when the script is created.
+
+In practice, wrapper scripts are most commonly generated for client instances, because proxy configuration is usually managed on the client side. That is a usage pattern rather than a hard restriction: the MCP wrapper is tied to an instance directory, not to a separate client-only mode in the documentation.
+
+### Recommended MCP setup
+
+On the FRP machine, change into your instance directory and generate the wrapper:
+
+```bash
+cd /path/to/your-instance
+frpdeck mcp install-stdio-wrapper
+```
+
+This is equivalent to:
+
+```bash
+frpdeck mcp install-stdio-wrapper --instance /path/to/your-instance
+```
+
+The command writes `/path/to/your-instance/start-mcp-stdio.sh`, binds that script to the resolved absolute instance path, and embeds the Python interpreter that is running `frpdeck` at generation time. Replace the example path with your own instance directory.
+
+If you need to start the server manually without the wrapper, you can still use:
+
+```bash
+python -m frpdeck.mcp.server
+```
+
+For a bound one-instance server, the direct form is:
+
+```bash
+python -m frpdeck.mcp.server --instance-dir /path/to/your-instance
+```
+
+Before configuring Claude Code, manually verify the SSH command from the Claude Code machine. Replace the host name and path with your own SSH destination and instance directory:
+
+```bash
+ssh your-ssh-host /path/to/your-instance/start-mcp-stdio.sh
+```
+
+That command should normally stay attached and wait for stdin/stdout traffic because the MCP stdio server is waiting for client messages. If it exits immediately or prints an error, fix the remote Python environment, instance path, or SSH setup first.
+
+Once the manual SSH command works, add the MCP entry in Claude Code:
+
+```bash
+claude mcp add --scope user --transport stdio frpdeck -- \
+  ssh your-ssh-host /path/to/your-instance/start-mcp-stdio.sh
+```
+
+Current MCP scope is intentionally small:
+
+- Local stdio MCP server only.
+- No HTTP transport.
+- No remote auth layer.
+- No web UI.
+
+## Audit and safety notes
+
+Write operations append audit records under `state/audit/audit.jsonl`, and proxy mutations also create revision snapshots under `state/revisions/`. This is intended to make changes traceable and manually recoverable without turning the tool into a full control plane.
+
+### SSH and BatchMode
+
+`BatchMode yes` is useful for unattended or scripted SSH sessions because it disables interactive password prompts and host-key confirmation. Do not treat it as the first step.
+
+Recommended order:
+
+1. Manually run the SSH wrapper command until it works without prompts.
+2. Confirm that host keys are trusted and key-based auth is already working.
+3. Only then consider enabling `BatchMode yes` in `~/.ssh/config`.
+
+Example SSH config shape:
+
+```sshconfig
+Host your-frp-host
+    HostName <host-or-ip>
+    User <user>
+    IdentityFile ~/.ssh/id_ed25519
+    # Add BatchMode yes only after manual SSH testing succeeds
+    # BatchMode yes
+```
+
+## Test fixtures
+
+Repository fixtures now live under `tests/fixtures/instances/`. They exist for tests and development reference only. Daily usage should start from `frpdeck init ...`, not by editing fixture directories directly.
+
+## Notes on paths
+
+- Relative paths in YAML are resolved against the instance directory, not the shell working directory.
+- Rendered systemd units always use absolute runtime paths.
+- By default, runtime files are installed under `runtime/` inside the instance directory, while the systemd unit is written to `/etc/systemd/system`.